One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

MeshResource.Skeleton.Joint

struct · iOS 18.0+ · SDK 27.1

struct Joint

A named joint in a ``Skeleton``.

Members (9)

get · iOS 18.0+

parentIndex

TypeScript
get parentIndex(): Promise<(number) | null>
Swift declaration
var parentIndex: Int?

The index of this joint's parent, or nil if this joint has no parent. If the joint has a parent, the index of the parent needs to be lower than that of the child.

set · iOS 18.0+

parentIndex

TypeScript
setParentIndex(value?: (number) | null): Promise<void>
Swift declaration
var parentIndex: Int?

The index of this joint's parent, or nil if this joint has no parent. If the joint has a parent, the index of the parent needs to be lower than that of the child.

get · iOS 18.0+

restPoseTransform

TypeScript
get restPoseTransform(): Promise<Transform>
Swift declaration
var restPoseTransform: Transform

The local transform of this joint in skeleton's rest pose, specified relative to this joint's parent (or relative to model space, if this joint has no parent). The rest pose of a skeleton is used when a joint is not otherwise animated.

set · iOS 18.0+

restPoseTransform

TypeScript
setRestPoseTransform(value: Transform): Promise<void>
Swift declaration
var restPoseTransform: Transform

The local transform of this joint in skeleton's rest pose, specified relative to this joint's parent (or relative to model space, if this joint has no parent). The rest pose of a skeleton is used when a joint is not otherwise animated.

get · iOS 18.0+

inverseBindPoseMatrix

TypeScript
get inverseBindPoseMatrix(): Promise<SDKHandle>
Swift declaration
var inverseBindPoseMatrix: simd_float4x4

A matrix which transforms from the authored pose (the "bind pose") of the bound model to the local space of this joint. > Note: The bind pose matrix transforms a vertex from a joint's local coordinate space to the position of that vertex in the model's bind pose. This property is the _inverse_ bind pose matrix, so it transforms a vertex from its position in the model's bind pose to the local coordinate space of this joint.

set · iOS 18.0+

inverseBindPoseMatrix

TypeScript
setInverseBindPoseMatrix(value: SDKHandle): Promise<void>
Swift declaration
var inverseBindPoseMatrix: simd_float4x4

A matrix which transforms from the authored pose (the "bind pose") of the bound model to the local space of this joint. > Note: The bind pose matrix transforms a vertex from a joint's local coordinate space to the position of that vertex in the model's bind pose. This property is the _inverse_ bind pose matrix, so it transforms a vertex from its position in the model's bind pose to the local coordinate space of this joint.

init · iOS 18.0+

init

TypeScript
static init(name: string, parentIndex: (number) | null, inverseBindPoseMatrix: SDKHandle, restPoseTransform: Transform): Promise<MeshResource_Skeleton_Joint>
Swift declaration
init(name: String, parentIndex: Int?, inverseBindPoseMatrix: simd_float4x4, restPoseTransform: Transform)

Creates a single joint in a skeleton.

get · iOS 18.0+

name

TypeScript
get name(): Promise<string>
Swift declaration
var name: String

The name of this joint. Each joint needs to have a unique name within its skeleton.

set · iOS 18.0+

name

TypeScript
setName(value: string): Promise<void>
Swift declaration
var name: String

The name of this joint. Each joint needs to have a unique name within its skeleton.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →