omni.flux.stage_manager.plugin.listener.usd#

SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
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.listener.usd.layers_listener.StageManagerUSDLayersListenerPlugin#

A listener triggered whenever a layer event is triggered.

Show JSON schema

{
   "title": "StageManagerUSDLayersListenerPlugin",
   "type": "object",
   "properties": {
      "event_type": {
         "title": "Event Type"
      },
      "compatible_data_type": {
         "default": null,
         "title": "Compatible Data Type"
      }
   }
}

Config:

arbitrary_types_allowed: bool = True

Fields:

event_type (type[omni.kit.usd.layers._impl.event.LayerEventType])

field event_type: type[LayerEventType] [Optional]#

cleanup()#: Cleanup the listeners’ subscriptions.

model_post_init( context: Any, /, ) → None#

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

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

Parameters:

self – The BaseModel instance.
context – The context.

setup()#: A method called during the context initialization to initialize the listener

name: ClassVar[str] = 'StageManagerUSDLayersListenerPlugin'#

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.listener.usd.stage_listener.StageManagerUSDStageListenerPlugin#

A listener triggered whenever a stage event is triggered.

Show JSON schema

{
   "title": "StageManagerUSDStageListenerPlugin",
   "type": "object",
   "properties": {
      "event_type": {
         "title": "Event Type"
      },
      "compatible_data_type": {
         "default": null,
         "title": "Compatible Data Type"
      }
   }
}

Config:

arbitrary_types_allowed: bool = True

Fields:

event_type (type[omni.usd._usd.StageEventType])

field event_type: type[StageEventType] [Optional]#

cleanup()#: Cleanup the listeners’ subscriptions.

model_post_init( context: Any, /, ) → None#

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

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

Parameters:

self – The BaseModel instance.
context – The context.

setup()#: A method called during the context initialization to initialize the listener

name: ClassVar[str] = 'StageManagerUSDStageListenerPlugin'#

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.listener.usd.usd_listener.StageManagerUSDNoticeListenerPlugin#

A listener triggered whenever a USD notice is broadcast.

Show JSON schema

{
   "title": "StageManagerUSDNoticeListenerPlugin",
   "type": "object",
   "properties": {
      "event_type": {
         "title": "Event Type"
      },
      "compatible_data_type": {
         "default": null,
         "title": "Compatible Data Type"
      }
   }
}

Config:

arbitrary_types_allowed: bool = True

Fields:

event_type (type[pxr.Usd.ObjectsChanged])

field event_type: type[ObjectsChanged] [Optional]#

cleanup()#: Cleanup the listeners’ subscriptions.

model_post_init( context: Any, /, ) → None#

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

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

Parameters:

self – The BaseModel instance.
context – The context.

setup()#: A method called during the context initialization to initialize the listener

name: ClassVar[str] = 'StageManagerUSDNoticeListenerPlugin'#