USDKit · IOS API REFERENCE

USDPrim.ReferenceCollection

struct · iOS 27.0+ · SDK 27.1

struct ReferenceCollection

Manages reference composition arcs on a prim.

Members (7)

method · iOS 27.0+

add

TypeScript

addToLayerOffsetPosition(primPath: USDLayer_Path, layerOffset?: USDLayer_TimeOffset, position?: USDPrim_ListPosition): void

Swift declaration

func add(to primPath: USDLayer.Path, layerOffset: USDLayer.TimeOffset = .init(), position: USDPrim.ListPosition = .backOfPrependList) throws

Adds an internal reference arc that targets a prim in the same layer stack. - Parameters: - primPath: The path of the target prim within the same layer stack. - layerOffset: Time offset and scale to apply during composition. - position: Where to insert the reference in the prim's reference list. - Throws: An error if the reference cannot be added.

method · iOS 27.0+

add

TypeScript

addToFromLayerOffsetPosition(primPath: (USDLayer_Path) | null, assetPath: string, layerOffset?: USDLayer_TimeOffset, position?: USDPrim_ListPosition): void

Swift declaration

func add(to primPath: USDLayer.Path?, from assetPath: String, layerOffset: USDLayer.TimeOffset = .init(), position: USDPrim.ListPosition = .backOfPrependList) throws

Adds an external reference arc. - Parameters: - primPath: The prim path within the target asset. Pass `nil` to target the asset's default prim. - assetPath: The asset path of the external layer to load. - layerOffset: Time offset and scale to apply during composition. - position: Where to insert the reference in the prim's reference list. - Throws: An error if the reference cannot be added.

method · iOS 27.0+

add

TypeScript

addPosition(reference: USDPrim_Reference, position?: USDPrim_ListPosition): void

Swift declaration

func add(_ reference: USDPrim.Reference, position: USDPrim.ListPosition = .backOfPrependList) throws

Adds an existing reference arc to the prim. - Parameters: - reference: The reference to add. - position: Where to insert the reference in the prim's reference list. - Throws: An error if the reference cannot be added.

method · iOS 27.0+

set

TypeScript

set(references: Array<USDPrim_Reference>): void

Swift declaration

func set(_ references: [USDPrim.Reference]) throws

Replaces all reference arcs with the specified list. - Parameter references: The new list of references. - Throws: An error if the references cannot be set.

get · iOS 27.0+

prim

TypeScript

get prim(): USDPrim

Swift declaration

var prim: USDPrim { get }

The prim that owns these reference arcs.

method · iOS 27.0+

clear

TypeScript

clear(): void

Swift declaration

func clear() throws

Removes all reference arcs from the prim. - Throws: An error if the references cannot be cleared.

method · iOS 27.0+

remove

TypeScript

remove(reference: USDPrim_Reference): void

Swift declaration

func remove(_ reference: USDPrim.Reference) throws

Removes a specific reference arc from the prim. - Parameter reference: The reference to remove. - Throws: An error if the reference cannot be removed.

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →