USDPrim.Property

isAuthored

get isAuthored(): boolean

var isAuthored: Bool { get }

A Boolean value that indicates whether this property has any authored opinions.

description

get description(): string

var description: String { get }

A summary description of this property.

name

get name(): USDToken

var name: USDToken { get }

The name of this property. A property's name is the last component of its ``path``. `name` is equivalent to the ``USDLayer.Path/name`` of that path.

path

get path(): USDLayer_Path

var path: USDLayer.Path { get }

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

prim

get prim(): USDPrim

var prim: USDPrim { get }

The nearest prim that contains this property.

stage

get stage(): USDStage

var stage: USDStage { get }

The stage that owns this property. A property's state and validity is connected to its stage. A property 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 property is valid. A property's validity is connected to a ``USDStage``. A property becomes invalid when the lifetime of its stage ends. A property will also expire if its stage no longer defines a value for the property. `isValid` is false if this property has expired.

baseName

get baseName(): USDToken

var baseName: USDToken { get }

The name of this property without its namespace prefix.

isCustom

get isCustom(): boolean

var isCustom: Bool { get nonmutating set }

A Boolean value that indicates whether this property is a custom property not defined by a schema.

isCustom

set isCustom(value: boolean)

var isCustom: Bool { get nonmutating set }

A Boolean value that indicates whether this property is a custom property not defined by a schema.

primPath

get primPath(): USDLayer_Path

var primPath: USDLayer.Path { get }

The complete path to the nearest prim that contains this property. `primPath` is the ``USDPrim/path`` of this property's ``prim``.

isDefined

get isDefined(): boolean

var isDefined: Bool { get }

A Boolean value that indicates whether this property has a defining specification on the stage.

namespace

get namespace(): USDToken

var namespace: USDToken { get }

The namespace prefix of this property's name, or an empty token if it has none.

init

static init(): USDPrim_Property

init()

An invalid property handle.

init

static init63742(object: USDStage_Object): (USDPrim_Property) | null

init?(_ object: USDStage.Object)

Casts an object handle to a property handle. Returns `nil` if the object is not an attribute or a relationship.

init

static init17027(relationship: USDPrim_Relationship): USDPrim_Property

init(_ relationship: USDPrim.Relationship)

init

static init8511(object: USDPrim_Attribute): USDPrim_Property

init(_ object: USDPrim.Attribute)

Casts an attribute handle to a property handle.