RealityFoundation · IOS API REFERENCE

IKComponent.Joint

class · iOS 18.0+ · SDK 27.1

class Joint

The update stage object that lets you read and update the current settings of a single joint in an IK solver. The settings this object exposes are the runtime editable values of a solver joint. Initial values are set in ``IKRig/Joint``.

Members (6)

get · iOS 18.0+

fkWeightPerAxis

TypeScript

get fkWeightPerAxis(): SDKHandle

Swift declaration

var fkWeightPerAxis: SIMD3<Float> { get set }

The per-axis weight of the source animation demand on the joint. This value is in the closed range `[0, 1]`, where `0` means no influence, and `1` is the maximum influence.

set · iOS 18.0+

fkWeightPerAxis

TypeScript

set fkWeightPerAxis(value: SDKHandle)

Swift declaration

var fkWeightPerAxis: SIMD3<Float> { get set }

The per-axis weight of the source animation demand on the joint. This value is in the closed range `[0, 1]`, where `0` means no influence, and `1` is the maximum influence.

get · iOS 18.0+

rotationStiffness

TypeScript

get rotationStiffness(): SDKHandle

Swift declaration

var rotationStiffness: SIMD3<Float> { get set }

The per-axis rotational stiffness of the joint. A joint with higher stiffness will rotate less to reach demands. This value is in the closed range `[0, 1]`, where `0` means the joint is free to rotate, and `1` allows no movement.

set · iOS 18.0+

rotationStiffness

TypeScript

set rotationStiffness(value: SDKHandle)

Swift declaration

var rotationStiffness: SIMD3<Float> { get set }

get · iOS 18.0+

id

TypeScript

get id(): IKRig_Joint_ID

Swift declaration

final let id: IKComponent.Joint.ID

The identifier of this joint. Matches the value of the joint in the rig ``IKRig/Joint/id-swift.property``.

get · iOS 18.0+

name

TypeScript

get name(): string

Swift declaration

var name: String { get }

The name of the joint.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →