API Docs for: 0.7.1
Show:

Shape Class

Defined in: src/shapes/Shape.js:5

Base class for shapes.

Constructor

Shape

(
  • [options]
)

Defined in src/shapes/Shape.js:5

Parameters:

  • [options] Object optional
    • [position] Array optional
    • [angle=0] Number optional
    • [collisionGroup=1] Number optional
    • [collisionMask=1] Number optional
    • [sensor=false] Boolean optional
    • [collisionResponse=true] Boolean optional
    • [type=0] Object optional

Methods

computeAABB

(
  • out
  • position
  • angle
)

Defined in src/shapes/Shape.js:223

Compute the world axis-aligned bounding box (AABB) of this shape.

Parameters:

  • out AABB

    The resulting AABB.

  • position Array

    World position of the shape.

  • angle Number

    World angle of the shape.

computeMomentOfInertia

(
  • mass
)
Number

Defined in src/shapes/Shape.js:200

Should return the moment of inertia around the Z axis of the body given the total mass. See Wikipedia's list of moments of inertia.

Parameters:

  • mass Number

Returns:

Number:

If the inertia is infinity or if the object simply isn't possible to rotate, return 0.

raycast

(
  • result
  • ray
  • position
  • angle
)

Defined in src/shapes/Shape.js:234

Perform raycasting on this shape.

Parameters:

  • result RayResult

    Where to store the resulting data.

  • ray Ray

    The Ray that you want to use for raycasting.

  • position Array

    World position of the shape (the .position property will be ignored).

  • angle Number

    World angle of the shape (the .angle property will be ignored).

updateArea

()

Defined in src/shapes/Shape.js:215

Update the .area property of the shape.

updateBoundingRadius

() Number

Defined in src/shapes/Shape.js:208

Returns the bounding circle radius of this shape.

Returns:

Number:

Properties

angle

Number

Defined in src/shapes/Shape.js:36

Body-local angle of the shape.

area

Number

Defined in src/shapes/Shape.js:123

Area of this shape.

body

Body

Defined in src/shapes/Shape.js:21

The body this shape is attached to. A shape can only be attached to a single body.

boundingRadius

Number

Defined in src/shapes/Shape.js:65

Bounding circle radius of this shape

BOX

Number static

Defined in src/shapes/Shape.js:175

CAPSULE

Number static

Defined in src/shapes/Shape.js:188

CIRCLE

Number static

Defined in src/shapes/Shape.js:145

collisionGroup

Number

Defined in src/shapes/Shape.js:72

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

Defined in src/shapes/Shape.js:109

Collision mask of this shape. See .collisionGroup.

collisionResponse

Boolean

Defined in src/shapes/Shape.js:103

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.

CONVEX

Number static

Defined in src/shapes/Shape.js:163

HEIGHTFIELD

Number static

Defined in src/shapes/Shape.js:194

id

Number

Defined in src/shapes/Shape.js:58

Shape object identifier.

LINE

Number static

Defined in src/shapes/Shape.js:169

material

Material

Defined in src/shapes/Shape.js:116

Material to use in collisions for this Shape. If this is set to null, the world will use default material properties instead.

PARTICLE

Number static

Defined in src/shapes/Shape.js:151

PLANE

Number static

Defined in src/shapes/Shape.js:157

position

Array

Defined in src/shapes/Shape.js:27

Body-local position of the shape.

sensor

Boolean

Defined in src/shapes/Shape.js:130

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.