One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

SkeletalPosesComponent

struct · iOS 18.0+ · SDK 27.1

struct SkeletalPosesComponent

A component that exposes the collection of named animation skeletal poses. Use the entity's skeletal poses to either read the pose evaluated from animations bound to ``BindTarget/jointTransforms`` and ``BindTarget/skeletalPose(_:)``, or write your own pose to animate the skeletal model. ### Setting updated value on an entity When an updated ``SkeletalPose`` is set on an entity as part of this component, these rules are followed: * If ``SkeletalPose/jointNames`` is reordered, following animation updated will match the new order. * If ``SkeletalPose/jointTransforms`` contains more elements than ``SkeletalPose/jointNames``, the extra transformations are ignored. * If ``SkeletalPose/jointTransforms`` contains less elements than ``SkeletalPose/jointNames``, the extra joint transformations are not updated. You can use ``poses``'s ``SkeletalPoseSet/default`` accessor for the same skeletal pose as exposed by ``HasModel/jointNames`` and ``HasModel/jointTransforms``. The access trough the component allows the reordering, addition and removal of joints from the default pose.

Members (3)

get · iOS 18.0+

poses

TypeScript
get poses(): SkeletalPoseSet
Swift declaration
var poses: SkeletalPoseSet

The collection of the skeletal poses for a single entity.

set · iOS 18.0+

poses

TypeScript
set poses(value: SkeletalPoseSet)
Swift declaration
var poses: SkeletalPoseSet

The collection of the skeletal poses for a single entity.

init · iOS 18.0+

init

TypeScript
static init(poses: Array<SkeletalPose>): SkeletalPosesComponent
Swift declaration
init(poses: [SkeletalPose])

Creates a component value with the provided poses. - Warning: When multiple poses share the same identifier, only the first one is accessible using its identifier. - Parameter poses: The pose values, arranged in any order of your choosing.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →