omni.usd.commands

Classes Summary:

AddPayloadCommand

Add a payload to primitive.

AddReferenceCommand

Add reference to primitive.

AddRelationshipTargetCommand

Add target to a relationship.

BindMaterialCommand

Bind material to a primitive.

ChangeAttributesColorSpaceCommand

Change attribute color space.

ChangeMetadataCommand

Modify metadata of multiple objects.

ChangeMetadataInPrimsCommand

Deprecated. Modifies metadata of multiple primitives.

ChangePropertyCommand

Change property value.

ClearCurvesSplitsOverridesCommand

Clear Curves Splits Overrides.

ClearRefinementOverridesCommand

Clear Refinement Overrides.

CopyPrimCommand

Copy a primitive to a new path.

CopyPrimsCommand

Copy multiple primitives to new paths.

CreateAudioPrimFromAssetPathCommand

Create a new Audio primitive from asset path.

CreateDefaultXformOnPrimCommand

Create default xformOp on prim.

CreateInstanceCommand

Instance a primitive.

CreateInstancesCommand

Instance multiple primitives.

CreateMdlMaterialPrimCommand

Create a MDL Material.

CreateMtlxMaterialPrimCommand

Create a MaterialX material.

CreatePayloadCommand

Create a new prim with payload.

CreatePreviewSurfaceMaterialPrimCommand

Create a USD Preview Surface Material.

CreatePreviewSurfaceTextureMaterialPrimCommand

Create a USD Preview Surface Texture Material.

CreatePrimCommand

Create a primitive to stage. It is the same as :class:`.CreatePrimWithDefaultXformCommand` and kept for backward compatibility.

CreatePrimCommandBase

Base class to create a prim (and remove when undo).

CreatePrimWithDefaultXformCommand

Create a primitive to stage.

CreatePrimsCommand

Create multiple primitives.

CreateReferenceCommand

Create a new prim with reference.

CreateShaderPrimFromSdrCommand

Load the shader specified by ‘identifier’ from the SDR registry and create a shader prim under

CreateUsdAttributeCommand

Creates a USD Attribute for a primitive.

CreateUsdAttributeOnPathCommand

Creates a USD Attribute with attribute path.

DeletePrimsCommand

Delete primitives from stage.

FramePrimsCommand

Transform camera to encompass the bounds of a list of paths.

GroupPrimsCommand

Group primitives to the same parent.

MovePrimCommand

Moves a primitive to a new path.

MovePrimsCommand

Move a list of primitives to new locations.

ParentPrimsCommand

Moves prims into children of “parent” primitives.

PayloadCommandBase

Base class for payload related commands.

ReferenceCommandBase

Base class for reference related commands.

RelationshipTargetBase

Base class of relationship related commands.

RemovePayloadCommand

Remove specified payload from primitive.

RemovePropertyCommand

Remove property.

RemoveReferenceCommand

Remove specified reference from primitive.

RemoveRelationshipTargetCommand

Remove target from a relationship.

RenamePrimCommand

Rename a primitive undoable **Command**.

ReplacePayloadCommand

Replace the specified reference with a new one.

ReplaceReferenceCommand

Replace the specified reference with a new one.

ReplaceReferencesCommand

Deprecated. Clears/Adds references.

SelectPrimsCommand

Select primitives.

SetMaterialStrengthCommand

Set material binding strength.

SetPayLoadLoadSelectedPrimsCommand

Set the loaded/unloaded payloads of the selected primitives.

SetRelationshipTargetsCommand

Set target(s) to a relationship.

ToggleActivePrimsCommand

Toggle the active state of prims.

TogglePayLoadLoadSelectedPrimsCommand

Toggles the loaded/unloaded payloads of the selected primitives.

ToggleVisibilitySelectedPrimsCommand

Toggles the visiblity of the selected primitives.

TransformPrimCommand

Set primitive’s local transform.

TransformPrimSRTCommand

Set primitive’s local transform with scale, rotation and transform values.

TransformPrimsCommand

Set local transforms for multiple primitives.

TransformPrimsSRTCommand

Set local transforms of multiple primitives with scale, rotation and transform values.

UngroupPrimsCommand

Ungroup primitives from the parent.

UnhideAllPrimsCommand

Unhide all primitives in the default UsdContext.

UnparentPrimsCommand

Moves prims into root “/” primitive.

UsdStageHelper

Keeps the stage ID or returns the stage from the current context

Functions Summary:

active_edit_context

Internal. Utility to return active edit context.

ensure_parents_are_active

Internal. It will ensure parents are active. If they are not, it will change the active

get_default_camera_rotation_order_str

Internal. Gets default camera rotation order from setting /persistent/app/primCreation/DefaultCameraRotationOrder.

get_default_rotation_order_str

Internal. Gets default rotation order from setting /persistent/app/primCreation/DefaultRotationOrder.

get_default_rotation_order_type

Internal. Gets default rotation order.

post_notification

Internal. Posts notification if omni.kit.notification_manager is enabled.

prim_can_be_removed_without_destruction

Internal. A destructive remove is one that will not only edit current edit target, but also other non-anonymous layers. Why anonymous layers is not counted is because anonymous layers are writable in Kit, and it’s only existed when it’s a new stage or under session layer. Any deltas inside those anonymous layers can be safely removed. Otherwise, this function will return false, which means it will not remove prim specs in all layers, but deactivates them to avoid editing non-anonymous layers except current edit target.

remove_prim_spec

Internal. Removes prim spec from layer.

write_refinement_override_enabled_hint

Internal. If the user authors refinementEnableOverride, drop a hint in customLayerData