Class InverseKinematicsConfiguration

Base class for all objects that are exported to scripting. This is required for all classes exported as reference-types to TypeScript. It is also used when resurrecting TypeScript objects.

Index

Constructors

Accessors

boneForwardDirection chainConfigurations jointConfigurations maximumIterations solverEpsilon

Constructors

constructor

new InverseKinematicsConfiguration(
isInternalConstructor?: boolean,
): InverseKinematicsConfiguration
Parameters
- OptionalisInternalConstructor: boolean
Returns InverseKinematicsConfiguration

Overrides FrameworkObject.constructor

Accessors

boneForwardDirection

get boneForwardDirection(): EnumValue<BoneForwardDirection>

Assumed forward direction of the bones of the skeleton

Returns EnumValue<BoneForwardDirection>
set boneForwardDirection(value: EnumValue<BoneForwardDirection>): void
Parameters
- value: EnumValue<BoneForwardDirection>
Returns void

chainConfigurations

get chainConfigurations(): Iterable<InverseKinematicsChainConfiguration>

Configurations for different IK chains

Returns Iterable<InverseKinematicsChainConfiguration>
set chainConfigurations(
    value:
        | Iterable<InverseKinematicsChainConfiguration>
        | readonly InverseKinematicsChainConfiguration[],
): void
Parameters
- value:
  | Iterable<InverseKinematicsChainConfiguration>
  | readonly InverseKinematicsChainConfiguration[]
Returns void

jointConfigurations

get jointConfigurations(): Iterable<InverseKinematicsJointConfiguration>

Configurations for joints used by the solver

Returns Iterable<InverseKinematicsJointConfiguration>
set jointConfigurations(
    value:
        | Iterable<InverseKinematicsJointConfiguration>
        | readonly InverseKinematicsJointConfiguration[],
): void
Parameters
- value:
  | Iterable<InverseKinematicsJointConfiguration>
  | readonly InverseKinematicsJointConfiguration[]
Returns void

maximumIterations

get maximumIterations(): number

Macimum amount of iterations the solver can do

Returns number
set maximumIterations(value: number): void
Parameters
- value: number
Returns void

solverEpsilon

get solverEpsilon(): number

Epsilon value used when comparing target transform with end effector transform to end solving early

Returns number
set solverEpsilon(value: number): void
Parameters
- value: number
Returns void