USDKit · IOS API REFERENCE

USDPrim.Attribute

struct · iOS 27.0+ · SDK 27.1

struct Attribute

Members (19)

get · iOS 27.0+

connections

TypeScript

get connections(): Array<USDLayer_Path>

Swift declaration

var connections: [USDLayer.Path] { get nonmutating set }

The connection target paths authored on this attribute.

set · iOS 27.0+

connections

TypeScript

set connections(value: Array<USDLayer_Path>)

Swift declaration

var connections: [USDLayer.Path] { get nonmutating set }

The connection target paths authored on this attribute.

get · iOS 27.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

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

get · iOS 27.0+

timeSamples

TypeScript

get timeSamples(): Array<USDStage_TimeCode>

Swift declaration

var timeSamples: [USDStage.TimeCode] { get }

The composed set of time codes for which this attribute has authored time samples.

get · iOS 27.0+

variability

TypeScript

get variability(): USDPrim_Property_Variability

Swift declaration

var variability: USDPrim.Property.Variability { get }

The variability of this attribute, which indicates whether its value can change over time.

get · iOS 27.0+

name

TypeScript

get name(): USDToken

Swift declaration

var name: USDToken { get }

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

get · iOS 27.0+

path

TypeScript

get path(): USDLayer_Path

Swift declaration

var path: USDLayer.Path { get }

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

get · iOS 27.0+

prim

TypeScript

get prim(): USDPrim

Swift declaration

var prim: USDPrim { get }

The nearest prim that contains this attribute.

method · iOS 27.0+

clear

TypeScript

clear(): boolean

Swift declaration

@discardableResult func clear() -> Bool

Clears the authored value of this attribute.

get · iOS 27.0+

stage

TypeScript

get stage(): USDStage

Swift declaration

var stage: USDStage { get }

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

method · iOS 27.0+

value

TypeScript

value(time?: USDStage_TimeCode): (number) | null

Swift declaration

func value<T>(at time: USDStage.TimeCode = .default) -> T? where T : USDPrim.Attribute.Value

Returns this attribute's value at the given time, or `nil` if unauthored.

get · iOS 27.0+

isValid

TypeScript

get isValid(): boolean

Swift declaration

var isValid: Bool { get }

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

get · iOS 27.0+

primPath

TypeScript

get primPath(): USDLayer_Path

Swift declaration

var primPath: USDLayer.Path { get }

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

get · iOS 27.0+

roleName

TypeScript

get roleName(): USDToken

Swift declaration

var roleName: USDToken { get }

The name of this attribute type's role, which clarifies the semantic purpose of its values.

method · iOS 27.0+

setValue

TypeScript

setValue(value: number, time?: USDStage_TimeCode): boolean

Swift declaration

@discardableResult func setValue<T>(_ value: T, at time: USDStage.TimeCode = .default) -> Bool where T : USDPrim.Attribute.Value

Sets this attribute's value at the given time.

get · iOS 27.0+

typeName

TypeScript

get typeName(): USDPrim_Attribute_ValueType

Swift declaration

var typeName: USDPrim.Attribute.ValueType { get }

The type of the values this attribute stores.

init · iOS 27.0+

init

TypeScript

static init(): USDPrim_Attribute

Swift declaration

init()

An invalid attribute handle.

init · iOS 27.0+

init

TypeScript

static init82640(object: USDStage_Object): (USDPrim_Attribute) | null

Swift declaration

init?(_ object: USDStage.Object)

Casts an object handle to an attribute handle. Returns `nil` if the object is not an attribute.

init · iOS 27.0+

init

TypeScript

static init98942(object: USDPrim_Property): (USDPrim_Attribute) | null

Swift declaration

init?(_ object: USDPrim.Property)

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

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →