USDKit · IOS API REFERENCE

USDPrim.SpecializeCollection

struct · iOS 27.0+ · SDK 27.1

struct SpecializeCollection

Manages specializes composition arcs on a prim. Specialization is similar to inheritance but with different composition strength. Specialized opinions are weaker than direct opinions but stronger than inherited opinions. Use `USDPrim.SpecializeCollection` to add, remove, and query specializes arcs on a prim.

Members (5)

method · iOS 27.0+

add

TypeScript

add(primPath: USDLayer_Path, position?: USDPrim_ListPosition): void

Swift declaration

func add(_ primPath: USDLayer.Path, position: USDPrim.ListPosition = .backOfPrependList) throws

Adds a specializes arc to the prim. - Parameters: - primPath: The path of the prim to specialize. - position: Where to insert the specializes in the prim's specializes list. - Throws: An error if the specializes cannot be added.

method · iOS 27.0+

set

TypeScript

set(primPaths: Array<USDLayer_Path>): void

Swift declaration

func set(_ primPaths: [USDLayer.Path]) throws

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

get · iOS 27.0+

prim

TypeScript

get prim(): USDPrim

Swift declaration

var prim: USDPrim { get }

The prim that owns these specializes arcs.

method · iOS 27.0+

clear

TypeScript

clear(): void

Swift declaration

func clear() throws

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

method · iOS 27.0+

remove

TypeScript

remove(primPath: USDLayer_Path): void

Swift declaration

func remove(_ primPath: USDLayer.Path) throws

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

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →