Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Convex

Convex shape class.

example
var body = new Body({ mass: 1 });
var vertices = [[-1,-1], [1,-1], [1,1], [-1,1]];
var convexShape = new Convex({
    vertices: vertices
});
body.addShape(convexShape);

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

angle

angle: number

Body-local angle of the shape.

area

area: number = 0

Area of this shape.

axes

axes: Vec2[]

Axes

body

body: null | Body = null

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

boundingRadius

boundingRadius: number

The bounding radius of the convex

centerOfMass

centerOfMass: Vec2

The center of mass of the Convex

collisionGroup

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;
example
// How collision check is done
if(shapeA.collisionGroup & shapeB.collisionMask)!=0 && (shapeB.collisionGroup & shapeA.collisionMask)!=0){
    // The shapes will collide
}

collisionMask

collisionMask: number

Collision mask of this shape. See .collisionGroup.

collisionResponse

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.

id

id: number

Shape object identifier

material

material: null | Material

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

normals

normals: Vec2[]

Edge normals defined in the local frame, pointing out of the shape.

position

position: Vec2 = ...

Body-local position of the shape.

sensor

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

triangles: Vec2[]

Triangulated version of this convex. The structure is Array of 3-Arrays, and each subarray contains 3 integers, referencing the vertices.

type

type: 2 | 1 | 4 | 8 | 16 | 32 | 64 | 128

The type of the shape. One of:

vertices

vertices: Vec2[]

Vertices defined in the local frame.

Static BOX

BOX: 32 = 32

Box shape type

Static CAPSULE

CAPSULE: 64 = 64

Capsule shape type

Static CIRCLE

CIRCLE: 1 = 1

Circle shape type

Static CONVEX

CONVEX: 8 = 8

Convex shape type

Static HEIGHTFIELD

HEIGHTFIELD: 128 = 128

Heightfield shape type

Static LINE

LINE: 16 = 16

Line shape type

Static PARTICLE

PARTICLE: 2 = 2

Particle shape type

Static PLANE

PLANE: 4 = 4

Plane shape type

Static idCounter

idCounter: number = 0

ID counter for shapes

Methods

computeAABB

  • computeAABB(out: AABB, position: Vec2, angle: number): void

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

    Parameters

    Returns void

computeMomentOfInertia

  • computeMomentOfInertia(): number

pointTest

  • pointTest(localPoint: Vec2): boolean

  • Test if a point is inside this shape.

    Parameters

    Returns boolean

projectOntoLocalAxis

  • projectOntoLocalAxis(localAxis: Vec2, result: Vec2): void

  • Project a Convex onto a world-oriented axis

    Parameters

    Returns void

projectOntoWorldAxis

  • projectOntoWorldAxis(localAxis: Vec2, shapeOffset: Vec2, shapeAngle: number, result: Vec2): void

  • Parameters

    • localAxis: Vec2
    • shapeOffset: Vec2
    • shapeAngle: number
    • result: Vec2

    Returns void

raycast

updateArea

  • updateArea(): void

  • Update the .area

    Returns void

updateBoundingRadius

  • updateBoundingRadius(): void

updateCenterOfMass

  • updateCenterOfMass(): void

  • Update the .centerOfMass property.

    Returns void

updateNormals

  • updateNormals(): void

  • Returns void

updateTriangles

  • updateTriangles(): void

  • Update the .triangles property

    Returns void

worldPointToLocal

  • Transform a world point to local shape space (assumed the shape is transformed by both itself and the body).

    Parameters

    Returns Vec2

Static triangleArea

  • Get the area of the triangle spanned by the three points a, b, c. The area is positive if the points are given in counter-clockwise order, otherwise negative.

    Parameters

    Returns number