docsby gkjohnson

Constants

On this page

SOLVE_STATUS

const SOLVE_STATUS: Object<string, number>

Statuses returned for each independent chain by Solver.solve.

// Error for all goals is within the convergence thresholds.
SOLVE_STATUS.CONVERGED

// No joint moved more than the stall threshold or no joints are free to move.
SOLVE_STATUS.STALLED

// No step scale could keep the error within the divergence threshold.
SOLVE_STATUS.DIVERGED

// The maximum number of iterations was reached.
SOLVE_STATUS.TIMEOUT

SOLVE_STATUS_NAMES

const SOLVE_STATUS_NAMES: Array<string>

Names of the solve statuses indexed by status value.

DOF

const DOF: Object<string, number>

Degrees of freedom that can be assigned to a joint.

// Translation along an axis
DOF.X, DOF.Y, DOF.Z

// Euler rotation about an axis
DOF.EX, DOF.EY, DOF.EZ

DOF_NAMES

const DOF_NAMES: Array<string>

Names of the degrees of freedom indexed by DOF value.