Class Plane

A plane, facing in the Z direction. The plane has its surface at z=0 and everything below z=0 is assumed to be solid plane. To make the plane face in some other direction than z, you must put it inside a Body and rotate that body. See the demos.

Example

const planeShape = new CANNON.Plane()
    const planeBody = new CANNON.Body({ mass: 0, shape:  planeShape })
    planeBody.quaternion.setFromEuler(-Math.PI / 2, 0, 0) // make it face up
    world.addBody(planeBody)

Hierarchy (view full)

Constructors

constructor

Properties

body boundingSphereRadius collisionFilterGroup collisionFilterMask collisionResponse id material type worldNormal worldNormalNeedsUpdate idCounter types

Methods

calculateLocalInertia calculateWorldAABB computeWorldNormal updateBoundingSphereRadius volume

Constructors

constructor

Properties

body

body: Body

The body to which the shape is added to.

boundingSphereRadius

boundingSphereRadius: number

The local bounding sphere radius of this shape.

collisionFilterGroup

collisionFilterGroup: number

Default

1

collisionFilterMask

collisionFilterMask: number

Default

-1

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.

Default

true

id

id: number

Identifier of the Shape.

material

material: Material

Optional material of the shape that regulates contact properties.

type

type: 0 | ShapeType

The type of this shape. Must be set to an int > 0 by subclasses.

worldNormal

worldNormal: Vec3

worldNormal

worldNormalNeedsUpdate

worldNormalNeedsUpdate: boolean

worldNormalNeedsUpdate

Static idCounter

idCounter: number

Static types

types: {
    BOX: 4;
    COMPOUND: 8;
    CONVEXPOLYHEDRON: 16;
    CYLINDER: 128;
    HEIGHTFIELD: 32;
    PARTICLE: 64;
    PLANE: 2;
    SPHERE: 1;
    TRIMESH: 256;
}

All the Shape types.

Type declaration

  • Readonly BOX: 4

    BOX

  • Readonly COMPOUND: 8

    COMPOUND

  • Readonly CONVEXPOLYHEDRON: 16

    CONVEXPOLYHEDRON

  • Readonly CYLINDER: 128

    CYLINDER

  • Readonly HEIGHTFIELD: 32

    HEIGHTFIELD

  • Readonly PARTICLE: 64

    PARTICLE

  • Readonly PLANE: 2

    PLANE

  • Readonly SPHERE: 1

    SPHERE

  • Readonly TRIMESH: 256

    TRIMESH

Methods

calculateLocalInertia

calculateWorldAABB

computeWorldNormal

  • computeWorldNormal(quat): void

  • computeWorldNormal

    Parameters

    Returns void

updateBoundingSphereRadius

  • updateBoundingSphereRadius(): void

  • Computes the bounding sphere radius. The result is stored in the property .boundingSphereRadius

    Returns void

volume

  • volume(): number

  • Get the volume of this shape

    Returns number

Settings

Member Visibility

Theme

On This Page