One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

IKRig.Constraint.IKOrientationDemand

struct · iOS 18.0+ · SDK 27.1

struct IKOrientationDemand

A definition of an orientational demand.

Members (7)

get · iOS 18.0+

influenceDepthMaxJointCount

TypeScript
get influenceDepthMaxJointCount(): number
Swift declaration
var influenceDepthMaxJointCount: Int

The number of joints to be influenced by this demand. The count starts from the constrained joint and continues up the chain to the skeleton's root. - Note: A depth of `0` disables the constraint, while negative values are treated as `Int.max`

set · iOS 18.0+

influenceDepthMaxJointCount

TypeScript
set influenceDepthMaxJointCount(value: number)
Swift declaration
var influenceDepthMaxJointCount: Int

The number of joints to be influenced by this demand. The count starts from the constrained joint and continues up the chain to the skeleton's root. - Note: A depth of `0` disables the constraint, while negative values are treated as `Int.max`

get · iOS 18.0+

mode

TypeScript
get mode(): IKRig_Constraint_IKOrientationDemand_Mode
Swift declaration
var mode: IKRig.Constraint.IKOrientationDemand.Mode

The mode of the orientational demand.

set · iOS 18.0+

mode

TypeScript
set mode(value: IKRig_Constraint_IKOrientationDemand_Mode)
Swift declaration
var mode: IKRig.Constraint.IKOrientationDemand.Mode

The mode of the orientational demand.

get · iOS 18.0+

weight

TypeScript
get weight(): SDKHandle
Swift declaration
var weight: SIMD3<Float>

The per-axis weight this demand has on the pose. - Note: Values of `0` or less remove the demand influence.

set · iOS 18.0+

weight

TypeScript
set weight(value: SDKHandle)
Swift declaration
var weight: SIMD3<Float>

The per-axis weight this demand has on the pose. - Note: Values of `0` or less remove the demand influence.

init · iOS 18.0+

init

TypeScript
static init(): IKRig_Constraint_IKOrientationDemand
Swift declaration
init()

Creates an orientational demand with default settings.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →