eulerjs API / @eulerjs/core / Collider

Collider

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

The shape a body collides with: a description that every backend turns into its own shape. Its material and filter settings can be changed at any time.

Extended by

• BoxCollider
• CapsuleCollider
• CylinderCollider
• ConeCollider
• HeightfieldCollider
• SphereCollider
• PlaneCollider
• ConvexCollider
• MeshCollider

Constructors

Constructor

new Collider(options?, defaultRollingResistance?): Collider;

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

Parameters

Parameter	Type	Default value	Description
options?	ColliderOptions	{}	-
defaultRollingResistance?	number	0	What rollingResistance is when the options leave it out: ROUND_ROLLING_RESISTANCE for the shapes that roll.

Returns

Collider

Properties

Property	Modifier	Type	Description	Defined in
collidesWith	public	number	-	packages/core/src/colliders/Collider.ts:72
collisionGroups	public	number	-	packages/core/src/colliders/Collider.ts:71
friction	public	number	-	packages/core/src/colliders/Collider.ts:68
offset	readonly	Vector3	-	packages/core/src/colliders/Collider.ts:66
restitution	public	number	-	packages/core/src/colliders/Collider.ts:69
rollingResistance	public	number	-	packages/core/src/colliders/Collider.ts:70
rotation	readonly	Quaternion	-	packages/core/src/colliders/Collider.ts:67
sensor	public	boolean	-	packages/core/src/colliders/Collider.ts:73
shape	abstract readonly	string	Name of the shape, used to find the right collision test for a pair of colliders.	packages/core/src/colliders/Collider.ts:65

Accessors

boundingRadius

Get Signature

get abstract boundingRadius(): number;

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

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

Returns

number

Methods

bounds()

abstract bounds(pose, target): Box3;

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

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

Parameters

Parameter	Type
pose	ColliderPose
target	Box3

Returns

Box3

---

canCollideWith()

canCollideWith(other): boolean;

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

Parameters

Parameter	Type
other	Collider

Returns

boolean

---

massProperties()

abstract massProperties(specification): MassProperties | undefined;

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

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

Parameters

Parameter	Type
specification	MassSpecification

Returns

MassProperties | undefined