USDKit · IOS API REFERENCE

USDPrim.InheritCollection

struct · iOS 27.0+ · SDK 27.1

struct InheritCollection

Manages inherit composition arcs on a prim. Inheritance allows a prim to inherit opinions from another prim within the same layer stack, similar to class inheritance in object-oriented programming. Use `USDPrim.InheritCollection` to add, remove, and query inherit arcs on a prim.

Members (6)

get · iOS 27.0+

inheritedPaths

TypeScript

get inheritedPaths(): Array<USDLayer_Path>

Swift declaration

var inheritedPaths: [USDLayer.Path] { get }

All paths this prim inherits from, including paths inherited transitively through inherited classes.

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 an inherit arc to the prim. - Parameters: - primPath: The path of the prim to inherit from. - position: Where to insert the inherit in the prim's inherit list. - Throws: An error if the inherit 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 inherit arcs with the specified list. - Parameter primPaths: The new list of inherit paths. - Throws: An error if the inherits cannot be set.

get · iOS 27.0+

prim

TypeScript

get prim(): USDPrim

Swift declaration

var prim: USDPrim { get }

The prim that owns these inherit arcs.

method · iOS 27.0+

clear

TypeScript

clear(): void

Swift declaration

func clear() throws

Removes all inherit arcs from the prim. - Throws: An error if the inherits 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 inherit arc from the prim. - Parameter primPath: The path of the inherit to remove. - Throws: An error if the inherit cannot be removed.

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →