Class InverseKinematics

Provides an interface for solving inverse kinematics (IK). One InverseKinematics object corresponds to one Skeleton.

Index

Constructors

Methods

overrideTargets updateFromConfiguration

Constructors

constructor

new InverseKinematics(
skeleton: Skeleton,
isInternalConstructor?: boolean,
): InverseKinematics
Creates an IK solver with the given arguments.
Parameters
- skeleton: Skeleton
  The skeleton this solver will operate on
- OptionalisInternalConstructor: boolean
Returns InverseKinematics

Overrides FrameworkObject.constructor

Methods

overrideTargets

overrideTargets(
targetOverrides: Immutable<InverseKinematicsTargetOverride>[],
): void
Overrides the chain's targets with the given scene objects.
Parameters
- targetOverrides: Immutable<InverseKinematicsTargetOverride>[]
  The scene objects to use as targets instead of the configured ones.
Returns void

updateFromConfiguration

updateFromConfiguration(
    configuration: Const<InverseKinematicsConfiguration | null>,
    colliderInformation: Const<BoneColliderInformation | null>,
    sceneObject: SceneObject,
): void
Updates the solver according to the configuration. This clears out all chains and replaces them with new ones according to the configuration.
Parameters
- configuration: Const<InverseKinematicsConfiguration | null>
  The configuration to use for the update.
- colliderInformation: Const<BoneColliderInformation | null>
- sceneObject: SceneObject
Returns void