Box Class
Box shape class.
Constructor
Box
-
[options]
Parameters:
-
[options]Object optional(Note that this options object will be passed on to the Shape constructor.)
-
[width=1]Number optionalTotal width of the box
-
[height=1]Number optionalTotal height of the box
-
Item Index
Methods
Methods
computeAABB
-
out -
position -
angle
Parameters:
-
outAABBThe resulting AABB.
-
positionArray -
angleNumber
computeMomentOfInertia
-
mass
Compute moment of inertia
Parameters:
-
massNumber
Returns:
raycast
-
result -
ray -
position -
angle
Parameters:
-
resultRaycastResult -
rayRay -
positionArray -
angleNumber
updateArea
()
Update the .area
updateBoundingRadius
()
Update the bounding radius
updateCenterOfMass
()
Update the .centerOfMass property.
updateTriangles
()
Update the .triangles property
Properties
angle
Number
Body-local angle of the shape.
area
Number
Area of this shape.
axes
Array
Axes defined in the local frame.
boundingRadius
Number
The bounding radius of the convex
centerOfMass
Array
The center of mass of the Convex
collisionGroup
Number
Collision group that this shape belongs to (bit mask). See this tutorial.
Example:
// Setup bits for each available group
var PLAYER = Math.pow(2,0),
ENEMY = Math.pow(2,1),
GROUND = Math.pow(2,2)
// Put shapes into their groups
player1Shape.collisionGroup = PLAYER;
player2Shape.collisionGroup = PLAYER;
enemyShape .collisionGroup = ENEMY;
groundShape .collisionGroup = GROUND;
// Assign groups that each shape collide with.
// Note that the players can collide with ground and enemies, but not with other players.
player1Shape.collisionMask = ENEMY | GROUND;
player2Shape.collisionMask = ENEMY | GROUND;
enemyShape .collisionMask = PLAYER | GROUND;
groundShape .collisionMask = PLAYER | ENEMY;
// How collision check is done
if(shapeA.collisionGroup & shapeB.collisionMask)!=0 && (shapeB.collisionGroup & shapeA.collisionMask)!=0){
// The shapes will collide
}
collisionMask
Number
Collision mask of this shape. See .collisionGroup.
collisionResponse
Boolean
Whether to produce contact forces when in contact with other bodies. Note that contacts will be generated, but they will be disabled. That means that this shape will move through other body shapes, but it will still trigger contact events, etc.
height
Number
Total height of the box
id
Number
Shape object identifier.
material
Material
Material to use in collisions for this Shape. If this is set to null, the world will use default material properties instead.
position
Array
Body-local position of the shape.
sensor
Boolean
Set to true if you want this shape to be a sensor. A sensor does not generate contacts, but it still reports contact events. This is good if you want to know if a shape is overlapping another shape, without them generating contacts.
triangles
Array
Triangulated version of this convex. The structure is Array of 3-Arrays, and each subarray contains 3 integers, referencing the vertices.
type
Number
The type of the shape. One of:
vertices
Array
Vertices defined in the local frame.
width
Number
Total width of the box