MultiSchemaPropertiesWidget#

class omni.kit.property.usd.MultiSchemaPropertiesWidget(
title: str,
schema,
schema_subclasses: list,
include_list: list = None,
exclude_list: list = None,
api_schemas: Sequence[str] = None,
group_api_schemas: bool = False,
)#

Bases: UsdPropertiesWidget

MultiSchemaPropertiesWidget filters properties and only show the onces from a given IsA schema or schema subclass list.

Methods

__init__(title, schema, schema_subclasses[, ...])

Constructor.

clean()

See PropertyWidget.clean

on_new_payload(payload)

See PropertyWidget.on_new_payload

show_schemas()

Support add/remove of Schema API's.
__init__(
title: str,
schema,
schema_subclasses: list,
include_list: list = None,
exclude_list: list = None,
api_schemas: Sequence[str] = None,
group_api_schemas: bool = False,
)#

Constructor.

Parameters:

  • title (str) – Title of the widgets on the Collapsable Frame.

  • schema – The USD IsA schema or applied API schema to filter properties.

  • schema_subclasses (list) – list of subclasses

  • include_list (list) – list of additional schema named to add

  • exclude_list (list) – list of additional schema named to remove

  • api_schemas (sequence) – a sequence of AppliedAPI schema names that this widget handles

  • group_api_schemas (bool) – whether to create default groupings for any AppliedSchemas on the Usd.Prim

clean()#

See PropertyWidget.clean

on_new_payload(payload)#

See PropertyWidget.on_new_payload

show_schemas()#

Support add/remove of Schema API’s.

Returns:

Return True for widget to allow add/remove of Schema API’s.

Return type:

bool