omni.kit.usd.layers

Classes Summary:

AbstractLayerCommand

Abstract base class for layer commands.

AutoAuthoring

(Experimental) USD supports switching edit targets so that all authoring will take place in that specified layer. When it’s working

CreateLayerReferenceCommand

Create reference in specific layer.

CreateSublayerCommand

Creates or inserts a sublayer.

Extension

Extension Class.

FlattenLayersCommand

Flatten Layers.

LayerEditMode

Layer edit mode.

LayerErrorType

Layer error type.

LayerEventPayload

LayerEventPayload is a wrapper to carb.events.IEvent sent from module omni.kit.usd.layers.

LayerEventType

Layer event types.

LayerUtils

LayerUtils provides utilities for operating layers.

Layers

Layers is the Python container of ILayersInstance, through which you can access all interfaces. For each UsdContext,

LayersState

LinkSpecsCommand

Links spec paths to layers.

LiveSession

Python instance of ILayersInstance for the convenience of accessing

LiveSessionUser

LiveSessionUser represents an peer client instance that joins

LiveSyncing

Live Syncing includes the interfaces to management Live Sessions of all layers in the bound UsdContext.

LockLayerCommand

Sets lock state for layer.

LockSpecsCommand

Locks spec paths in the UsdContext.

MergeLayersCommand

Merges two layers.

MovePrimSpecsToLayerCommand

Merge prim spec from src layer to dst layer and remove it from src layer.

MoveSublayerCommand

Moves sublayer from one location to the other.

RemovePrimSpecCommand

Removes prim spec from a layer.

RemoveSublayerCommand

Removes a sublayer from parent layer.

ReplaceSublayerCommand

Replaces sublayer with a new layer.

SetEditTargetCommand

Sets layer as Edit Target.

SetLayerMutenessCommand

Sets mute state for layer.

SpecsLinking

SpecsLocking

StitchPrimSpecsToLayer

Flatten specific prims in the stage. It will remove original prim specs after flatten.

UnlinkSpecsCommand

Unlinks spec paths to layers.

UnlockSpecsCommand

Unlocks spec paths in the UsdContext

Functions Summary:

active_authoring_layer_context

Gets the edit context for edit target if it’s in non-auto authoring mode,

get_all_locked_specs

get_all_spec_links

get_auto_authoring

Gets the Auto Authoring interface from Layers instance bound to the specified UsdContext.

get_last_error_string

Gets the error string of the API call bound to specified UsdContext.

get_last_error_type

Gets the error status of the API call bound to specified UsdContext. Any API calls to Layers interface will change

get_layer_event_payload

Gets the payload of layer events by populating them into an instance of LayerEventPayload.

get_layers

Gets Layers instance bound to the context. For each UsdContext, it has unique Layers instance,

get_layers_state

Gets the Layers State interface from Layers instance bound to the specified UsdContext.

get_live_session_name_from_shared_link

Gets the name of Live Session from the url.

get_live_syncing

Gets the Live Syncing interface from Layers instance bound to the specified UsdContext.

get_short_user_name

Gets short name with capitalized first letters of each word.

get_spec_layer_links

get_spec_links_for_layers

is_spec_linked

is_spec_locked

link_specs

lock_specs

unlink_all_specs

unlink_specs

unlink_specs_from_all_layers

unlink_specs_to_layers

unlock_all_specs

unlock_specs