omni.flux.stage_manager.plugin.interaction.usd

• omni.flux.stage_manager.plugin.interaction.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.interaction.usd.all_lights.AllLightsInteractionPlugin

Show JSON schema

{
   "title": "AllLightsInteractionPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Lights",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "View the available lights, grouped by light type",
         "title": "Tooltip",
         "type": "string"
      },
      "compatible_data_type": {
         "$ref": "#/$defs/StageManagerDataTypes",
         "default": "USD"
      },
      "select_all_children": {
         "default": false,
         "description": "Whether the tree should select all children items when selecting a parent item or not",
         "title": "Select All Children",
         "type": "boolean"
      },
      "scroll_to_selection": {
         "default": true,
         "description": "Whether the tree should scroll to the first item in the selection when selection changes",
         "title": "Scroll To Selection",
         "type": "boolean"
      },
      "validate_action_selection": {
         "default": true,
         "description": "Whether the tree selection should be validated & updated to include the item being right-clicked on or not",
         "title": "Validate Action Selection",
         "type": "boolean"
      },
      "tree": {
         "default": null,
         "title": "Tree"
      },
      "compatible_trees": {
         "default": [
            "LightGroupsTreePlugin",
            "PrimGroupsTreePlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Trees",
         "type": "array"
      },
      "compatible_filters": {
         "default": [
            "IgnorePrimsFilterPlugin",
            "IsCaptureFilterPlugin",
            "LightPrimsFilterPlugin",
            "OmniPrimsFilterPlugin",
            "SearchFilterPlugin",
            "IsCategoryFilterPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Filters",
         "type": "array"
      },
      "compatible_widgets": {
         "default": [
            "AssignCategoryActionWidgetPlugin",
            "CustomTagsWidgetPlugin",
            "FocusInViewportActionWidgetPlugin",
            "IsCaptureStateWidgetPlugin",
            "IsCategoryHiddenStateWidgetPlugin",
            "IsVisibleActionWidgetPlugin",
            "PrimTreeWidgetPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Widgets",
         "type": "array"
      },
      "columns": {
         "default": [],
         "description": "Columns to display in the TreeWidget",
         "items": {
            "$ref": "#/$defs/StageManagerColumnPlugin"
         },
         "title": "Columns",
         "type": "array"
      },
      "filters": {
         "default": [],
         "description": "User controllable filters to apply to the context data on tree model refresh. Defined in schema. Will be displayed in UI and will be executed on data that has passed context filter validation.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Filters",
         "type": "array"
      },
      "context_filters": {
         "default": [],
         "description": "Filters to execute when the context data is updated. Defined in schema. Will never be displayed in UI.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Context Filters",
         "type": "array"
      },
      "percent_available_core_usage": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The percentage of the available CPU cores to use to filter the context items. If the value is unset, the default python maximum will be used.",
         "title": "Percent Available Core Usage"
      },
      "internal_context_filters": {
         "default": [
            {
               "name": "LightPrimsFilterPlugin"
            }
         ],
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Internal Context Filters",
         "type": "array"
      },
      "include_invalid_parents": {
         "default": true,
         "description": "Whether the tree should include invalid context item parents or whether the tree should be sparse",
         "title": "Include Invalid Parents",
         "type": "boolean"
      },
      "row_height": {
         "default": 28,
         "description": "The height of the Tree rows in pixels.",
         "title": "Row Height",
         "type": "integer"
      },
      "header_height": {
         "default": 28,
         "description": "The height of the header in pixels. Will be used to offset the alternating row background",
         "title": "Header Height",
         "type": "integer"
      },
      "alternate_row_colors": {
         "default": true,
         "description": "Whether the tree's rows should alternate in color",
         "title": "Alternate Row Colors",
         "type": "boolean"
      },
      "debounce_frames": {
         "default": 5,
         "description": "The number of frames that should be used to debounce the item update requests",
         "title": "Debounce Frames",
         "type": "integer"
      },
      "synchronize_selection": {
         "default": true,
         "description": "Synchronize the USD selection between the stage and the UI",
         "title": "Synchronize Selection",
         "type": "boolean"
      },
      "filtering_rules": {
         "$ref": "#/$defs/USDEventFilteringRules",
         "default": {
            "ignore_properties_events": [
               "xformOpOrder"
            ],
            "ignore_paths_events": [
               "/RootNode/Camera"
            ],
            "ignore_xform_events": true,
            "ignore_omni_prims_events": true,
            "ignore_custom_layer_data_events": true,
            "force_refresh_rules": []
         },
         "description": "Rules used for the USD events in the callback"
      }
   },
   "$defs": {
      "ColumnWidth": {
         "properties": {
            "unit": {
               "$ref": "#/$defs/LengthUnit",
               "description": "The unit of the column width"
            },
            "value": {
               "description": "The value of the column width",
               "title": "Value",
               "type": "number"
            }
         },
         "required": [
            "unit",
            "value"
         ],
         "title": "ColumnWidth",
         "type": "object"
      },
      "LengthUnit": {
         "enum": [
            "Fraction",
            "Percent",
            "Pixel"
         ],
         "title": "LengthUnit",
         "type": "string"
      },
      "RefreshRule": {
         "properties": {
            "use_name": {
               "default": true,
               "description": "Whether to use the prim name or full prim path to match",
               "title": "Use Name",
               "type": "boolean"
            },
            "start": {
               "default": "",
               "description": "String to match the start of the affected prims' names",
               "title": "Start",
               "type": "string"
            },
            "end": {
               "default": "",
               "description": "String to match the end of the affected prims' names",
               "title": "End",
               "type": "string"
            }
         },
         "title": "RefreshRule",
         "type": "object"
      },
      "StageManagerColumnPlugin": {
         "description": "A plugin that allows the grouping of multiple widgets in a column",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The name to display in the column header",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "default": "",
               "description": "The tooltip to display when hovering over the column header",
               "title": "Tooltip",
               "type": "string"
            },
            "widgets": {
               "description": "Widgets to be displayed in the column",
               "items": {
                  "$ref": "#/$defs/StageManagerWidgetPlugin"
               },
               "title": "Widgets",
               "type": "array"
            },
            "width": {
               "$ref": "#/$defs/ColumnWidth",
               "default": {
                  "unit": "Fraction",
                  "value": 1.0
               },
               "description": "Width of the column"
            },
            "centered_title": {
               "default": false,
               "description": "Whether the title should be centered or left-aligned",
               "title": "Centered Title",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "widgets"
         ],
         "title": "StageManagerColumnPlugin",
         "type": "object"
      },
      "StageManagerDataTypes": {
         "enum": [
            "None",
            "USD",
            "File"
         ],
         "title": "StageManagerDataTypes",
         "type": "string"
      },
      "StageManagerFilterPlugin": {
         "description": "A plugin that allows filtering a list of items based on parameters controlled within the plugin",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            },
            "display": {
               "default": true,
               "description": "Whether the filter plugin should be displayed in the UI",
               "title": "Display",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerFilterPlugin",
         "type": "object"
      },
      "StageManagerWidgetPlugin": {
         "description": "A plugin that provides a widget for the TreeView",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerWidgetPlugin",
         "type": "object"
      },
      "USDEventFilteringRules": {
         "properties": {
            "ignore_properties_events": {
               "default": [
                  "xformOpOrder"
               ],
               "description": "List of property names to ignore",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Properties Events",
               "type": "array"
            },
            "ignore_paths_events": {
               "default": [
                  "/RootNode/Camera"
               ],
               "description": "List of prim paths to ignore (Only exact matches for the Prim Path will be ignored)",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Paths Events",
               "type": "array"
            },
            "ignore_xform_events": {
               "default": true,
               "description": "Whether the XForm events emitted by the USD listener should be ignored or not",
               "title": "Ignore Xform Events",
               "type": "boolean"
            },
            "ignore_omni_prims_events": {
               "default": true,
               "description": "Whether the events emitted on Omniverse Prims should be ignored or not",
               "title": "Ignore Omni Prims Events",
               "type": "boolean"
            },
            "ignore_custom_layer_data_events": {
               "default": true,
               "description": "Whether the events emitted for Custom Layer Data should be ignored or not",
               "title": "Ignore Custom Layer Data Events",
               "type": "boolean"
            },
            "force_refresh_rules": {
               "default": [],
               "description": "List of rules to force a refresh of the tree items rather than a delegate refresh",
               "items": {
                  "$ref": "#/$defs/RefreshRule"
               },
               "title": "Force Refresh Rules",
               "type": "array"
            }
         },
         "title": "USDEventFilteringRules",
         "type": "object"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• compatible_filters (list[str])

• compatible_trees (list[str])

• compatible_widgets (list[str])

• display_name (str)

• internal_context_filters (list[omni.flux.stage_manager.factory.plugins.filter_plugin.StageManagerFilterPlugin])

• tooltip (str)

• tree (omni.flux.stage_manager.factory.plugins.tree_plugin.StageManagerTreePlugin)

Validators:

• check_unique_filters » internal_context_filters

field compatible_filters: list[str] = ['IgnorePrimsFilterPlugin', 'IsCaptureFilterPlugin', 'LightPrimsFilterPlugin', 'OmniPrimsFilterPlugin', 'SearchFilterPlugin', 'IsCategoryFilterPlugin']

Validated by:

• check_plugin_compatibility

field compatible_trees: list[str] = ['LightGroupsTreePlugin', 'PrimGroupsTreePlugin']

Validated by:

• check_plugin_compatibility

field compatible_widgets: list[str] = ['AssignCategoryActionWidgetPlugin', 'CustomTagsWidgetPlugin', 'FocusInViewportActionWidgetPlugin', 'IsCaptureStateWidgetPlugin', 'IsCategoryHiddenStateWidgetPlugin', 'IsVisibleActionWidgetPlugin', 'PrimTreeWidgetPlugin']

Validated by:

• check_plugin_compatibility

field display_name: str = 'Lights'

Validated by:

• check_plugin_compatibility

field internal_context_filters: list[StageManagerFilterPlugin] = [{'name': 'LightPrimsFilterPlugin'}]

Validated by:

• check_plugin_compatibility

• check_unique_filters

field tooltip: str = 'View the available lights, grouped by light type'

Validated by:

• check_plugin_compatibility

field tree: StageManagerTreePlugin = {'name': 'LightGroupsTreePlugin'}

Validated by:

• check_plugin_compatibility

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] = 'AllLightsInteractionPlugin'

• 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.interaction.usd.all_materials.AllMaterialsInteractionPlugin

Show JSON schema

{
   "title": "AllMaterialsInteractionPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Materials",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "View the available materials and the meshes that use them",
         "title": "Tooltip",
         "type": "string"
      },
      "compatible_data_type": {
         "$ref": "#/$defs/StageManagerDataTypes",
         "default": "USD"
      },
      "select_all_children": {
         "default": false,
         "description": "Whether the tree should select all children items when selecting a parent item or not",
         "title": "Select All Children",
         "type": "boolean"
      },
      "scroll_to_selection": {
         "default": true,
         "description": "Whether the tree should scroll to the first item in the selection when selection changes",
         "title": "Scroll To Selection",
         "type": "boolean"
      },
      "validate_action_selection": {
         "default": true,
         "description": "Whether the tree selection should be validated & updated to include the item being right-clicked on or not",
         "title": "Validate Action Selection",
         "type": "boolean"
      },
      "tree": {
         "default": null,
         "title": "Tree"
      },
      "compatible_trees": {
         "default": [
            "MaterialGroupsTreePlugin",
            "PrimGroupsTreePlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Trees",
         "type": "array"
      },
      "compatible_filters": {
         "default": [
            "IgnorePrimsFilterPlugin",
            "IsCaptureFilterPlugin",
            "LightPrimsFilterPlugin",
            "MeshPrimsFilterPlugin",
            "MaterialPrimsFilterPlugin",
            "OmniPrimsFilterPlugin",
            "SearchFilterPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Filters",
         "type": "array"
      },
      "compatible_widgets": {
         "default": [
            "AssignCategoryActionWidgetPlugin",
            "CustomTagsWidgetPlugin",
            "FocusInViewportActionWidgetPlugin",
            "IsCaptureStateWidgetPlugin",
            "IsCategoryHiddenStateWidgetPlugin",
            "IsVisibleActionWidgetPlugin",
            "ParticleSystemsActionWidgetPlugin",
            "PrimTreeWidgetPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Widgets",
         "type": "array"
      },
      "columns": {
         "default": [],
         "description": "Columns to display in the TreeWidget",
         "items": {
            "$ref": "#/$defs/StageManagerColumnPlugin"
         },
         "title": "Columns",
         "type": "array"
      },
      "filters": {
         "default": [],
         "description": "User controllable filters to apply to the context data on tree model refresh. Defined in schema. Will be displayed in UI and will be executed on data that has passed context filter validation.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Filters",
         "type": "array"
      },
      "context_filters": {
         "default": [],
         "description": "Filters to execute when the context data is updated. Defined in schema. Will never be displayed in UI.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Context Filters",
         "type": "array"
      },
      "percent_available_core_usage": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The percentage of the available CPU cores to use to filter the context items. If the value is unset, the default python maximum will be used.",
         "title": "Percent Available Core Usage"
      },
      "internal_context_filters": {
         "default": [
            {
               "name": "MaterialPrimsFilterPlugin"
            }
         ],
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Internal Context Filters",
         "type": "array"
      },
      "include_invalid_parents": {
         "default": true,
         "description": "Whether the tree should include invalid context item parents or whether the tree should be sparse",
         "title": "Include Invalid Parents",
         "type": "boolean"
      },
      "row_height": {
         "default": 28,
         "description": "The height of the Tree rows in pixels.",
         "title": "Row Height",
         "type": "integer"
      },
      "header_height": {
         "default": 28,
         "description": "The height of the header in pixels. Will be used to offset the alternating row background",
         "title": "Header Height",
         "type": "integer"
      },
      "alternate_row_colors": {
         "default": true,
         "description": "Whether the tree's rows should alternate in color",
         "title": "Alternate Row Colors",
         "type": "boolean"
      },
      "debounce_frames": {
         "default": 5,
         "description": "The number of frames that should be used to debounce the item update requests",
         "title": "Debounce Frames",
         "type": "integer"
      },
      "synchronize_selection": {
         "default": true,
         "description": "Synchronize the USD selection between the stage and the UI",
         "title": "Synchronize Selection",
         "type": "boolean"
      },
      "filtering_rules": {
         "$ref": "#/$defs/USDEventFilteringRules",
         "default": {
            "ignore_properties_events": [
               "xformOpOrder"
            ],
            "ignore_paths_events": [
               "/RootNode/Camera"
            ],
            "ignore_xform_events": true,
            "ignore_omni_prims_events": true,
            "ignore_custom_layer_data_events": true,
            "force_refresh_rules": []
         },
         "description": "Rules used for the USD events in the callback"
      }
   },
   "$defs": {
      "ColumnWidth": {
         "properties": {
            "unit": {
               "$ref": "#/$defs/LengthUnit",
               "description": "The unit of the column width"
            },
            "value": {
               "description": "The value of the column width",
               "title": "Value",
               "type": "number"
            }
         },
         "required": [
            "unit",
            "value"
         ],
         "title": "ColumnWidth",
         "type": "object"
      },
      "LengthUnit": {
         "enum": [
            "Fraction",
            "Percent",
            "Pixel"
         ],
         "title": "LengthUnit",
         "type": "string"
      },
      "RefreshRule": {
         "properties": {
            "use_name": {
               "default": true,
               "description": "Whether to use the prim name or full prim path to match",
               "title": "Use Name",
               "type": "boolean"
            },
            "start": {
               "default": "",
               "description": "String to match the start of the affected prims' names",
               "title": "Start",
               "type": "string"
            },
            "end": {
               "default": "",
               "description": "String to match the end of the affected prims' names",
               "title": "End",
               "type": "string"
            }
         },
         "title": "RefreshRule",
         "type": "object"
      },
      "StageManagerColumnPlugin": {
         "description": "A plugin that allows the grouping of multiple widgets in a column",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The name to display in the column header",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "default": "",
               "description": "The tooltip to display when hovering over the column header",
               "title": "Tooltip",
               "type": "string"
            },
            "widgets": {
               "description": "Widgets to be displayed in the column",
               "items": {
                  "$ref": "#/$defs/StageManagerWidgetPlugin"
               },
               "title": "Widgets",
               "type": "array"
            },
            "width": {
               "$ref": "#/$defs/ColumnWidth",
               "default": {
                  "unit": "Fraction",
                  "value": 1.0
               },
               "description": "Width of the column"
            },
            "centered_title": {
               "default": false,
               "description": "Whether the title should be centered or left-aligned",
               "title": "Centered Title",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "widgets"
         ],
         "title": "StageManagerColumnPlugin",
         "type": "object"
      },
      "StageManagerDataTypes": {
         "enum": [
            "None",
            "USD",
            "File"
         ],
         "title": "StageManagerDataTypes",
         "type": "string"
      },
      "StageManagerFilterPlugin": {
         "description": "A plugin that allows filtering a list of items based on parameters controlled within the plugin",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            },
            "display": {
               "default": true,
               "description": "Whether the filter plugin should be displayed in the UI",
               "title": "Display",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerFilterPlugin",
         "type": "object"
      },
      "StageManagerWidgetPlugin": {
         "description": "A plugin that provides a widget for the TreeView",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerWidgetPlugin",
         "type": "object"
      },
      "USDEventFilteringRules": {
         "properties": {
            "ignore_properties_events": {
               "default": [
                  "xformOpOrder"
               ],
               "description": "List of property names to ignore",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Properties Events",
               "type": "array"
            },
            "ignore_paths_events": {
               "default": [
                  "/RootNode/Camera"
               ],
               "description": "List of prim paths to ignore (Only exact matches for the Prim Path will be ignored)",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Paths Events",
               "type": "array"
            },
            "ignore_xform_events": {
               "default": true,
               "description": "Whether the XForm events emitted by the USD listener should be ignored or not",
               "title": "Ignore Xform Events",
               "type": "boolean"
            },
            "ignore_omni_prims_events": {
               "default": true,
               "description": "Whether the events emitted on Omniverse Prims should be ignored or not",
               "title": "Ignore Omni Prims Events",
               "type": "boolean"
            },
            "ignore_custom_layer_data_events": {
               "default": true,
               "description": "Whether the events emitted for Custom Layer Data should be ignored or not",
               "title": "Ignore Custom Layer Data Events",
               "type": "boolean"
            },
            "force_refresh_rules": {
               "default": [],
               "description": "List of rules to force a refresh of the tree items rather than a delegate refresh",
               "items": {
                  "$ref": "#/$defs/RefreshRule"
               },
               "title": "Force Refresh Rules",
               "type": "array"
            }
         },
         "title": "USDEventFilteringRules",
         "type": "object"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• compatible_filters (list[str])

• compatible_trees (list[str])

• compatible_widgets (list[str])

• display_name (str)

• internal_context_filters (list[omni.flux.stage_manager.factory.plugins.filter_plugin.StageManagerFilterPlugin])

• tooltip (str)

• tree (omni.flux.stage_manager.factory.plugins.tree_plugin.StageManagerTreePlugin)

Validators:

• check_unique_filters » internal_context_filters

field compatible_filters: list[str] = ['IgnorePrimsFilterPlugin', 'IsCaptureFilterPlugin', 'LightPrimsFilterPlugin', 'MeshPrimsFilterPlugin', 'MaterialPrimsFilterPlugin', 'OmniPrimsFilterPlugin', 'SearchFilterPlugin']

Validated by:

• check_plugin_compatibility

field compatible_trees: list[str] = ['MaterialGroupsTreePlugin', 'PrimGroupsTreePlugin']

Validated by:

• check_plugin_compatibility

field compatible_widgets: list[str] = ['AssignCategoryActionWidgetPlugin', 'CustomTagsWidgetPlugin', 'FocusInViewportActionWidgetPlugin', 'IsCaptureStateWidgetPlugin', 'IsCategoryHiddenStateWidgetPlugin', 'IsVisibleActionWidgetPlugin', 'ParticleSystemsActionWidgetPlugin', 'PrimTreeWidgetPlugin']

Validated by:

• check_plugin_compatibility

field display_name: str = 'Materials'

Validated by:

• check_plugin_compatibility

field internal_context_filters: list[StageManagerFilterPlugin] = [{'name': 'MaterialPrimsFilterPlugin'}]

Validated by:

• check_plugin_compatibility

• check_unique_filters

field tooltip: str = 'View the available materials and the meshes that use them'

Validated by:

• check_plugin_compatibility

field tree: StageManagerTreePlugin = {'name': 'MaterialGroupsTreePlugin'}

Validated by:

• check_plugin_compatibility

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] = 'AllMaterialsInteractionPlugin'

• 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.interaction.usd.all_prims.AllPrimsInteractionPlugin

Show JSON schema

{
   "title": "AllPrimsInteractionPlugin",
   "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": "View all the available prims",
         "title": "Tooltip",
         "type": "string"
      },
      "compatible_data_type": {
         "$ref": "#/$defs/StageManagerDataTypes",
         "default": "USD"
      },
      "select_all_children": {
         "default": false,
         "description": "Whether the tree should select all children items when selecting a parent item or not",
         "title": "Select All Children",
         "type": "boolean"
      },
      "scroll_to_selection": {
         "default": true,
         "description": "Whether the tree should scroll to the first item in the selection when selection changes",
         "title": "Scroll To Selection",
         "type": "boolean"
      },
      "validate_action_selection": {
         "default": true,
         "description": "Whether the tree selection should be validated & updated to include the item being right-clicked on or not",
         "title": "Validate Action Selection",
         "type": "boolean"
      },
      "tree": {
         "default": null,
         "title": "Tree"
      },
      "compatible_trees": {
         "default": [
            "PrimGroupsTreePlugin",
            "VirtualGroupsTreePlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Trees",
         "type": "array"
      },
      "compatible_filters": {
         "default": [
            "IgnorePrimsFilterPlugin",
            "IsCaptureFilterPlugin",
            "MeshPrimsFilterPlugin",
            "OmniPrimsFilterPlugin",
            "SearchFilterPlugin",
            "IsCategoryFilterPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Filters",
         "type": "array"
      },
      "compatible_widgets": {
         "default": [
            "AssignCategoryActionWidgetPlugin",
            "CustomTagsWidgetPlugin",
            "FocusInViewportActionWidgetPlugin",
            "IsCaptureStateWidgetPlugin",
            "IsCategoryHiddenStateWidgetPlugin",
            "IsVisibleActionWidgetPlugin",
            "ParticleSystemsActionWidgetPlugin",
            "PrimTreeWidgetPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Widgets",
         "type": "array"
      },
      "columns": {
         "default": [],
         "description": "Columns to display in the TreeWidget",
         "items": {
            "$ref": "#/$defs/StageManagerColumnPlugin"
         },
         "title": "Columns",
         "type": "array"
      },
      "filters": {
         "default": [],
         "description": "User controllable filters to apply to the context data on tree model refresh. Defined in schema. Will be displayed in UI and will be executed on data that has passed context filter validation.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Filters",
         "type": "array"
      },
      "context_filters": {
         "default": [],
         "description": "Filters to execute when the context data is updated. Defined in schema. Will never be displayed in UI.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Context Filters",
         "type": "array"
      },
      "percent_available_core_usage": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The percentage of the available CPU cores to use to filter the context items. If the value is unset, the default python maximum will be used.",
         "title": "Percent Available Core Usage"
      },
      "internal_context_filters": {
         "default": [],
         "description": "Context filters defined solely by the interaction plugin. The definition should not be part of the schema. Will never be displayed in UI and will be executed with the context filters.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Internal Context Filters",
         "type": "array"
      },
      "include_invalid_parents": {
         "default": true,
         "description": "Whether the tree should include invalid context item parents or whether the tree should be sparse",
         "title": "Include Invalid Parents",
         "type": "boolean"
      },
      "row_height": {
         "default": 28,
         "description": "The height of the Tree rows in pixels.",
         "title": "Row Height",
         "type": "integer"
      },
      "header_height": {
         "default": 28,
         "description": "The height of the header in pixels. Will be used to offset the alternating row background",
         "title": "Header Height",
         "type": "integer"
      },
      "alternate_row_colors": {
         "default": true,
         "description": "Whether the tree's rows should alternate in color",
         "title": "Alternate Row Colors",
         "type": "boolean"
      },
      "debounce_frames": {
         "default": 5,
         "description": "The number of frames that should be used to debounce the item update requests",
         "title": "Debounce Frames",
         "type": "integer"
      },
      "synchronize_selection": {
         "default": true,
         "description": "Synchronize the USD selection between the stage and the UI",
         "title": "Synchronize Selection",
         "type": "boolean"
      },
      "filtering_rules": {
         "$ref": "#/$defs/USDEventFilteringRules",
         "default": {
            "ignore_properties_events": [
               "xformOpOrder"
            ],
            "ignore_paths_events": [
               "/RootNode/Camera"
            ],
            "ignore_xform_events": true,
            "ignore_omni_prims_events": true,
            "ignore_custom_layer_data_events": true,
            "force_refresh_rules": []
         },
         "description": "Rules used for the USD events in the callback"
      }
   },
   "$defs": {
      "ColumnWidth": {
         "properties": {
            "unit": {
               "$ref": "#/$defs/LengthUnit",
               "description": "The unit of the column width"
            },
            "value": {
               "description": "The value of the column width",
               "title": "Value",
               "type": "number"
            }
         },
         "required": [
            "unit",
            "value"
         ],
         "title": "ColumnWidth",
         "type": "object"
      },
      "LengthUnit": {
         "enum": [
            "Fraction",
            "Percent",
            "Pixel"
         ],
         "title": "LengthUnit",
         "type": "string"
      },
      "RefreshRule": {
         "properties": {
            "use_name": {
               "default": true,
               "description": "Whether to use the prim name or full prim path to match",
               "title": "Use Name",
               "type": "boolean"
            },
            "start": {
               "default": "",
               "description": "String to match the start of the affected prims' names",
               "title": "Start",
               "type": "string"
            },
            "end": {
               "default": "",
               "description": "String to match the end of the affected prims' names",
               "title": "End",
               "type": "string"
            }
         },
         "title": "RefreshRule",
         "type": "object"
      },
      "StageManagerColumnPlugin": {
         "description": "A plugin that allows the grouping of multiple widgets in a column",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The name to display in the column header",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "default": "",
               "description": "The tooltip to display when hovering over the column header",
               "title": "Tooltip",
               "type": "string"
            },
            "widgets": {
               "description": "Widgets to be displayed in the column",
               "items": {
                  "$ref": "#/$defs/StageManagerWidgetPlugin"
               },
               "title": "Widgets",
               "type": "array"
            },
            "width": {
               "$ref": "#/$defs/ColumnWidth",
               "default": {
                  "unit": "Fraction",
                  "value": 1.0
               },
               "description": "Width of the column"
            },
            "centered_title": {
               "default": false,
               "description": "Whether the title should be centered or left-aligned",
               "title": "Centered Title",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "widgets"
         ],
         "title": "StageManagerColumnPlugin",
         "type": "object"
      },
      "StageManagerDataTypes": {
         "enum": [
            "None",
            "USD",
            "File"
         ],
         "title": "StageManagerDataTypes",
         "type": "string"
      },
      "StageManagerFilterPlugin": {
         "description": "A plugin that allows filtering a list of items based on parameters controlled within the plugin",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            },
            "display": {
               "default": true,
               "description": "Whether the filter plugin should be displayed in the UI",
               "title": "Display",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerFilterPlugin",
         "type": "object"
      },
      "StageManagerWidgetPlugin": {
         "description": "A plugin that provides a widget for the TreeView",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerWidgetPlugin",
         "type": "object"
      },
      "USDEventFilteringRules": {
         "properties": {
            "ignore_properties_events": {
               "default": [
                  "xformOpOrder"
               ],
               "description": "List of property names to ignore",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Properties Events",
               "type": "array"
            },
            "ignore_paths_events": {
               "default": [
                  "/RootNode/Camera"
               ],
               "description": "List of prim paths to ignore (Only exact matches for the Prim Path will be ignored)",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Paths Events",
               "type": "array"
            },
            "ignore_xform_events": {
               "default": true,
               "description": "Whether the XForm events emitted by the USD listener should be ignored or not",
               "title": "Ignore Xform Events",
               "type": "boolean"
            },
            "ignore_omni_prims_events": {
               "default": true,
               "description": "Whether the events emitted on Omniverse Prims should be ignored or not",
               "title": "Ignore Omni Prims Events",
               "type": "boolean"
            },
            "ignore_custom_layer_data_events": {
               "default": true,
               "description": "Whether the events emitted for Custom Layer Data should be ignored or not",
               "title": "Ignore Custom Layer Data Events",
               "type": "boolean"
            },
            "force_refresh_rules": {
               "default": [],
               "description": "List of rules to force a refresh of the tree items rather than a delegate refresh",
               "items": {
                  "$ref": "#/$defs/RefreshRule"
               },
               "title": "Force Refresh Rules",
               "type": "array"
            }
         },
         "title": "USDEventFilteringRules",
         "type": "object"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• compatible_filters (list[str])

• compatible_trees (list[str])

• compatible_widgets (list[str])

• display_name (str)

• tooltip (str)

• tree (omni.flux.stage_manager.factory.plugins.tree_plugin.StageManagerTreePlugin)

Validators:

field compatible_filters: list[str] = ['IgnorePrimsFilterPlugin', 'IsCaptureFilterPlugin', 'MeshPrimsFilterPlugin', 'OmniPrimsFilterPlugin', 'SearchFilterPlugin', 'IsCategoryFilterPlugin']

Validated by:

• check_plugin_compatibility

field compatible_trees: list[str] = ['PrimGroupsTreePlugin', 'VirtualGroupsTreePlugin']

Validated by:

• check_plugin_compatibility

field compatible_widgets: list[str] = ['AssignCategoryActionWidgetPlugin', 'CustomTagsWidgetPlugin', 'FocusInViewportActionWidgetPlugin', 'IsCaptureStateWidgetPlugin', 'IsCategoryHiddenStateWidgetPlugin', 'IsVisibleActionWidgetPlugin', 'ParticleSystemsActionWidgetPlugin', 'PrimTreeWidgetPlugin']

Validated by:

• check_plugin_compatibility

field display_name: str = 'Prims'

Validated by:

• check_plugin_compatibility

field tooltip: str = 'View all the available prims'

Validated by:

• check_plugin_compatibility

field tree: StageManagerTreePlugin = {'name': 'PrimGroupsTreePlugin'}

Validated by:

• check_plugin_compatibility

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] = 'AllPrimsInteractionPlugin'

• 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.interaction.usd.all_skeletons.AllSkeletonsInteractionPlugin

Show JSON schema

{
   "title": "AllSkeletonsInteractionPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Skeletons",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "View the available skeletons and their bound prims",
         "title": "Tooltip",
         "type": "string"
      },
      "compatible_data_type": {
         "$ref": "#/$defs/StageManagerDataTypes",
         "default": "USD"
      },
      "select_all_children": {
         "default": false,
         "description": "Whether the tree should select all children items when selecting a parent item or not",
         "title": "Select All Children",
         "type": "boolean"
      },
      "scroll_to_selection": {
         "default": true,
         "description": "Whether the tree should scroll to the first item in the selection when selection changes",
         "title": "Scroll To Selection",
         "type": "boolean"
      },
      "validate_action_selection": {
         "default": true,
         "description": "Whether the tree selection should be validated & updated to include the item being right-clicked on or not",
         "title": "Validate Action Selection",
         "type": "boolean"
      },
      "tree": {
         "default": null,
         "title": "Tree"
      },
      "compatible_trees": {
         "default": [
            "PrimGroupsTreePlugin",
            "SkeletonGroupsTreePlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Trees",
         "type": "array"
      },
      "compatible_filters": {
         "default": [
            "IgnorePrimsFilterPlugin",
            "IsCaptureFilterPlugin",
            "OmniPrimsFilterPlugin",
            "SearchFilterPlugin",
            "SkeletonPrimsFilterPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Filters",
         "type": "array"
      },
      "compatible_widgets": {
         "default": [
            "AssignCategoryActionWidgetPlugin",
            "CustomTagsWidgetPlugin",
            "FocusInViewportActionWidgetPlugin",
            "IsCaptureStateWidgetPlugin",
            "IsCategoryHiddenStateWidgetPlugin",
            "IsVisibleActionWidgetPlugin",
            "ParticleSystemsActionWidgetPlugin",
            "PrimTreeWidgetPlugin",
            "RemapSkeletonActionWidgetPlugin",
            "RemapSkeletonInfoWidgetPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Widgets",
         "type": "array"
      },
      "columns": {
         "default": [],
         "description": "Columns to display in the TreeWidget",
         "items": {
            "$ref": "#/$defs/StageManagerColumnPlugin"
         },
         "title": "Columns",
         "type": "array"
      },
      "filters": {
         "default": [],
         "description": "User controllable filters to apply to the context data on tree model refresh. Defined in schema. Will be displayed in UI and will be executed on data that has passed context filter validation.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Filters",
         "type": "array"
      },
      "context_filters": {
         "default": [],
         "description": "Filters to execute when the context data is updated. Defined in schema. Will never be displayed in UI.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Context Filters",
         "type": "array"
      },
      "percent_available_core_usage": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The percentage of the available CPU cores to use to filter the context items. If the value is unset, the default python maximum will be used.",
         "title": "Percent Available Core Usage"
      },
      "internal_context_filters": {
         "default": [
            {
               "name": "SkeletonPrimsFilterPlugin"
            }
         ],
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Internal Context Filters",
         "type": "array"
      },
      "include_invalid_parents": {
         "default": true,
         "description": "Whether the tree should include invalid context item parents or whether the tree should be sparse",
         "title": "Include Invalid Parents",
         "type": "boolean"
      },
      "row_height": {
         "default": 28,
         "description": "The height of the Tree rows in pixels.",
         "title": "Row Height",
         "type": "integer"
      },
      "header_height": {
         "default": 28,
         "description": "The height of the header in pixels. Will be used to offset the alternating row background",
         "title": "Header Height",
         "type": "integer"
      },
      "alternate_row_colors": {
         "default": true,
         "description": "Whether the tree's rows should alternate in color",
         "title": "Alternate Row Colors",
         "type": "boolean"
      },
      "debounce_frames": {
         "default": 5,
         "description": "The number of frames that should be used to debounce the item update requests",
         "title": "Debounce Frames",
         "type": "integer"
      },
      "synchronize_selection": {
         "default": true,
         "description": "Synchronize the USD selection between the stage and the UI",
         "title": "Synchronize Selection",
         "type": "boolean"
      },
      "filtering_rules": {
         "$ref": "#/$defs/USDEventFilteringRules",
         "default": {
            "ignore_properties_events": [
               "xformOpOrder"
            ],
            "ignore_paths_events": [
               "/RootNode/Camera"
            ],
            "ignore_xform_events": true,
            "ignore_omni_prims_events": true,
            "ignore_custom_layer_data_events": true,
            "force_refresh_rules": []
         },
         "description": "Rules used for the USD events in the callback"
      }
   },
   "$defs": {
      "ColumnWidth": {
         "properties": {
            "unit": {
               "$ref": "#/$defs/LengthUnit",
               "description": "The unit of the column width"
            },
            "value": {
               "description": "The value of the column width",
               "title": "Value",
               "type": "number"
            }
         },
         "required": [
            "unit",
            "value"
         ],
         "title": "ColumnWidth",
         "type": "object"
      },
      "LengthUnit": {
         "enum": [
            "Fraction",
            "Percent",
            "Pixel"
         ],
         "title": "LengthUnit",
         "type": "string"
      },
      "RefreshRule": {
         "properties": {
            "use_name": {
               "default": true,
               "description": "Whether to use the prim name or full prim path to match",
               "title": "Use Name",
               "type": "boolean"
            },
            "start": {
               "default": "",
               "description": "String to match the start of the affected prims' names",
               "title": "Start",
               "type": "string"
            },
            "end": {
               "default": "",
               "description": "String to match the end of the affected prims' names",
               "title": "End",
               "type": "string"
            }
         },
         "title": "RefreshRule",
         "type": "object"
      },
      "StageManagerColumnPlugin": {
         "description": "A plugin that allows the grouping of multiple widgets in a column",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The name to display in the column header",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "default": "",
               "description": "The tooltip to display when hovering over the column header",
               "title": "Tooltip",
               "type": "string"
            },
            "widgets": {
               "description": "Widgets to be displayed in the column",
               "items": {
                  "$ref": "#/$defs/StageManagerWidgetPlugin"
               },
               "title": "Widgets",
               "type": "array"
            },
            "width": {
               "$ref": "#/$defs/ColumnWidth",
               "default": {
                  "unit": "Fraction",
                  "value": 1.0
               },
               "description": "Width of the column"
            },
            "centered_title": {
               "default": false,
               "description": "Whether the title should be centered or left-aligned",
               "title": "Centered Title",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "widgets"
         ],
         "title": "StageManagerColumnPlugin",
         "type": "object"
      },
      "StageManagerDataTypes": {
         "enum": [
            "None",
            "USD",
            "File"
         ],
         "title": "StageManagerDataTypes",
         "type": "string"
      },
      "StageManagerFilterPlugin": {
         "description": "A plugin that allows filtering a list of items based on parameters controlled within the plugin",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            },
            "display": {
               "default": true,
               "description": "Whether the filter plugin should be displayed in the UI",
               "title": "Display",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerFilterPlugin",
         "type": "object"
      },
      "StageManagerWidgetPlugin": {
         "description": "A plugin that provides a widget for the TreeView",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerWidgetPlugin",
         "type": "object"
      },
      "USDEventFilteringRules": {
         "properties": {
            "ignore_properties_events": {
               "default": [
                  "xformOpOrder"
               ],
               "description": "List of property names to ignore",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Properties Events",
               "type": "array"
            },
            "ignore_paths_events": {
               "default": [
                  "/RootNode/Camera"
               ],
               "description": "List of prim paths to ignore (Only exact matches for the Prim Path will be ignored)",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Paths Events",
               "type": "array"
            },
            "ignore_xform_events": {
               "default": true,
               "description": "Whether the XForm events emitted by the USD listener should be ignored or not",
               "title": "Ignore Xform Events",
               "type": "boolean"
            },
            "ignore_omni_prims_events": {
               "default": true,
               "description": "Whether the events emitted on Omniverse Prims should be ignored or not",
               "title": "Ignore Omni Prims Events",
               "type": "boolean"
            },
            "ignore_custom_layer_data_events": {
               "default": true,
               "description": "Whether the events emitted for Custom Layer Data should be ignored or not",
               "title": "Ignore Custom Layer Data Events",
               "type": "boolean"
            },
            "force_refresh_rules": {
               "default": [],
               "description": "List of rules to force a refresh of the tree items rather than a delegate refresh",
               "items": {
                  "$ref": "#/$defs/RefreshRule"
               },
               "title": "Force Refresh Rules",
               "type": "array"
            }
         },
         "title": "USDEventFilteringRules",
         "type": "object"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• compatible_filters (list[str])

• compatible_trees (list[str])

• compatible_widgets (list[str])

• display_name (str)

• internal_context_filters (list[omni.flux.stage_manager.factory.plugins.filter_plugin.StageManagerFilterPlugin])

• tooltip (str)

• tree (omni.flux.stage_manager.factory.plugins.tree_plugin.StageManagerTreePlugin)

Validators:

• check_unique_filters » internal_context_filters

field compatible_filters: list[str] = ['IgnorePrimsFilterPlugin', 'IsCaptureFilterPlugin', 'OmniPrimsFilterPlugin', 'SearchFilterPlugin', 'SkeletonPrimsFilterPlugin']

Validated by:

• check_plugin_compatibility

field compatible_trees: list[str] = ['PrimGroupsTreePlugin', 'SkeletonGroupsTreePlugin']

Validated by:

• check_plugin_compatibility

field compatible_widgets: list[str] = ['AssignCategoryActionWidgetPlugin', 'CustomTagsWidgetPlugin', 'FocusInViewportActionWidgetPlugin', 'IsCaptureStateWidgetPlugin', 'IsCategoryHiddenStateWidgetPlugin', 'IsVisibleActionWidgetPlugin', 'ParticleSystemsActionWidgetPlugin', 'PrimTreeWidgetPlugin', 'RemapSkeletonActionWidgetPlugin', 'RemapSkeletonInfoWidgetPlugin']

Validated by:

• check_plugin_compatibility

field display_name: str = 'Skeletons'

Validated by:

• check_plugin_compatibility

field internal_context_filters: list[StageManagerFilterPlugin] = [{'name': 'SkeletonPrimsFilterPlugin'}]

Validated by:

• check_plugin_compatibility

• check_unique_filters

field tooltip: str = 'View the available skeletons and their bound prims'

Validated by:

• check_plugin_compatibility

field tree: StageManagerTreePlugin = {'name': 'SkeletonGroupsTreePlugin'}

Validated by:

• check_plugin_compatibility

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] = 'AllSkeletonsInteractionPlugin'

• 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.interaction.usd.all_tags.AllTagsInteractionPlugin

Show JSON schema

{
   "title": "AllTagsInteractionPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Custom Tags",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "View the available prims, grouped by custom tags",
         "title": "Tooltip",
         "type": "string"
      },
      "compatible_data_type": {
         "$ref": "#/$defs/StageManagerDataTypes",
         "default": "USD"
      },
      "select_all_children": {
         "default": false,
         "description": "Whether the tree should select all children items when selecting a parent item or not",
         "title": "Select All Children",
         "type": "boolean"
      },
      "scroll_to_selection": {
         "default": true,
         "description": "Whether the tree should scroll to the first item in the selection when selection changes",
         "title": "Scroll To Selection",
         "type": "boolean"
      },
      "validate_action_selection": {
         "default": true,
         "description": "Whether the tree selection should be validated & updated to include the item being right-clicked on or not",
         "title": "Validate Action Selection",
         "type": "boolean"
      },
      "tree": {
         "default": null,
         "title": "Tree"
      },
      "compatible_trees": {
         "default": [
            "CustomTagGroupsTreePlugin",
            "PrimGroupsTreePlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Trees",
         "type": "array"
      },
      "compatible_filters": {
         "default": [
            "IgnorePrimsFilterPlugin",
            "IsCaptureFilterPlugin",
            "OmniPrimsFilterPlugin",
            "SearchFilterPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Filters",
         "type": "array"
      },
      "compatible_widgets": {
         "default": [
            "AssignCategoryActionWidgetPlugin",
            "CustomTagsWidgetPlugin",
            "FocusInViewportActionWidgetPlugin",
            "IsCaptureStateWidgetPlugin",
            "IsCategoryHiddenStateWidgetPlugin",
            "IsVisibleActionWidgetPlugin",
            "ParticleSystemsActionWidgetPlugin",
            "PrimTreeWidgetPlugin"
         ],
         "items": {
            "type": "string"
         },
         "title": "Compatible Widgets",
         "type": "array"
      },
      "columns": {
         "default": [],
         "description": "Columns to display in the TreeWidget",
         "items": {
            "$ref": "#/$defs/StageManagerColumnPlugin"
         },
         "title": "Columns",
         "type": "array"
      },
      "filters": {
         "default": [],
         "description": "User controllable filters to apply to the context data on tree model refresh. Defined in schema. Will be displayed in UI and will be executed on data that has passed context filter validation.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Filters",
         "type": "array"
      },
      "context_filters": {
         "default": [],
         "description": "Filters to execute when the context data is updated. Defined in schema. Will never be displayed in UI.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Context Filters",
         "type": "array"
      },
      "percent_available_core_usage": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The percentage of the available CPU cores to use to filter the context items. If the value is unset, the default python maximum will be used.",
         "title": "Percent Available Core Usage"
      },
      "internal_context_filters": {
         "default": [],
         "description": "Context filters defined solely by the interaction plugin. The definition should not be part of the schema. Will never be displayed in UI and will be executed with the context filters.",
         "items": {
            "$ref": "#/$defs/StageManagerFilterPlugin"
         },
         "title": "Internal Context Filters",
         "type": "array"
      },
      "include_invalid_parents": {
         "default": true,
         "description": "Whether the tree should include invalid context item parents or whether the tree should be sparse",
         "title": "Include Invalid Parents",
         "type": "boolean"
      },
      "row_height": {
         "default": 28,
         "description": "The height of the Tree rows in pixels.",
         "title": "Row Height",
         "type": "integer"
      },
      "header_height": {
         "default": 28,
         "description": "The height of the header in pixels. Will be used to offset the alternating row background",
         "title": "Header Height",
         "type": "integer"
      },
      "alternate_row_colors": {
         "default": true,
         "description": "Whether the tree's rows should alternate in color",
         "title": "Alternate Row Colors",
         "type": "boolean"
      },
      "debounce_frames": {
         "default": 5,
         "description": "The number of frames that should be used to debounce the item update requests",
         "title": "Debounce Frames",
         "type": "integer"
      },
      "synchronize_selection": {
         "default": true,
         "description": "Synchronize the USD selection between the stage and the UI",
         "title": "Synchronize Selection",
         "type": "boolean"
      },
      "filtering_rules": {
         "$ref": "#/$defs/USDEventFilteringRules",
         "default": {
            "ignore_properties_events": [
               "xformOpOrder"
            ],
            "ignore_paths_events": [
               "/RootNode/Camera"
            ],
            "ignore_xform_events": true,
            "ignore_omni_prims_events": true,
            "ignore_custom_layer_data_events": true,
            "force_refresh_rules": []
         },
         "description": "Rules used for the USD events in the callback"
      }
   },
   "$defs": {
      "ColumnWidth": {
         "properties": {
            "unit": {
               "$ref": "#/$defs/LengthUnit",
               "description": "The unit of the column width"
            },
            "value": {
               "description": "The value of the column width",
               "title": "Value",
               "type": "number"
            }
         },
         "required": [
            "unit",
            "value"
         ],
         "title": "ColumnWidth",
         "type": "object"
      },
      "LengthUnit": {
         "enum": [
            "Fraction",
            "Percent",
            "Pixel"
         ],
         "title": "LengthUnit",
         "type": "string"
      },
      "RefreshRule": {
         "properties": {
            "use_name": {
               "default": true,
               "description": "Whether to use the prim name or full prim path to match",
               "title": "Use Name",
               "type": "boolean"
            },
            "start": {
               "default": "",
               "description": "String to match the start of the affected prims' names",
               "title": "Start",
               "type": "string"
            },
            "end": {
               "default": "",
               "description": "String to match the end of the affected prims' names",
               "title": "End",
               "type": "string"
            }
         },
         "title": "RefreshRule",
         "type": "object"
      },
      "StageManagerColumnPlugin": {
         "description": "A plugin that allows the grouping of multiple widgets in a column",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The name to display in the column header",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "default": "",
               "description": "The tooltip to display when hovering over the column header",
               "title": "Tooltip",
               "type": "string"
            },
            "widgets": {
               "description": "Widgets to be displayed in the column",
               "items": {
                  "$ref": "#/$defs/StageManagerWidgetPlugin"
               },
               "title": "Widgets",
               "type": "array"
            },
            "width": {
               "$ref": "#/$defs/ColumnWidth",
               "default": {
                  "unit": "Fraction",
                  "value": 1.0
               },
               "description": "Width of the column"
            },
            "centered_title": {
               "default": false,
               "description": "Whether the title should be centered or left-aligned",
               "title": "Centered Title",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "widgets"
         ],
         "title": "StageManagerColumnPlugin",
         "type": "object"
      },
      "StageManagerDataTypes": {
         "enum": [
            "None",
            "USD",
            "File"
         ],
         "title": "StageManagerDataTypes",
         "type": "string"
      },
      "StageManagerFilterPlugin": {
         "description": "A plugin that allows filtering a list of items based on parameters controlled within the plugin",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            },
            "display": {
               "default": true,
               "description": "Whether the filter plugin should be displayed in the UI",
               "title": "Display",
               "type": "boolean"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerFilterPlugin",
         "type": "object"
      },
      "StageManagerWidgetPlugin": {
         "description": "A plugin that provides a widget for the TreeView",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerWidgetPlugin",
         "type": "object"
      },
      "USDEventFilteringRules": {
         "properties": {
            "ignore_properties_events": {
               "default": [
                  "xformOpOrder"
               ],
               "description": "List of property names to ignore",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Properties Events",
               "type": "array"
            },
            "ignore_paths_events": {
               "default": [
                  "/RootNode/Camera"
               ],
               "description": "List of prim paths to ignore (Only exact matches for the Prim Path will be ignored)",
               "items": {
                  "type": "string"
               },
               "title": "Ignore Paths Events",
               "type": "array"
            },
            "ignore_xform_events": {
               "default": true,
               "description": "Whether the XForm events emitted by the USD listener should be ignored or not",
               "title": "Ignore Xform Events",
               "type": "boolean"
            },
            "ignore_omni_prims_events": {
               "default": true,
               "description": "Whether the events emitted on Omniverse Prims should be ignored or not",
               "title": "Ignore Omni Prims Events",
               "type": "boolean"
            },
            "ignore_custom_layer_data_events": {
               "default": true,
               "description": "Whether the events emitted for Custom Layer Data should be ignored or not",
               "title": "Ignore Custom Layer Data Events",
               "type": "boolean"
            },
            "force_refresh_rules": {
               "default": [],
               "description": "List of rules to force a refresh of the tree items rather than a delegate refresh",
               "items": {
                  "$ref": "#/$defs/RefreshRule"
               },
               "title": "Force Refresh Rules",
               "type": "array"
            }
         },
         "title": "USDEventFilteringRules",
         "type": "object"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• compatible_filters (list[str])

• compatible_trees (list[str])

• compatible_widgets (list[str])

• display_name (str)

• tooltip (str)

• tree (omni.flux.stage_manager.factory.plugins.tree_plugin.StageManagerTreePlugin)

Validators:

field compatible_filters: list[str] = ['IgnorePrimsFilterPlugin', 'IsCaptureFilterPlugin', 'OmniPrimsFilterPlugin', 'SearchFilterPlugin']

Validated by:

• check_plugin_compatibility

field compatible_trees: list[str] = ['CustomTagGroupsTreePlugin', 'PrimGroupsTreePlugin']

Validated by:

• check_plugin_compatibility

field compatible_widgets: list[str] = ['AssignCategoryActionWidgetPlugin', 'CustomTagsWidgetPlugin', 'FocusInViewportActionWidgetPlugin', 'IsCaptureStateWidgetPlugin', 'IsCategoryHiddenStateWidgetPlugin', 'IsVisibleActionWidgetPlugin', 'ParticleSystemsActionWidgetPlugin', 'PrimTreeWidgetPlugin']

Validated by:

• check_plugin_compatibility

field display_name: str = 'Custom Tags'

Validated by:

• check_plugin_compatibility

field tooltip: str = 'View the available prims, grouped by custom tags'

Validated by:

• check_plugin_compatibility

field tree: StageManagerTreePlugin = {'name': 'CustomTagGroupsTreePlugin'}

Validated by:

• check_plugin_compatibility

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] = 'AllTagsInteractionPlugin'