omni.flux.stage_manager.plugin.widget.usd

• omni.flux.stage_manager.plugin.widget.usd
• Changelog

• 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

• https://www.apache.org/licenses/LICENSE-2.0

• 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.

• 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

• https://www.apache.org/licenses/LICENSE-2.0

• 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.widget.usd.action_is_visible.IsVisibleActionWidgetPlugin

Show JSON schema

{
   "title": "IsVisibleActionWidgetPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "",
         "title": "Tooltip",
         "type": "string"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

build_icon_ui(

model: _StageManagerTreeModel,

item: _StageManagerTreeItem,

level: int,

expanded: bool,

)

build_overview_ui(

model: _StageManagerTreeModel,

)

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.

name: ClassVar[str] = 'IsVisibleActionWidgetPlugin'

• 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

• https://www.apache.org/licenses/LICENSE-2.0

• 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.widget.usd.custom_tags_list.CustomTagsWidgetPlugin

Show JSON schema

{
   "title": "CustomTagsWidgetPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Tags",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "",
         "title": "Tooltip",
         "type": "string"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• display_name (str)

• tooltip (str)

field display_name: str = 'Tags'

field tooltip: str = ''

build_overview_ui(

model: _StageManagerTreeModel,

)

build_ui(

model: _StageManagerTreeModel,

item: _StageManagerTreeItem,

level: int,

expanded: bool,

)

The method used to build the UI for the plugin.

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.

name: ClassVar[str] = 'CustomTagsWidgetPlugin'

• 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

• https://www.apache.org/licenses/LICENSE-2.0

• 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.widget.usd.prim_tree.PrimTreeWidgetPlugin

Show JSON schema

{
   "title": "PrimTreeWidgetPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Prims",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "",
         "title": "Tooltip",
         "type": "string"
      },
      "icon_size": {
         "default": 16,
         "description": "The size of the icon in pixels",
         "title": "Icon Size",
         "type": "integer"
      },
      "item_spacing": {
         "default": 8,
         "description": "The horizontal space between the items in pixels",
         "title": "Item Spacing",
         "type": "integer"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• display_name (str)

• icon_size (int)

• item_spacing (int)

• tooltip (str)

field display_name: str = 'Prims'

field icon_size: int = 16

The size of the icon in pixels

field item_spacing: int = 8

The horizontal space between the items in pixels

field tooltip: str = ''

build_overview_ui(model: _StageManagerTreeModel)

build_ui(

model: _StageManagerTreeModel,

item: _StageManagerTreeItem,

level: int,

expanded: bool,

)

The method used to build the UI for the plugin.

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.

name: ClassVar[str] = 'PrimTreeWidgetPlugin'