eulerjs API / @eulerjs/core / ConvexCollider

ConvexCollider

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

The convex hull of a set of points: any convex shape, such as a rock, a bevelled crate or the hull of a model. Coplanar triangles are merged into one polygon face, so a box-shaped hull has six square faces, which is what gives whole contact patches.

Extends

• Collider

Constructors

Constructor

new ConvexCollider(options): ConvexCollider;

Defined in: packages/core/src/colliders/ConvexCollider.ts:43

Parameters

Parameter	Type
options	ConvexColliderOptions

Returns

ConvexCollider

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
edgeDirections	readonly	readonly Vector3[]	undefined	The edges' directions with parallel ones counted once: the edge axes collision tests need.	-	-	packages/core/src/colliders/ConvexCollider.ts:40
edgeFaces	readonly	readonly (readonly [number, number])[]	undefined	The two faces either side of each edge, by index into faces.	-	-	packages/core/src/colliders/ConvexCollider.ts:38
edges	readonly	readonly (readonly [number, number])[]	undefined	Each edge once, as a pair of vertex indices.	-	-	packages/core/src/colliders/ConvexCollider.ts:36
faces	readonly	readonly ConvexFace[]	undefined	-	-	-	packages/core/src/colliders/ConvexCollider.ts:34
friction	public	number	undefined	-	-	Collider.friction	packages/core/src/colliders/Collider.ts:68
offset	readonly	Vector3	undefined	-	-	Collider.offset	packages/core/src/colliders/Collider.ts:66
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	"convex"	'convex'	Name of the shape, used to find the right collision test for a pair of colliders.	Collider.shape	-	packages/core/src/colliders/ConvexCollider.ts:32
vertices	readonly	readonly Vector3[]	undefined	-	-	-	packages/core/src/colliders/ConvexCollider.ts:33

Accessors

boundingRadius

Get Signature

get boundingRadius(): number;

Defined in: packages/core/src/colliders/ConvexCollider.ts:61

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/ConvexCollider.ts:65

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

---

fromGeometry()

static fromGeometry(geometry, options?): ConvexCollider;

Defined in: packages/core/src/colliders/ConvexCollider.ts:55

The hull of a geometry's vertices, in the geometry's frame.

Parameters

Parameter	Type
geometry	BufferGeometry
options?	ColliderOptions

Returns

ConvexCollider

---

massProperties()

massProperties(specification): MassProperties;

Defined in: packages/core/src/colliders/ConvexCollider.ts:72

Exact mass properties of the solid hull, in the body frame.

Parameters

Parameter	Type
specification	MassSpecification

Returns

MassProperties

Overrides

Collider.massProperties

---

toGeometry()

toGeometry(): BufferGeometry;

Defined in: packages/core/src/colliders/ConvexCollider.ts:78

The hull as triangles in the collider's frame, e.g. to draw it.

Returns

BufferGeometry