Class Sphere

Spherical shape

Example

const radius = 1
    const sphereShape = new CANNON.Sphere(radius)
    const sphereBody = new CANNON.Body({ mass: 1, shape: sphereShape })
    world.addBody(sphereBody)

Hierarchy (view full)

Constructors

constructor

Properties

body boundingSphereRadius collisionFilterGroup collisionFilterMask collisionResponse id material radius type idCounter types

Methods

calculateLocalInertia calculateWorldAABB updateBoundingSphereRadius volume

Constructors

constructor

  • new Sphere(radius): Sphere

  • Parameters

    • radius: number

      The radius of the sphere, a non-negative number.

    Returns Sphere

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.

radius

radius: number

The radius of the sphere.

type

type: 0 | ShapeType

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

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

updateBoundingSphereRadius

  • updateBoundingSphereRadius(): void

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

    Returns void

volume

  • volume(): number

  • volume

    Returns number

Settings

Member Visibility

Theme

On This Page