USDKit · IOS API REFERENCE

USDPrim.Relationship

struct · iOS 27.0+ · SDK 27.1

struct Relationship

A property that connects a prim to one or more other objects in the stage by their paths.

Members (12)

get · iOS 27.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

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

get · iOS 27.0+

name

TypeScript

get name(): USDToken

Swift declaration

var name: USDToken { get }

The name of this relationship. A relationship'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 relationship, 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 relationship.

get · iOS 27.0+

stage

TypeScript

get stage(): USDStage

Swift declaration

var stage: USDStage { get }

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

get · iOS 27.0+

isValid

TypeScript

get isValid(): boolean

Swift declaration

var isValid: Bool { get }

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

get · iOS 27.0+

targets

TypeScript

get targets(): Array<USDLayer_Path>

Swift declaration

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

The target paths authored on this relationship.

set · iOS 27.0+

targets

TypeScript

set targets(value: Array<USDLayer_Path>)

Swift declaration

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

The target paths authored on this relationship.

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 relationship. `primPath` is the ``USDPrim/path`` of this relationship's ``prim``.

init · iOS 27.0+

init

TypeScript

static init(): USDPrim_Relationship

Swift declaration

init()

An invalid relationship handle.

init · iOS 27.0+

init

TypeScript

static init16044(object: USDStage_Object): (USDPrim_Relationship) | null

Swift declaration

init?(_ object: USDStage.Object)

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

init · iOS 27.0+

init

TypeScript

static init38946(object: USDPrim_Property): (USDPrim_Relationship) | null

Swift declaration

init?(_ object: USDPrim.Property)

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

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →