Adds an internal payload 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 payload in the prim's payload list.
- Throws: An error if the payload cannot be added.
Adds an external payload 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 payload in the prim's payload list.
- Throws: An error if the payload cannot be added.
Adds an existing payload arc to the prim.
- Parameters:
- payload: The payload to add.
- position: Where to insert the payload in the prim's payload list.
- Throws: An error if the payload cannot be added.
method · iOS 27.0+
set
TypeScript
set(payloads: Array<USDPrim_Payload>): void
Swift declaration
func set(_ payloads: [USDPrim.Payload]) throws
Replaces all payload arcs with the specified list.
- Parameter payloads: The new list of payloads.
- Throws: An error if the payloads cannot be set.
get · iOS 27.0+
prim
TypeScript
get prim(): USDPrim
Swift declaration
var prim: USDPrim { get }
The prim that owns these payload arcs.
method · iOS 27.0+
clear
TypeScript
clear(): void
Swift declaration
func clear() throws
Removes all payload arcs from the prim.
- Throws: An error if the payloads cannot be cleared.
method · iOS 27.0+
remove
TypeScript
remove(payload: USDPrim_Payload): void
Swift declaration
func remove(_ payload: USDPrim.Payload) throws
Removes a specific payload arc from the prim.
- Parameter payload: The payload to remove.
- Throws: An error if the payload cannot be removed.
