Class: CapsuleColliderShape ​

Capsule collision body. Composed of two hemispheres connected to a cylinder.

Hierarchy ​

• ColliderShape

  ↳ CapsuleColliderShape

Constructors ​

• constructor

Properties ​

• radius
• height

Accessors ​

• shapeType
• center
• size
• halfSize

Methods ​

• setFromCenterAndSize
• rayPick

Constructors ​

constructor ​

• new CapsuleColliderShape()

Overrides ​

ColliderShape.constructor

Defined in ​

src/components/shape/CapsuleColliderShape.ts:17

Properties ​

radius ​

• radius: number = 2.5

The radius of the local width of the collision body.

Defined in ​

src/components/shape/CapsuleColliderShape.ts:11

height ​

• height: number = 10

The total height of the collision body.

Defined in ​

src/components/shape/CapsuleColliderShape.ts:15

Accessors ​

shapeType ​

• get shapeType(): ColliderShapeType

Returns ​

ColliderShapeType

Inherited from ​

ColliderShape.shapeType

Defined in ​

src/components/shape/ColliderShape.ts:40

center ​

• get center(): Vector3

The position of the collision object in the local space of the object.

Returns ​

Vector3

Inherited from ​

ColliderShape.center

Defined in ​

src/components/shape/ColliderShape.ts:59

• set center(value): void

Parameters ​

Returns ​

void

Inherited from ​

ColliderShape.center

Defined in ​

src/components/shape/ColliderShape.ts:63

size ​

• get size(): Vector3

The size of the collision body in the X, Y, and Z directions.

Returns ​

Vector3

Vector3

Inherited from ​

ColliderShape.size

Defined in ​

src/components/shape/ColliderShape.ts:72

• set size(value): void

Parameters ​

Returns ​

void

Inherited from ​

ColliderShape.size

Defined in ​

src/components/shape/ColliderShape.ts:76

halfSize ​

• get halfSize(): Vector3

Half the size of the collision body.

Returns ​

Vector3

Inherited from ​

ColliderShape.halfSize

Defined in ​

src/components/shape/ColliderShape.ts:84

Methods ​

setFromCenterAndSize ​

▸ setFromCenterAndSize(ct?, sz?): CapsuleColliderShape

Set the position and size of collision objects

Parameters ​

Returns ​

CapsuleColliderShape

Inherited from ​

ColliderShape.setFromCenterAndSize

Defined in ​

src/components/shape/ColliderShape.ts:50

rayPick ​

▸ rayPick(ray, fromMatrix): HitInfo

Ray pickup.Emit a ray from a designated location to detect objects colliding with the ray.

Parameters ​

Returns ​

HitInfo

Pick result intersect: whether to collide; IntersectPoint: collision point; Distance: The distance from the origin of the ray to the collision point.

Inherited from ​

ColliderShape.rayPick

Defined in ​

src/components/shape/ColliderShape.ts:96