UsdShadePropertyUiEntry

class omni.kit.property.material.scripts.widgets.usdshade.usdshade_property_ui_entry.UsdShadePropertyUiEntry(prop_name: str, display_group: str, metadata, property_type, build_fn=None, display_group_collapsed: bool = False, prim_paths: Optional[List[Path]] = None)

Bases: UsdPropertyUiEntry

Subclass of UsdPropertyUiEntry that overrides the metadata comparison function.

Methods

Attributes

__init__(prop_name: str, display_group: str, metadata, property_type, build_fn=None, display_group_collapsed: bool = False, prim_paths: Optional[List[Path]] = None)

Constructor.

Parameters

  • prop_name – name of the Usd Property. This is not the display name.

  • display_group – group of the Usd Property when displayed on UI.

  • metadata – metadata associated with the Usd Property.

  • property_type – type of the property. Either Usd.Property or Usd.Relationship.

  • build_fn – a custom build function to build the UI. If not None the default builder will not be used.

  • display_group_collapsed – if the display group should be collapsed. Group only collapses when ALL its contents request such.

  • prim_paths – to override what prim paths this property will be built upon. Leave it to None to use default (currently selected paths, or last selected path if multi-edit is off).