Class CapsuleShape

A capsule collision shape. Also known as a capped cylinder.

Hierarchy (View Summary, Expand)

Shape
- CapsuleShape

Index

Constructors

Properties

axis length radius

Methods

createBoxShape createCapsuleShape createConeShape createCylinderShape createLevelsetShape createMeshShape createSphereShape getTypeName isOfType isSame

Constructors

`Protected`constructor

new CapsuleShape(): CapsuleShape
Returns CapsuleShape
Overrides Shape.constructor

Properties

axis

axis: Axis

Lengthwise local axis along which the capsule is oriented.

length

length: number

Length of the capsule along its local axis. This is the distance between the two end-cap centers.

radius

radius: number

Radius of the capsule cylinder, and its end-cap spheres.

Methods

`Static`createBoxShape

createBoxShape(): BoxShape
Create a BoxShape with default settings.

Returns BoxShape
Inherited from Shape.createBoxShape

`Static`createCapsuleShape

createCapsuleShape(): CapsuleShape
Create a CapsuleShape with default settings.

Returns CapsuleShape
Inherited from Shape.createCapsuleShape

`Static`createConeShape

createConeShape(): ConeShape
Create a ConeShape with default settings.

Returns ConeShape
Inherited from Shape.createConeShape

`Static`createCylinderShape

createCylinderShape(): CylinderShape
Create a CylinderShape with default settings.

Returns CylinderShape
Inherited from Shape.createCylinderShape

`Static`createLevelsetShape

createLevelsetShape(): LevelsetShape
Create a LevelsetShape with default settings.

Returns LevelsetShape
Inherited from Shape.createLevelsetShape

`Static`createMeshShape

createMeshShape(): MeshShape
Creates a new MeshShape.

Returns MeshShape
Inherited from Shape.createMeshShape

`Static`createSphereShape

createSphereShape(): SphereShape
Create a SphereShape with default settings.

Returns SphereShape
Inherited from Shape.createSphereShape

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Shape.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from Shape.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Shape.isSame