RealityFoundation · IOS API REFERENCE

SkeletalPoseSet

struct · iOS 18.0+ · SDK 27.1

struct SkeletalPoseSet

A collection of named skeletal poses.

Members (14)

get · iOS 18.0+

startIndex

TypeScript

get startIndex(): number

Swift declaration

var startIndex: SkeletalPoseSet.Index { get }

The index of the first pose in a nonempty set.

method · iOS 18.0+

makeIterator

TypeScript

makeIterator(): SkeletalPoseSet_Iterator

Swift declaration

func makeIterator() -> SkeletalPoseSet.Iterator

Returns an iterator over the elements of this sequence.

method · iOS 18.0+

set

TypeScript

set(newValue: SkeletalPose): (SkeletalPose) | null

Swift declaration

@discardableResult mutating func set(_ newValue: SkeletalPoseSet.Element) -> SkeletalPoseSet.Element?

Updates a pose in the set based on its name. If pose with this ID does not exist, does nothing. - Parameter newValue: The pose to store. - Returns: The previous pose value, if named pose exists

get · iOS 18.0+

count

TypeScript

get count(): number

Swift declaration

var count: Int { get }

The number of elements in the collection.

method · iOS 18.0+

index

TypeScript

indexOf(poseID: string): (number) | null

Swift declaration

func index(of poseID: SkeletalPose.ID) -> SkeletalPoseSet.Index?

Returns the index where the specified pose appears in the collection.

method · iOS 18.0+

index

TypeScript

indexAfter(after: number): number

Swift declaration

func index(after: SkeletalPoseSet.Index) -> SkeletalPoseSet.Index

Returns the index after the given index.

get · iOS 18.0+

default

TypeScript

get default(): (SkeletalPose) | null

Swift declaration

var `default`: SkeletalPoseSet.Element? { get set }

Accesses the first skeletal pose. Equivalent to accessing ``HasModel/jointNames`` and ``HasModel/jointTransforms`` if used from an entity with a skeletal model.

set · iOS 18.0+

default

TypeScript

set default(value: (SkeletalPose) | null)

Swift declaration

var `default`: SkeletalPoseSet.Element? { get set }

Accesses the first skeletal pose. Equivalent to accessing ``HasModel/jointNames`` and ``HasModel/jointTransforms`` if used from an entity with a skeletal model.

get · iOS 18.0+

isEmpty

TypeScript

get isEmpty(): boolean

Swift declaration

var isEmpty: Bool { get }

A Boolean value indicating whether the collection is empty.

method · iOS 18.0+

contains

TypeScript

contains(poseID: string): boolean

Swift declaration

func contains(_ poseID: SkeletalPose.ID) -> Bool

Checks if the set contains a pose with the given name. - Parameter poseID: The name of the pose to look up - Returns: `true` a pose with matching name is contained in the set.

get · iOS 18.0+

endIndex

TypeScript

get endIndex(): number

Swift declaration

var endIndex: SkeletalPoseSet.Index { get }

The index of the last pose in a nonempty set.

init · iOS 18.0+

init

TypeScript

static init(): SkeletalPoseSet

Swift declaration

init()

Creates an empty collection.

subscript · iOS 18.0+

subscript

TypeScript

subscript(poseID: string): (SkeletalPose) | null

Swift declaration

subscript(poseID: SkeletalPose.ID) -> SkeletalPoseSet.Element? { get set }

Accesses the element with the specified identifier. If multiple poses share the same identifier, only the one with lowest index is accessed. The update only has an effect if all of the following conditions are true: * A pose with the provided identifier exists in the collection. * The new value isn't `nil`. * The pose with the provided identifier contains the same number of elements for its ``SkeletalPose/jointTransforms``. - Parameter poseID: The identifier of the requested pose.

subscript · iOS 18.0+

subscript

TypeScript

subscript3367(index: number): SkeletalPose

Swift declaration

subscript(index: SkeletalPoseSet.Index) -> SkeletalPoseSet.Element { get set }

Accesses the pose at the specified index.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →