AttributeContextMenu#

class omni.kit.property.usd.AttributeContextMenu#

Bases: object

Attribute context menu.

Methods

`__init__`()	Initialize the attribute context menu.
`destroy`()	Destroy the attribute context menu.
`get_instance`()	Get the instance of the attribute context menu.
`get_registered_schemas`()	Get list of registered schema handlers.
`get_schema_registry`()	Get the schema registry instance.
`on_mouse_event`(event)	On mouse event.
`register_schema`(schema_registration)	Register a schema handler.
`register_schema_by_name`(schema_name[, ...])	Register a schema handler.
`unregister_schema`(schema_registration)	Unregister a schema handler.
`unregister_schema_by_name`(schema_name)	Unregister a schema handler.

classmethod get_instance()#: Get the instance of the attribute context menu.

classmethod get_registered_schemas()#

Get list of registered schema handlers.

classmethod get_schema_registry()#

Get the schema registry instance.

on_mouse_event( event: AttributeContextMenuEvent, )#

On mouse event.

classmethod register_schema( schema_registration: AttributeSchemaRegistration, )#

Register a schema handler.

Parameters:: schema_registration (AttributeSchemaRegistration) – Schema registration instance

classmethod register_schema_by_name( schema_name: str, can_apply: Callable = None, priority: int = 0, )#

Register a schema handler.

Parameters:

schema_name (str) – The name of the schema to register
can_apply (Callable) – custom can apply function
priority (int) – Priority for ordering in menus (higher = first, default = 0)

classmethod unregister_schema( schema_registration: AttributeSchemaRegistration, )#

Unregister a schema handler.

Parameters:: schema_registration (AttributeSchemaRegistration) – Schema registration instance

classmethod unregister_schema_by_name(schema_name: str)#

Unregister a schema handler.