Type Alias ConstraintDef<C>

definition for a user constraint

type ConstraintDef<C extends ConstraintBase = ConstraintBase> = {
    getIterationOverrides: GetIterationOverridesFn<C>;
    getSortFields: GetSortFieldsFn<C>;
    resetWarmStart: ResetWarmStartFn<C>;
    setupVelocity: SetupVelocityFn<C>;
    solvePosition: SolvePositionFn<C>;
    solveVelocity: SolveVelocityFn<C>;
    type: ConstraintType;
    warmStartVelocity: WarmStartVelocityFn<C>;
}

Type Parameters

C extends ConstraintBase = ConstraintBase

Index

Properties

getIterationOverrides getSortFields resetWarmStart setupVelocity solvePosition solveVelocity type warmStartVelocity

Properties

getIterationOverrides

getIterationOverrides: GetIterationOverridesFn<C>

get iteration overrides for solver

getSortFields

getSortFields: GetSortFieldsFn<C>

get sort fields for constraint ordering

resetWarmStart

resetWarmStart: ResetWarmStartFn<C>

reset warm start state (called when bodies wake up)

setupVelocity

setupVelocity: SetupVelocityFn<C>

setup velocity constraints for this constraint

solvePosition

solvePosition: SolvePositionFn<C>

solve position constraints, returns true if impulse applied

solveVelocity

solveVelocity: SolveVelocityFn<C>

solve velocity constraints, returns true if impulse applied

type

type: ConstraintType

constraint type enum value

warmStartVelocity

warmStartVelocity: WarmStartVelocityFn<C>

warm start velocity constraints