# API Docs for: 0.6.1
Show:

# Cylinder Class

## Constructor

### `Cylinder`

(
• `radiusTop`
• `radiusBottom`
• `height`
• `numSegments`
)

#### Parameters:

• `radiusTop` Number
• `radiusBottom` Number
• `height` Number
• `numSegments` Number

The number of segments to build the cylinder out of

## Methods

### `calculateLocalInertia`

(
• `mass`
• `target`
)

#### Parameters:

• `mass` Number
• `target` Vec3

### `calculateWorldAABB`

(
• `pos`
• `quat`
• `min`
• `max`
)

### `clipAgainstHull`

(
• `posA`
• `quatA`
• `hullB`
• `posB`
• `quatB`
• `separatingNormal`
• `minDist`
• `maxDist`
• `result`
)

#### Parameters:

• `posA` Vec3
• `quatA` Quaternion
• `hullB` ConvexPolyhedron
• `posB` Vec3
• `quatB` Quaternion
• `separatingNormal` Vec3
• `minDist` Number

Clamp distance

• `maxDist` Number
• `result` Array

The an array of contact point objects, see clipFaceAgainstHull

### `clipFaceAgainstHull`

(
• `separatingNormal`
• `posA`
• `quatA`
• `worldVertsB1`
• `minDist`
• `maxDist`
• `Array`
)

Clip a face against a hull.

#### Parameters:

• `separatingNormal` Vec3
• `posA` Vec3
• `quatA` Quaternion
• `worldVertsB1` Array

An array of Vec3 with vertices in the world frame.

• `minDist` Number

Distance clamping

• `maxDist` Number
• `Array` Object

result Array to store resulting contact points in. Will be objects with properties: point, depth, normal. These are represented in world coordinates.

### `clipFaceAgainstPlane`

(
• `inVertices`
• `outVertices`
• `planeNormal`
• `planeConstant`
)

Clip a face in a hull against the back of a plane.

#### Parameters:

• `inVertices` Array
• `outVertices` Array
• `planeNormal` Vec3
• `planeConstant` Number

The constant in the mathematical plane equation

### `computeEdges`

()

Computes uniqueEdges

### `computeNormals`

()

Compute the normals of the faces. Will reuse existing Vec3 objects in the .faceNormals array if they exist.

### `computeWorldFaceNormals`

(
• `quat`
)

Updates .worldVertices and sets .worldVerticesNeedsUpdate to false.

### `findSeparatingAxis`

(
• `hullB`
• `posA`
• `quatA`
• `posB`
• `quatB`
• `target`
)
Bool

Find the separating axis between this hull and another

#### Returns:

Bool:

Returns false if a separation is found, else true

### `getAveragePointLocal`

(
• `target`
)

Get an average of all the vertices positions

#### Parameters:

• `target` Vec3

Vec3:

### `getFaceNormal`

(
• `i`
• `target`
)

Compute the normal of a face from its vertices

#### Parameters:

• `i` Number
• `target` Vec3

### `getPlaneConstantOfFace`

(
• `face_i`
)
Number

#### Parameters:

• `face_i` Number

Index of the face

Number:

### `pointIsInside`

(
• `p`
)
Boolean

Checks whether p is inside the polyhedra. Must be in local coords. The point lies outside of the convex hull of the other points if and only if the direction of all the vectors from it to those other points are on less than one half of a sphere around it.

#### Parameters:

• `p` Vec3

A point given in local coordinates

Boolean:

### `testSepAxis`

(
• `axis`
• `hullB`
• `posA`
• `quatA`
• `posB`
• `quatB`
)
Number

Test separating axis against two hulls. Both hulls are projected onto the axis and the overlap size is returned if there is one.

#### Returns:

Number:

The overlap depth, or FALSE if no penetration.

### `transformAllPoints`

(
• `offset`
• `quat`
)

Transform all local points. Will change the .vertices

()

### `volume`

() Number

Get approximate convex volume

Number:

## Properties

### `boundingSphereRadius`

Number

The local bounding sphere radius of this shape.

### `collisionResponse`

Boolean

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

Array

Array of Vec3

### `faces`

Array

Array of integer arrays, indicating which vertices each face consists of

### `id`

Number

Identifyer of the Shape.

Material

### `type`

Number

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

### `uniqueAxes`

Array

If given, these locally defined, normalized axes are the only ones being checked when doing separating axis check.

Array

Array of Vec3

Array

Array of Vec3