eulerjs API / @eulerjs/core / CapsuleCollider

CapsuleCollider

Defined in: packages/core/src/colliders/CapsuleCollider.ts:21

A cylinder with rounded ends, along its y axis: the usual shape for limbs and characters.

Extends

• Collider

Constructors

Constructor

new CapsuleCollider(options): CapsuleCollider;

Defined in: packages/core/src/colliders/CapsuleCollider.ts:26

Parameters

Parameter	Type
options	CapsuleColliderOptions

Returns

CapsuleCollider

Overrides

Collider.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
collidesWith	public	number	undefined	-	-	Collider.collidesWith	packages/core/src/colliders/Collider.ts:72
collisionGroups	public	number	undefined	-	-	Collider.collisionGroups	packages/core/src/colliders/Collider.ts:71
friction	public	number	undefined	-	-	Collider.friction	packages/core/src/colliders/Collider.ts:68
length	public	number	undefined	-	-	-	packages/core/src/colliders/CapsuleCollider.ts:24
offset	readonly	Vector3	undefined	-	-	Collider.offset	packages/core/src/colliders/Collider.ts:66
radius	public	number	undefined	-	-	-	packages/core/src/colliders/CapsuleCollider.ts:23
restitution	public	number	undefined	-	-	Collider.restitution	packages/core/src/colliders/Collider.ts:69
rollingResistance	public	number	undefined	-	-	Collider.rollingResistance	packages/core/src/colliders/Collider.ts:70
rotation	readonly	Quaternion	undefined	-	-	Collider.rotation	packages/core/src/colliders/Collider.ts:67
sensor	public	boolean	undefined	-	-	Collider.sensor	packages/core/src/colliders/Collider.ts:73
shape	readonly	"capsule"	'capsule'	Name of the shape, used to find the right collision test for a pair of colliders.	Collider.shape	-	packages/core/src/colliders/CapsuleCollider.ts:22

Accessors

boundingRadius

Get Signature

get boundingRadius(): number;

Defined in: packages/core/src/colliders/CapsuleCollider.ts:34

Radius of a sphere around the offset that contains the shape; Infinity for infinite shapes.

Returns

number

Overrides

Collider.boundingRadius

Methods

bounds()

bounds(pose, target): Box3;

Defined in: packages/core/src/colliders/CapsuleCollider.ts:47

World-space box around the collider at pose. Infinite shapes return an infinite box.

Parameters

Parameter	Type
pose	ColliderPose
target	Box3

Returns

Box3

Overrides

Collider.bounds

---

canCollideWith()

canCollideWith(other): boolean;

Defined in: packages/core/src/colliders/Collider.ts:95

Parameters

Parameter	Type
other	Collider

Returns

boolean

Inherited from

Collider.canCollideWith

---

endsAt()

endsAt(
   pose, 
   start, 
   end
): void;

Defined in: packages/core/src/colliders/CapsuleCollider.ts:39

Writes the centres of the two rounded ends in world space, for the collider at pose.

Parameters

Parameter	Type
pose	ColliderPose
start	Vector3
end	Vector3

Returns

void

---

massProperties()

massProperties(specification): MassProperties;

Defined in: packages/core/src/colliders/CapsuleCollider.ts:54

Mass properties of the solid in the body frame, or undefined for shapes without a volume.

Parameters

Parameter	Type
specification	MassSpecification

Returns

MassProperties

Overrides

Collider.massProperties