RealityFoundation · IOS API REFERENCE

IKRig.Joint.LimitsDefinition

struct · iOS 18.0+ · SDK 27.1

struct LimitsDefinition

A definition of joint rotation limits. Limit angles are defined as relative to the rest pose. - Important: The minimum angles need to be less than the maximum angles.

Members (9)

get · iOS 18.0+

maximumAngles

TypeScript

get maximumAngles(): SDKHandle

Swift declaration

var maximumAngles: SIMD3<Float>

The positive delta from the rest pose per-axis in radians.

set · iOS 18.0+

maximumAngles

TypeScript

set maximumAngles(value: SDKHandle)

Swift declaration

var maximumAngles: SIMD3<Float>

The positive delta from the rest pose per-axis in radians.

get · iOS 18.0+

minimumAngles

TypeScript

get minimumAngles(): SDKHandle

Swift declaration

var minimumAngles: SIMD3<Float>

The negative delta from the rest pose per-axis in radians.

set · iOS 18.0+

minimumAngles

TypeScript

set minimumAngles(value: SDKHandle)

Swift declaration

var minimumAngles: SIMD3<Float>

The negative delta from the rest pose per-axis in radians.

init · iOS 18.0+

init

TypeScript

static init(weight?: number, boneAxis?: IKRig_Joint_LimitsDefinition_Axis, minimumAngles?: SDKHandle, maximumAngles?: SDKHandle): IKRig_Joint_LimitsDefinition

Swift declaration

init(weight: Float = 1.0, boneAxis: IKRig.Joint.LimitsDefinition.Axis = .x, minimumAngles: SIMD3<Float> = [-2.0 * .pi, -2.0 * .pi, -2.0 * .pi], maximumAngles: SIMD3<Float> = [2.0 * .pi, 2.0 * .pi, 2.0 * .pi])

Creates a joint limits definition. - Important: The minimum angles need to be less than the maximum angles. - Parameters: - weight: The weight of the joint rotation limit demand. - boneAxis: The axis around which the bone twists. - minimumAngles: The negative delta from the rest pose per-axis in radians. - maximumAngles: The positive delta from the rest pose per-axis in radians.

get · iOS 18.0+

weight

TypeScript

get weight(): number

Swift declaration

var weight: Float

The weight of the joint rotation limit demand. The value is in the closed range `[0, 1]`, where `0` means no influence, and `1` is maximum correction.

set · iOS 18.0+

weight

TypeScript

set weight(value: number)

Swift declaration

var weight: Float

The weight of the joint rotation limit demand. The value is in the closed range `[0, 1]`, where `0` means no influence, and `1` is maximum correction.

get · iOS 18.0+

boneAxis

TypeScript

get boneAxis(): IKRig_Joint_LimitsDefinition_Axis

Swift declaration

var boneAxis: IKRig.Joint.LimitsDefinition.Axis

The axis around which the bone twists.

set · iOS 18.0+

boneAxis

TypeScript

set boneAxis(value: IKRig_Joint_LimitsDefinition_Axis)

Swift declaration

var boneAxis: IKRig.Joint.LimitsDefinition.Axis

The axis around which the bone twists.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →