AutoAuthoring#

class omni.kit.usd.layers.AutoAuthoring(
layers_instance: ILayersInstance,
usd_context,
)#

Bases: object

(Experimental) USD supports switching edit targets so that all authoring will take place in that specified layer. When it’s working with multiple sublayers, this kind of freedom may cause experience issues. The user has to be aware the changes made are not overridden in any stronger layer. We extend a new mode called Auto Authoring to improve it. In this mode, all changes will firstly go into a middle delegate layer and it will then distribute edits (per frame) into their corresponding layers where the edits have the strongest opinions. So it cannot switch edit targets freely, and users do not need to be aware of the existence of multi-sublayers and how USD will compose the changes.

Methods

__init__(layers_instance, usd_context)

get_default_layer()

Gets the default layer.

is_auto_authoring_layer(layer_identifier)

Checks if a layer is an auto authoring layer.

is_enabled()

Checks if UsdContext is in Auto Authoring mode.

set_default_layer(layer_identifier)

Sets the default layer to receive the newly created opinions.

Attributes

usd_context

__init__(
layers_instance: ILayersInstance,
usd_context,
) None#
get_default_layer() str#

Gets the default layer.

is_auto_authoring_layer(layer_identifier: str) bool#

Checks if a layer is an auto authoring layer.

is_enabled() bool#

Checks if UsdContext is in Auto Authoring mode.

set_default_layer(layer_identifier: str)#

Sets the default layer to receive the newly created opinions.