Class RotationalEquation

Rotational constraint. Works to keep the local vectors orthogonal to each other in world space.

Hierarchy (view full)

Constructors

constructor

Properties

a axisA axisB b bi bj enabled eps id jacobianElementA jacobianElementB maxAngle maxForce minForce multiplier si sj idCounter

Methods

addToWlambda computeB computeC computeGW computeGWlambda computeGiMGt computeGiMf computeGq setSpookParams

Constructors

constructor

  • new RotationalEquation(bodyA, bodyB, options?): RotationalEquation

  • Parameters

    • bodyA: Body
    • bodyB: Body
    • Optional options: {
          axisA?: Vec3;
          axisB?: Vec3;
          maxAngle?: number;
          maxForce?: number;
      }
      • Optional axisA?: Vec3

        World oriented rotational axis.

      • Optional axisB?: Vec3

        World oriented rotational axis.

      • Optional maxAngle?: number

        maxAngle

      • Optional maxForce?: number

        Default

        1e6

    Returns RotationalEquation

Properties

a

a: number

SPOOK parameter

axisA

axisA: Vec3

World oriented rotational axis.

axisB

axisB: Vec3

World oriented rotational axis.

b

b: number

SPOOK parameter

bi

bi: Body

bj

bj: Body

enabled

enabled: boolean

eps

eps: number

SPOOK parameter

id

id: number

jacobianElementA

jacobianElementA: JacobianElement

jacobianElementB

jacobianElementB: JacobianElement

maxAngle

maxAngle: number

maxAngle

maxForce

maxForce: number

Maximum (read: positive max) force to be applied by the constraint.

minForce

minForce: number

Minimum (read: negative max) force to be applied by the constraint.

multiplier

multiplier: number

A number, proportional to the force added to the bodies.

si

si: Shape

sj

sj: Shape

Static idCounter

idCounter: number

Methods

addToWlambda

  • addToWlambda(deltalambda): void

  • Add constraint velocity to the bodies.

    Parameters

    • deltalambda: number

    Returns void

computeB

  • computeB(h): number

  • Computes the right hand side of the SPOOK equation

    Parameters

    • h: number

    Returns number

computeC

  • computeC(): number

  • Compute the denominator part of the SPOOK equation: C = G*inv(M)*G' + eps

    Returns number

computeGW

  • computeGW(): number

  • Computes G*W, where W are the body velocities

    Returns number

computeGWlambda

  • computeGWlambda(): number

  • Computes G*Wlambda, where W are the body velocities

    Returns number

computeGiMGt

computeGiMf

  • computeGiMf(): number

  • Computes G*inv(M)*f, where M is the mass matrix with diagonal blocks for each body, and f are the forces on the bodies.

    Returns number

computeGq

  • computeGq(): number

  • Computes G*q, where q are the generalized body coordinates

    Returns number

setSpookParams

  • setSpookParams(stiffness, relaxation, timeStep): void

  • Recalculates a, b, and eps.

    The Equation constructor sets typical SPOOK parameters as such:

    • stiffness = 1e7
    • relaxation = 4
    • timeStep= 1 / 60, note the hardcoded refresh rate.

    Parameters

    • stiffness: number
    • relaxation: number
    • timeStep: number

    Returns void

Settings

Member Visibility

Theme

On This Page