UserConstraint (Nape Physics Library)

type: class
extends: Constraint
subclasses: nape.symbolic.SymbolicConstraint

UserConstraint providing a low-level API for user-defined Constraints.

This API is intended to be powerful enough to model any constraint that Nape can handle, but not so low level as to be completely prohibitive.
For instance, things like soft-constraints are automatically provided by this API.

Working with this API will require mathematical skills. A full manual for this API is provided at: http://napephys.com/help/Constraints.pdf

You may also be interested in the nape-symbolic module that is available on github/haxelib/nape downloads. Which provides a run-time compiled DSL using this API to make prototyping (or creating non-performance critical) user-defined constraints simple without the need for great mathematical skills as well as being much quicker to work with.

Constructor

Base constructor for user constraints.

Instance Properties hide inherited show inherited

Whether this constraint is active or not.

Whether constraint will break once maxError is reached.

Whether constraint will break once maxForce is reached.

Set of CbTypes for this constraints for callbacks.

Compound this Constraints belong to.

Damping ratio of elastic properties of constraint.

Set to disable debug drawing/

Frequency of elastic properties of constraint.

Whether interactions between related Bodys will be ignored.

Whether this constraint is sleeping or not.

The maximum amount of error this constraint is allowed to use.

The maximum amount of force this constraint is allowed to use.

Whether constraint will be removed when it breaks.

Space this constraint is inside of.

Whether constraint is stiff, or elastic.

Dynamic object for user to store additional data.

Instance Methods hide inherited show inherited

Create a Vec2 property for user-constraint.

Internal extra steps in breaking constraint

Internal, optional clamping of impulse for constraint.

Internal copying of user defined constraint.

Internal debug drawing of constraint.

Internal effective mass matrix function for constraint.

Internal application of impulse to body.

Internal method to invalidate constraint on property changes

Internal positional error function for constraint.

Internal position dependant calculations for constraint.

Internal method to register Body's with constraint.

Internal validation of constraint.

Internal velocity error function for constraint.

inheritDoc

Produce copy of constraint.

inheritDoc

nape.constraint.UserConstraint

Constructor

Instance Properties hide inherited show inherited

var active : Bool = true

var breakUnderError : Bool = false

var breakUnderForce : Bool = false

readonly var cbTypes : nape.callbacks.CbTypeList = [CbType.ANY_CONSTRAINT]

var compound : Null<nape.phys.Compound> = null

var damping : Float = 1

var debugDraw : Bool = true

var frequency : Float = 10

var ignore : Bool = false

readonly var isSleeping : Bool

var maxError : Float = infinity

var maxForce : Float = infinity

var removeOnBreak : Bool = true

var space : Null<nape.space.Space> = null

var stiff : Bool = true

readonly var userData : Dynamic<Dynamic> = {}

Instance Methods hide inherited show inherited

function __bindVec2():nape.geom.Vec2

function __broken():Void

function __clamp(jAcc:nape.TArray<Float>):Void

function __copy():UserConstraint

function __draw(debug:nape.util.Debug):Void

function __eff_mass(eff:nape.TArray<Float>):Void

function __impulse(imp:nape.TArray<Float>, body:nape.phys.Body, out:nape.geom.Vec3):Void

function __invalidate():Void

function __position(err:nape.TArray<Float>):Void

function __prepare():Void

function __registerBody(oldBody:Null<nape.phys.Body>, newBody:Null<nape.phys.Body>):Null<nape.phys.Body>

function __validate():Void

function __velocity(err:nape.TArray<Float>):Void

function bodyImpulse(body:nape.phys.Body):nape.geom.Vec3

copy():Constraint

function impulse():nape.geom.MatMN

function visitBodies(lambda:nape.phys.Body -> Void):Void