UsdPropertiesWidget#

class omni.kit.property.usd.UsdPropertiesWidget(
title: str,
collapsed: bool,
multi_edit: bool = True,
enable_adapter: bool = False,
maintain_property_order: bool = False,
)#

Bases: SimplePropertyWidget

UsdPropertiesWidget provides functionalities to automatically populates UsdProperties on given prim(s). The UI will and models be generated according to UsdProperties’s value type. Multi-prim editing works for shared Properties between all selected prims if instantiated with multi_edit = True.

Methods

__init__(title, collapsed[, multi_edit, ...])

Constructor.

add_custom_schema_attribute(attribute_name, ...)

add_custom_schema_attributes_to_props(props)

add_listener_adapters(attr_names)

build_items()

See SimplePropertyWidget.build_items

build_nested_group_frames(stage, display_group)

Override this function to build group frames differently.

build_property_item(stage, ui_prop, prim_paths)

Override this function to customize property building.

clean()

See PropertyWidget.clean

get_additional_kwargs(ui_prop)

Override this function if you want to supply additional arguments when building the label or ui widget.

get_valid_stage_adapter(prim_path, attr_name)

is_custom_schema_attribute_used(prim)

on_new_payload(payload)

See PropertyWidget.on_new_payload

request_rebuild()

Request the widget to rebuild.

reset()

See PropertyWidget.reset

reset_models()

__init__(
title: str,
collapsed: bool,
multi_edit: bool = True,
enable_adapter: bool = False,
maintain_property_order: bool = False,
)#

Constructor.

Parameters:

  • title (str) – title of the widget.

  • collapsed (bool) – whether the collapsable frame should be collapsed for this widget.

  • multi_edit (bool) – whether multi-editing is supported.

  • enable_adapter (bool) – use stage_adapters

  • maintain_property_order (bool) – _customize_props_layout returns a list of properties to display on the widget.

build_items()#

See SimplePropertyWidget.build_items

build_nested_group_frames(
stage,
display_group: UiDisplayGroup,
)#

Override this function to build group frames differently.

build_property_item(
stage,
ui_prop: UsdPropertyUiEntry,
prim_paths: List[Path],
)#

Override this function to customize property building.

clean()#

See PropertyWidget.clean

get_additional_kwargs(
ui_prop: UsdPropertyUiEntry,
)#

Override this function if you want to supply additional arguments when building the label or ui widget.

on_new_payload(payload)#

See PropertyWidget.on_new_payload

request_rebuild()#

Request the widget to rebuild. It will be rebuilt on next frame.

reset()#

See PropertyWidget.reset

On this page