Header menu logo Nu

IkConstraintData Type

Stores the setup pose for an IkConstraint.

Constructors

Constructor Description

IkConstraintData(name)

Full Usage: IkConstraintData(name)

Parameters:
    name : string

name : string

Instance members

Instance member Description

this.BendDirection

Full Usage: this.BendDirection

For two bone IK, controls the bend direction of the IK bones, either 1 or -1.

this.Bones

Full Usage: this.Bones

Returns: ExposedList<BoneData>

The bones that are constrained by this IK Constraint.

Returns: ExposedList<BoneData>

this.Compress

Full Usage: this.Compress

For one bone IK, when true and the target is too close, the bone is scaled to reach it.

this.Mix

Full Usage: this.Mix

A percentage (0-1) that controls the mix between the constrained and unconstrained rotation.

For two bone IK: if the parent bone has local nonuniform scale, the child bone's local Y translation is set to 0.

this.Softness

Full Usage: this.Softness

For two bone IK, the target bone's distance from the maximum reach of the bones where rotation begins to slow. The bones
            will not straighten completely until the target is this far out of range.

this.Stretch

Full Usage: this.Stretch

When true and the target is out of range, the parent bone is scaled to reach it.

For two bone IK: 1) the child bone's local Y translation is set to 0, 2) stretch is not applied if IkConstraintData.Softness is > 0, and 3) if the parent bone has local nonuniform scale, stretch is not applied.

this.Target

Full Usage: this.Target

The bone that is the IK target.

this.Uniform

Full Usage: this.Uniform

When true and IkConstraintData.Compress or IkConstraintData.Stretch is used, the bone is scaled on both the X and Y axes.

Type something to start searching.