eulerjs API / @eulerjs/core / CylinderCollider

CylinderCollider

Defined in: packages/core/src/colliders/CylinderCollider.ts:25

A solid cylinder along its y axis, such as a barrel, a log or a wheel. Its mass, ray casts and contacts with planes and spheres are exact, so it rolls smoothly on the ground; against other shapes it collides as a 16-sided prism.

Extends

• Collider

Constructors

Constructor

new CylinderCollider(options): CylinderCollider;

Defined in: packages/core/src/colliders/CylinderCollider.ts:31

Parameters

Parameter	Type
options	CylinderColliderOptions

Returns

CylinderCollider

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
height	readonly	number	undefined	-	-	-	packages/core/src/colliders/CylinderCollider.ts:28
offset	readonly	Vector3	undefined	-	-	Collider.offset	packages/core/src/colliders/Collider.ts:66
radius	readonly	number	undefined	-	-	-	packages/core/src/colliders/CylinderCollider.ts:27
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	"cylinder"	'cylinder'	Name of the shape, used to find the right collision test for a pair of colliders.	Collider.shape	-	packages/core/src/colliders/CylinderCollider.ts:26

Accessors

boundingRadius

Get Signature

get boundingRadius(): number;

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

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/CylinderCollider.ts:49

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

---

massProperties()

massProperties(specification): MassProperties;

Defined in: packages/core/src/colliders/CylinderCollider.ts:60

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