USDStage.Object

description

get description(): string

var description: String { get }

A summary description of this object. This property is safe to access on an invalid or expired object.

name

get name(): USDToken

var name: USDToken { get }

The name of this scene graph object. An object's name is the last component of its ``path``. This property is equivalent to the ``USDLayer.Path/name`` property of that path.

path

get path(): USDLayer_Path

var path: USDLayer.Path { get }

The complete scene path to this object, relative to its stage.

prim

get prim(): USDPrim

var prim: USDPrim { get }

The nearest prim that contains this object. If this object is a ``USDPrim``, the value of this property is that same prim. If this object is a ``USDPrim/Attribute`` or a ``USDPrim/Relationship``, the value of this property is the nearest prim that contains this object.

stage

get stage(): USDStage

var stage: USDStage { get }

The stage that owns this object. An object's state and validity is connected to its stage. An object becomes invalid when the lifetime of its stage ends. It can also become invalid when the stage is modified.

isValid

get isValid(): boolean

var isValid: Bool { get }

A Boolean value indicating whether this object is valid. An object's validity is connected to a ``USDStage``. An object becomes invalid when the lifetime of its stage ends. An object will also expire if its stage no longer defines a value for the object. `isValid` is false if this object has expired.

primPath

get primPath(): USDLayer_Path

var primPath: USDLayer.Path { get }

The complete path to this prim, or to the nearest prim that contains this object. If this object is a ``USDPrim``, `primPath` is the same as ``path``. If this object is a ``USDPrim/Attribute`` or a ``USDPrim/Relationship``, `primPath` is the complete scene path of the object's ``prim``.

init

static init(): USDStage_Object

init()

An invalid object handle.

init

static init32719(relationship: USDPrim_Relationship): USDStage_Object

init(_ relationship: USDPrim.Relationship)

init

static init86659(property: USDPrim_Property): USDStage_Object

init(_ property: USDPrim.Property)

Casts a property handle to an object handle.

init

static init34475(attribute: USDPrim_Attribute): USDStage_Object

init(_ attribute: USDPrim.Attribute)

Casts an attribute handle to an object handle.

init

static init67664(prim: USDPrim): USDStage_Object

init(_ prim: USDPrim)