nape.phys.Body

Package	nape.phys
Class	Body
Inheritance	Body Interactor

Rigid body composed of Shapes

Public Properties

Show Inherited Properties

	Property	Defined By
	type : BodyType Rigid body type	Body

	shapes : ShapeList [read-only] List of Body's shapes	Body

	compound : Compound Compuond Body belongs to	Body
	space : Space Space to which Body is contained	Body

	graphic : Dynamic Assigned graphic	Body
	graphicUpdate : Body->Void Assigned graphic handler	Body

	bounds : AABB [read-only] Body world bounds	Body
	arbiters : ArbiterList [read-only] Immutable list of arbiters	Body
	constraints : ConstraintList [read-only] List of associated active constraints	Body
	isSleeping : Bool [read-only] Whether body is asleep	Body
	localCOM : Vec2 [read-only] Immutable local centre of mass	Body
	worldCOM : Vec2 [read-only] Immutable world centre of mass	Body


	position : Vec2 Body position	Body
	velocity : Vec2 Body linear velocity	Body
	force : Vec2 Body linear force accumulator	Body
	rotation : Float Rigid body rotation	Body
	angularVel : Float Rigid body angular velocity	Body
	torque : Float Body torque accumulator	Body

	kinematicVel : Vec2 Additional velocity.	Body
	kinAngVel : Float Addition angular velocity.	Body
	surfaceVel : Vec2 Additional contact surface velocity.	Body

	constraintVelocity : Vec3 [read-only] Velocity seen by constraints	Body

	allowMovement : Bool = true Body behaves as a kinematic body for linear movement	Body
	allowRotation : Bool = true Body behaves as a kinematic body for angular movement	Body

	massMode : MassMode = MassMode.DEFAULT Mass mode of Body	Body
	mass : Float Mass of Body	Body
	constraintMass : Float [read-only] Mass seen by constraint	Body

	gravMassMode : GravMassMode = GravMassMode.DEFAULT GravMass mode of Body	Body
	gravMass : Float Gravitational mass of Body	Body
	gravMassScale : Float Ratio of gravMass to mass	Body

	InertiaMode : InertiaMode = InertiaMode.DEFAULT Inertia mode of Body	Body
	inertia : Float Moment of inertia of Body	Body
	constraintInertia : Float [read-only] Moment of inertia seen by constraint	Body

Constructor

	Constructor
	new(?type:BodyType=BodyType.DYNAMIC, ?position:Vec2=(0,0)) Construct new Rigid Body

Public Methods

Show Inherited Methods

	Method	Defined By
	const isStatic() : Bool Whether Body is static	Body
	const isKinematic() : Bool Whether Body is kinematic	Body
	const isDynamic() : Bool Whether Body is dynamic	Body

	setShapeMaterials(material:Material) Set material for every shape	Body
	setShapeFilters(filter:InteractionFilter) Set filter for every shape	Body
	setShapeFluidProperties(fluidProperties:FluidProperties) Set fluidProperties for every shape	Body

	translateShapes(displacement:const Vec2) translate each shape	Body
	rotateShapes(angle:Float) rotate each shape	Body
	scaleShapes(scalex:Float, scaley:Float) scale each shape	Body
	transformShapes(matrix:const Mat23) transform each shape	Body
	align() align centre of mass of body	Body
	rotate(centre:const Vec2, angle:Float) rotate body abuot a point	Body
	const copy() : Body Produce deep* copy of Body	Body

	const localToWorld(v:const Vec2, ?weak:Bool=false) : Vec2 Transform from local to world	Body
	const localToRelative(v:const Vec2, ?weak:Bool=false) : Vec2 Transform from local to relative	Body
	const relativeToWorld(v:const Vec2, ?weak:Bool=false) : Vec2 Transform from relative to world	Body
	const worldToLocal(v:const Vec2, ?weak:Bool=false) : Vec2 Transform from world to local	Body
	const worldToRelative(v:const Vec2, ?weak:Bool=false) : Vec2 Transform from world to relative	Body
	const relativeToLocal(v:const Vec2, ?weak:Bool=false) : Vec2 Transform from relative to local	Body

	const applyLocalForce(force:const Vec2, ?pos:const Vec2=(0,0)) Apply force at local position	Body
	const applyRelativeForce(force:const Vec2, ?pos:const Vec2=(0,0)) Apply force at relative position	Body
	const applyWorldForce(force:const Vec2, pos:const Vec2) Apply force at world position	Body

	const applyLocalImpulse(impulse:const Vec2, ?pos:const Vec2=(0,0)) Apply impulse at local position	Body
	const applyRelativeImpulse(impulse:const Vec2, ?pos:const Vec2=(0,0)) Apply impulse at relative position	Body
	const applyWorldImpulse(impulse:const Vec2, pos:const Vec2) Apply impulse at world position	Body

	const normalImpulse(?body:Body=null, ?freshOnly:Bool=false, ?weak:Bool=false) : Vec2 normal impulses on body	Body
	const tangentImpulse(?body:Body=null, ?freshOnly:Bool=false, ?weak:Bool=false) : Vec2 tangent impulses on body	Body
	const rollingImpulse(?body:Body=null, ?freshOnly:Bool=false) : Float rolling impulses on body	Body
	const totalContactsImpulse(?body:Body=null, ?freshOnly:Bool=false) : Vec3 contact impulses on body	Body

	const buoyancyImpulse(?body:Body=null) : Vec3 buoyancy impulses on body	Body
	const dragImpulse(?body:Body=null) : Vec3 drag impulses on body	Body
	const totalFluidImpulse(?body:Body=null) : Vec3 fluid impulses on body	Body

	const constraintsImpulse() : Vec3 constraint impulses on body	Body

	const totalImpulse() : Vec3 total impulses on body	Body

	const contains(point:const Vec2) : Bool Test point containment	Body

Property Detail

type

property

property type : BodyType

Rigid body type, you are free to modify this at will though there are performance penalties for conversion from/to BodyType.STATIC for most Space types, which are not great but worth mentioning (Consider if BodyType.KINEMATIC is good enough in such cases to replace BodyType.STATIC).

In conversion from kinematic/static to dynamic, the apparent velocity of the object will be conserved including the kinematic velocity offset in the case of kinematic.
In conversion to kinematic, the kinematic velocity will be set to 0.

shapes

property

readonly property shapes : ShapeList

List of shapes associated with the Body, shapes can only exist once in any shape list, so attempts to add a shape may sometimes fail (Already in list), and adding a shape to a Body's list will remove it from whatever Body it was in previously.

Note this field is readonly, but the list is still mutable!

Immutable if:

isStatic() && space!=null
Whether implicit or explicit operations are performed on this list, an error will be thrown.

compound

property

property compound : Compound

The compound this Body belongs to.

space

property

property space : Space

Space the body is contained in. This value can also be set unless the Body is part of a Compound in which case only the root of the tree can have it's space modified.

Error on setter if:

this.compound!=null Only the root of the tree has a mutable space property

graphic

property

property graphic : Dynamic

A graphic that can be assigned for auto-placement by nape. Graphic is assumed to be a flash DisplayObject unless the graphicUpdate method is assigned.

graphicUpdate

property

property graphicUpdate : Body->Void

A function handler taking the Body who's position/rotation has changed and should be rendered.

This takes precedence over any handling of the 'graphic' property and so can be used either on it's own, or together with the graphic property to customise it's placement

For example, you could emulate how nape internally updates the graphic property with the following handler:

body.graphic = ...;
body.graphicUpdate = function(b:Body) {
	b.graphic.x = b.position.x;
	b.graphic.y = b.position.y;
	//rotation is clamped to [-360,360] as flash doesn't like large rotation values
	b.graphic.rotation = (b.rotation*180/Math.PI)%360;
}

bounds

property

readonly property bounds : AABB

Immutable AABB representing the world limits of the Body.

Error on getter if:

shapes.empty()

arbiters

property

readonly property arbiters : ArbiterList

Reference to the immutable list of arbiters belonging to the respective Shapes of this Body. This includes arbiters that have been put to sleep.

constraints

property

readonly property constraints : ConstraintList

List of all 'active' (Meaning inside of a space, with active=true) constraints associated with the body. This list is immutable due to the 'active' criterion which is necessary to allow proper garbage collection of objects (Similar to CbType::bodies case)

isSleeping

property