UsdPropertyUiEntry#

class omni.kit.property.usd.UsdPropertyUiEntry(
prop_name: str,
display_group: str,
metadata,
property_type,
build_fn=None,
display_group_collapsed: bool = False,
prim_paths: List[Path] = None,
)#

Bases: object

A class to represent a USD property UI entry.

Methods

__init__(prop_name, display_group, metadata, ...)

Constructor.

add_custom_metadata(key, value)

If value is not None, add it to the custom data of the metadata using the specified key.

get_nested_display_groups()

Get the nested display groups of the property.

override_display_group(display_group[, ...])

Overrides the display group of the property.

override_display_name(display_name)

Overrides the display name of the property.

override_doc_string(doc_string)

Overrides the doc string of the property, which is used for tooltips.

Attributes

attr_name

Get the attribute name of the property.
__init__(
prop_name: str,
display_group: str,
metadata,
property_type,
build_fn=None,
display_group_collapsed: bool = False,
prim_paths: 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).

add_custom_metadata(key: str, value)#

If value is not None, add it to the custom data of the metadata using the specified key. Otherwise, remove that key from the custom data.

Parameters:

  • key – the key that should contain the custom metadata value

  • value – the value that should be added to the custom metadata if not None

get_nested_display_groups()#

Get the nested display groups of the property.

Returns:

the nested display groups

Return type:

list

override_display_group(
display_group: str,
collapsed: bool = False,
)#

Overrides the display group of the property. It only affects UI and DOES NOT write back DisplayGroup metadata to USD.

Parameters:

  • display_group – new display group to override to.

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

override_display_name(display_name: str)#

Overrides the display name of the property. It only affects UI and DOES NOT write back DisplayName metadata to USD.

Parameters:

display_group – new display group to override to.

override_doc_string(doc_string: str)#

Overrides the doc string of the property, which is used for tooltips. It only affects UI and DOES NOT write back Documentation metadata to USD.

Parameters:

doc_string – new doc string

property attr_name#

Get the attribute name of the property.