omni.flux.stage_manager.plugin.filter.usd

• omni.flux.stage_manager.factory
• 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.

class omni.flux.stage_manager.plugin.filter.usd.extension.StageManagerUSDFilterPluginsExtension

Bases: IExt

on_shutdown()

on_startup(_)

• SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

• SPDX-License-Identifier: Apache-2.0

• Licensed under the Apache License, Version 2.0 (the “License”);

• you may not use this file except in compliance with the License.

• You may obtain a copy of the License at

• 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.filter.usd.ignore_prims.IgnorePrimsFilterPlugin

Bases: StageManagerUSDFilterPlugin

Show JSON schema

{
   "title": "IgnorePrimsFilterPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Ignore Prims",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "Filter out Omniverse prims.\nInput a comma-separated list of prim paths to ignore.",
         "title": "Tooltip",
         "type": "string"
      },
      "display": {
         "default": true,
         "description": "Whether the filter plugin should be displayed in the UI",
         "title": "Display",
         "type": "boolean"
      },
      "ignore_prim_paths": {
         "default": [],
         "description": "A set of prim paths to filter out. The filter will filter out the given prims paths and any children paths",
         "items": {
            "type": "string"
         },
         "title": "Ignore Prim Paths",
         "type": "array",
         "uniqueItems": true
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• display_name (str)

• ignore_prim_paths (set[str])

• tooltip (str)

field display_name: str = 'Ignore Prims'

field ignore_prim_paths: set[str] = {}

A set of prim paths to filter out. The filter will filter out the given prims paths and any children paths

field tooltip: str = 'Filter out Omniverse prims.\nInput a comma-separated list of prim paths to ignore.'

build_ui()

The method used to build the UI for the plugin.

filter_predicate(

item: StageManagerItem,

) → bool

Parameters:

item – The Stage Manager item to filter.

Returns:

Whether the item should be kept or not.

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

• 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.filter.usd.light_prims.LightPrimsFilterPlugin

Bases: ToggleableUSDFilterPlugin

Show JSON schema

{
   "title": "LightPrimsFilterPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Light Prims",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "Filter out light prims",
         "title": "Tooltip",
         "type": "string"
      },
      "display": {
         "default": true,
         "description": "Whether the filter plugin should be displayed in the UI",
         "title": "Display",
         "type": "boolean"
      },
      "filter_active": {
         "default": true,
         "title": "Filter Active",
         "type": "boolean"
      },
      "include_results": {
         "default": true,
         "description": "Include or exclude prims",
         "title": "Include Results",
         "type": "boolean"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• display_name (str)

• tooltip (str)

field display_name: str = 'Light Prims'

field tooltip: str = 'Filter out light prims'

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self – The BaseModel instance.

• context – The context.

name: ClassVar[str] = 'LightPrimsFilterPlugin'

• 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.filter.usd.material_prims.MaterialPrimsFilterPlugin

Bases: ToggleableUSDFilterPlugin

Show JSON schema

{
   "title": "MaterialPrimsFilterPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Material Prims",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "Filter out material prims",
         "title": "Tooltip",
         "type": "string"
      },
      "display": {
         "default": true,
         "description": "Whether the filter plugin should be displayed in the UI",
         "title": "Display",
         "type": "boolean"
      },
      "filter_active": {
         "default": true,
         "title": "Filter Active",
         "type": "boolean"
      },
      "include_results": {
         "default": true,
         "description": "Include or exclude prims",
         "title": "Include Results",
         "type": "boolean"
      },
      "include_meshes": {
         "default": true,
         "description": "Whether the filter should also include child meshes with the materials or not.",
         "title": "Include Meshes",
         "type": "boolean"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• display_name (str)

• include_meshes (bool)

• tooltip (str)

field display_name: str = 'Material Prims'

field include_meshes: bool = True

Whether the filter should also include child meshes with the materials or not.

field tooltip: str = 'Filter out material prims'

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self – The BaseModel instance.

• context – The context.

name: ClassVar[str] = 'MaterialPrimsFilterPlugin'

• 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.filter.usd.omni_prims.OmniPrimsFilterPlugin

Bases: ToggleableUSDFilterPlugin

Show JSON schema

{
   "title": "OmniPrimsFilterPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Omniverse Prims",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "Filter out Omniverse prims",
         "title": "Tooltip",
         "type": "string"
      },
      "display": {
         "default": true,
         "description": "Whether the filter plugin should be displayed in the UI",
         "title": "Display",
         "type": "boolean"
      },
      "filter_active": {
         "default": true,
         "title": "Filter Active",
         "type": "boolean"
      },
      "include_results": {
         "default": true,
         "description": "Include or exclude prims",
         "title": "Include Results",
         "type": "boolean"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• display_name (str)

• tooltip (str)

field display_name: str = 'Omniverse Prims'

field tooltip: str = 'Filter out Omniverse prims'

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self – The BaseModel instance.

• context – The context.

name: ClassVar[str] = 'OmniPrimsFilterPlugin'

• 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.filter.usd.search.SearchFilterPlugin

Bases: StageManagerUSDFilterPlugin

Show JSON schema

{
   "title": "SearchFilterPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Search",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "Search through the list of prims",
         "title": "Tooltip",
         "type": "string"
      },
      "display": {
         "default": true,
         "description": "Whether the filter plugin should be displayed in the UI",
         "title": "Display",
         "type": "boolean"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• display_name (str)

• tooltip (str)

field display_name: str = 'Search'

field tooltip: str = 'Search through the list of prims'

build_ui()

The method used to build the UI for the plugin.

filter_predicate(

item: StageManagerItem,

) → bool

Parameters:

item – The Stage Manager item to filter.

Returns:

Whether the item should be kept or not.

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

• 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.filter.usd.skeleton_prims.SkeletonPrimsFilterPlugin

Bases: ToggleableUSDFilterPlugin

Show JSON schema

{
   "title": "SkeletonPrimsFilterPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "default": "Skeleton Prims",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "Filter out skeleton prims",
         "title": "Tooltip",
         "type": "string"
      },
      "display": {
         "default": true,
         "description": "Whether the filter plugin should be displayed in the UI",
         "title": "Display",
         "type": "boolean"
      },
      "filter_active": {
         "default": true,
         "title": "Filter Active",
         "type": "boolean"
      },
      "include_results": {
         "default": true,
         "description": "Include or exclude prims",
         "title": "Include Results",
         "type": "boolean"
      }
   }
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

• display_name (str)

• tooltip (str)

field display_name: str = 'Skeleton Prims'

field tooltip: str = 'Filter out skeleton prims'

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self – The BaseModel instance.

• context – The context.

name: ClassVar[str] = 'SkeletonPrimsFilterPlugin'