USDKit · IOS API REFERENCE

USDPrim.Reference

struct · iOS 27.0+ · SDK 27.1

struct Reference

A reference to an external layer or asset. References are composition arcs that bring content from another layer into this prim. A reference specifies the asset path, an optional target prim path within that asset, a time offset for remapping animation, and arbitrary custom metadata.

Members (11)

get · iOS 27.0+

customData

TypeScript

get customData(): Record<string, USDValue>

Swift declaration

var customData: Dictionary<String, USDValue> { get set }

Custom metadata authored alongside the reference.

set · iOS 27.0+

customData

TypeScript

set customData(value: Record<string, USDValue>)

Swift declaration

var customData: Dictionary<String, USDValue> { get set }

Custom metadata authored alongside the reference.

get · iOS 27.0+

isInternal

TypeScript

get isInternal(): boolean

Swift declaration

var isInternal: Bool { get }

Whether this is an internal reference (empty asset path).

get · iOS 27.0+

layerOffset

TypeScript

get layerOffset(): USDLayer_TimeOffset

Swift declaration

var layerOffset: USDLayer.TimeOffset { get set }

Time-axis remap applied to the reference's animation.

set · iOS 27.0+

layerOffset

TypeScript

set layerOffset(value: USDLayer_TimeOffset)

Swift declaration

var layerOffset: USDLayer.TimeOffset { get set }

Time-axis remap applied to the reference's animation.

method · iOS 27.0+

setCustomData

TypeScript

setCustomData(key: string, value: USDValue): void

Swift declaration

mutating func setCustomData(_ key: String, to value: USDValue)

Sets `key` in `customData` to `value`. - Parameters: - key: The dictionary key. - value: The new value.

get · iOS 27.0+

primPath

TypeScript

get primPath(): (USDLayer_Path) | null

Swift declaration

var primPath: USDLayer.Path? { get set }

The target prim path within the referenced asset, or `nil` to use the asset's default prim.

set · iOS 27.0+

primPath

TypeScript

set primPath(value: (USDLayer_Path) | null)

Swift declaration

var primPath: USDLayer.Path? { get set }

The target prim path within the referenced asset, or `nil` to use the asset's default prim.

init · iOS 27.0+

init

TypeScript

static init(assetPath?: (string) | null, primPath?: (USDLayer_Path) | null, layerOffset?: USDLayer_TimeOffset, customData?: Record<string, USDValue>): USDPrim_Reference

Swift declaration

init(assetPath: String? = nil, primPath: USDLayer.Path? = nil, layerOffset: USDLayer.TimeOffset = USDLayer.TimeOffset(), customData: Dictionary<String, USDValue> = [:])

Creates a reference. - Parameters: - assetPath: The asset path to target. Pass `nil` for an internal reference (pointing within the same layer stack). - primPath: The prim path within the referenced asset. Pass `nil` to use the asset's default prim. - layerOffset: The time transformation applied during composition. - customData: Custom data dictionary attached to the reference.

get · iOS 27.0+

assetPath

TypeScript

get assetPath(): (string) | null

Swift declaration

var assetPath: String? { get set }

The asset path the reference targets, or `nil` for an internal reference.

set · iOS 27.0+

assetPath

TypeScript

set assetPath(value: (string) | null)

Swift declaration

var assetPath: String? { get set }

The asset path the reference targets, or `nil` for an internal reference.

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →