One Logo Pool Ball
USDKit · IOS API REFERENCE

USDPrim.VariantSetSpec

struct · iOS 27.0+ · SDK 27.1

struct VariantSetSpec

A handle to a variant set — a named group of variant options.

Members (8)

method · iOS 27.0+

removeVariant

TypeScript
removeVariant(variant: USDPrim_VariantSpec): void
Swift declaration
func removeVariant(_ variant: USDPrim.VariantSpec)

Removes the given variant spec from this set. - Parameter variant: The variant spec to remove.

get · iOS 27.0+

name

TypeScript
get name(): USDToken
Swift declaration
var name: USDToken { get }

The variant set's local name.

init · iOS 27.0+

init

TypeScript
static initOwnerName(owner: USDPrim_Spec, name: USDToken): (USDPrim_VariantSetSpec) | null
Swift declaration
init?(owner: USDPrim.Spec, name: USDToken)

Creates a new variant set spec under the given prim spec. - Parameters: - owner: The prim spec that owns the new variant set. - name: The variant set's name.

init · iOS 27.0+

init

TypeScript
static initOwnerName47189(owner: USDPrim_VariantSpec, name: USDToken): (USDPrim_VariantSetSpec) | null
Swift declaration
init?(owner: USDPrim.VariantSpec, name: USDToken)

Creates a new variant set spec nested inside a variant spec. - Parameters: - owner: The variant spec that owns the new (nested) variant set. - name: The variant set's name.

get · iOS 27.0+

owner

TypeScript
get owner(): (USDLayer_Spec) | null
Swift declaration
var owner: USDLayer.Spec? { get }

The owning spec — a prim spec or variant spec.

get · iOS 27.0+

variants

TypeScript
get variants(): Array<USDPrim_VariantSpec>
Swift declaration
var variants: [USDPrim.VariantSpec] { get }

All variant specs in this set.

init · iOS 27.0+

init

TypeScript
static init(): USDPrim_VariantSetSpec
Swift declaration
init()

Creates an empty (invalid) variant set spec handle.

init · iOS 27.0+

init

TypeScript
static init11999(spec: USDLayer_Spec): (USDPrim_VariantSetSpec) | null
Swift declaration
init?(_ spec: USDLayer.Spec)

Narrows an untyped ``USDLayer/Spec`` to a variant set spec. - Parameter spec: The spec to narrow. - Returns: A variant set spec, or `nil` if `spec` is not a variant set spec.

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →