API Docs for: 0.6.1
Show:

Box Class

Extends Shape
Defined in: src/shapes/Box.js:7

A 3d box shape.

Constructor

Box

(
  • halfExtents
)

Defined in src/shapes/Box.js:7

Parameters:

Methods

calculateLocalInertia

(
  • mass
  • target
)
Vec3

Inherited from Shape but overwritten in src/shapes/Box.js:80

Parameters:

  • mass Number
  • target Vec3

Returns:

Vec3:

getSideNormals

(
  • sixTargetVectors
  • quat
)
Array

Defined in src/shapes/Box.js:99

Get the box 6 side normals

Parameters:

  • sixTargetVectors Array

    An array of 6 vectors, to store the resulting side normals in.

  • quat Quaternion

    Orientation to apply to the normal vectors. If not provided, the vectors will be in respect to the local frame.

Returns:

Array:

updateBoundingSphereRadius

() Number

Inherited from Shape: src/shapes/Shape.js:50

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

Returns:

Number:

updateConvexPolyhedronRepresentation

()

Defined in src/shapes/Box.js:39

Updates the local convex polyhedron representation used for some collisions.

volume

() Number

Inherited from Shape: src/shapes/Shape.js:59

Get the volume of this shape

Returns:

Number:

Properties

boundingSphereRadius

Number

Inherited from Shape: src/shapes/Shape.js:31

The local bounding sphere radius of this shape.

collisionResponse

Boolean

Inherited from Shape: src/shapes/Shape.js:37

Whether to produce contact forces when in contact with other bodies. Note that contacts will be generated, but they will be disabled.

convexPolyhedronRepresentation

ConvexPolyhedron

Defined in src/shapes/Box.js:26

Used by the contact generator to make contacts with other convex polyhedra for example

halfExtents

Vec3

Defined in src/shapes/Box.js:20

id

Number

Inherited from Shape: src/shapes/Shape.js:17

Identifyer of the Shape.

material

Material

Inherited from Shape: src/shapes/Shape.js:43

type

Number

Inherited from Shape: src/shapes/Shape.js:23

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