omni.flux.stage_manager.plugin.context.usd#
SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- class omni.flux.stage_manager.plugin.context.usd.extension.StageManagerUSDContextPluginsExtension#
Bases:
IExt
- on_shutdown()#
- on_startup(_)#
SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- pydantic model omni.flux.stage_manager.plugin.context.usd.current_stage.CurrentStageContextPlugin#
Bases:
StageManagerUSDContextPlugin
Show JSON schema
{ "title": "CurrentStageContextPlugin", "type": "object", "properties": { "display_name": { "default": "Current Stage", "title": "Display Name", "type": "string" }, "data_type": { "$ref": "#/$defs/StageManagerDataTypes", "default": "USD" }, "listeners": { "default": null, "title": "Listeners" }, "context_name": { "description": "The name of the context from which to get the stage", "title": "Context Name", "type": "string" } }, "$defs": { "StageManagerDataTypes": { "enum": [ "None", "USD", "File" ], "title": "StageManagerDataTypes", "type": "string" } }, "required": [ "context_name" ] }
- Config:
arbitrary_types_allowed: bool = True
- Fields:
- Validators:
- field context_name: str [Required]#
The name of the context from which to get the stage
- Validated by:
- field display_name: str = 'Current Stage'#
- validator context_name_is_valid » context_name#
- get_items()#
Fetch the list of prims other plugins should use
- Raises:
ValueError – If the context was not setup
- Returns:
List of USD prims
- model_post_init(context: Any, /) None #
This function is meant to behave like a BaseModel method to initialise private attributes.
It takes context as an argument since that’s what pydantic-core passes when calling it.
- Parameters:
self – The BaseModel instance.
context – The context.
- setup()#
Set up the context. This will be called once by the core.
- Raises:
ValueError – If no stage exists for the given context
- update_stage()#
Setup the stage. This will be called on open or close stage.
- name: ClassVar[str] = 'CurrentStageContextPlugin'#
SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- pydantic model omni.flux.stage_manager.plugin.context.usd.usd_file.UsdFileContextPlugin#
Bases:
CurrentStageContextPlugin
Show JSON schema
{ "title": "UsdFileContextPlugin", "type": "object", "properties": { "display_name": { "default": "USD File", "title": "Display Name", "type": "string" }, "data_type": { "$ref": "#/$defs/StageManagerDataTypes", "default": "USD" }, "listeners": { "default": null, "title": "Listeners" }, "context_name": { "default": "", "title": "Context Name", "type": "string" }, "file_path": { "description": "The file path to the USD File to load", "title": "File Path", "type": "string" } }, "$defs": { "StageManagerDataTypes": { "enum": [ "None", "USD", "File" ], "title": "StageManagerDataTypes", "type": "string" } }, "required": [ "file_path" ] }
- Config:
arbitrary_types_allowed: bool = True
- Fields:
- Validators:
- field context_name: str = ''#
- Validated by:
- field display_name: str = 'USD File'#
- field file_path: str [Required]#
The file path to the USD File to load
- Validated by:
- model_post_init(context: Any, /) None #
This function is meant to behave like a BaseModel method to initialise private attributes.
It takes context as an argument since that’s what pydantic-core passes when calling it.
- Parameters:
self – The BaseModel instance.
context – The context.
- setup()#
Set up the context. This will be called once by the core.
- Raises:
ValueError – If no stage exists for the given context
- name: ClassVar[str] = 'UsdFileContextPlugin'#