Layers

class omni.kit.usd.layers.Layers(layers_instance, usd_context: UsdContext)

Bases: object

Layers is the Python container of ILayersInstance, through which you can access all interfaces. For each UsdContext, it has a separate Layers instance.

Methods

__init__(layers_instance, usd_context)
deliver_queued_events()	Delivers queued events.
get_auto_authoring()	Gets AutoAuthoring interface.
get_edit_mode()	Gets the current edit mode.
get_event_key()	Returns the event key filter for this instance.
get_event_stream()	Gets event stream of Layers instance.
get_last_error_string()	Gets the last error string.
get_last_error_type()	Gets the last error type.
get_layers_state()	Gets LayersState interface.
get_live_syncing()	Gets LiveSyncing interface.
get_specs_linking()	Gets SpecsLinking interface.
get_specs_locking()	Gets SpecsLocking interface.
send_event(event_name[, payload])	Dispatches an event for this layer
set_edit_mode(edit_mode)	Sets the current edit mode.

Attributes

usd_context

The UsdContext this instance is bound to.

__init__(

layers_instance,

usd_context: UsdContext,

) → None

deliver_queued_events()

Delivers queued events.

get_auto_authoring() → AutoAuthoring

Gets AutoAuthoring interface.

get_edit_mode() → LayerEditMode

Gets the current edit mode.

get_event_key()

Returns the event key filter for this instance.

get_event_stream()

Gets event stream of Layers instance.

get_last_error_string()

Gets the last error string.

get_last_error_type() → LayerErrorType

Gets the last error type.

get_layers_state() → LayersState

Gets LayersState interface.

get_live_syncing() → LiveSyncing

Gets LiveSyncing interface.

get_specs_linking() → SpecsLinking

Gets SpecsLinking interface.

get_specs_locking() → SpecsLocking

Gets SpecsLocking interface.

send_event(event_name: str, payload: dict = {})

Dispatches an event for this layer

set_edit_mode(

edit_mode: LayerEditMode,

)

Sets the current edit mode.

property usd_context: UsdContext

The UsdContext this instance is bound to.