eulerjs API / @eulerjs/bvh / MeshCollider

MeshCollider

Defined in: packages/bvh/src/MeshCollider.ts:22

Any triangle mesh as a collider, such as a level, a building or a rock face, found quickly with a bounding volume tree (three-mesh-bvh). Both sides of every triangle are solid, so it needn't be closed. Only for static and kinematic bodies: it has no volume to give a mass.

Extends

• Collider

Constructors

Constructor

new MeshCollider(options): MeshCollider;

Defined in: packages/bvh/src/MeshCollider.ts:31

Parameters

Parameter	Type
options	MeshColliderOptions

Returns

MeshCollider

Overrides

Collider.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
activeEdges	readonly	Uint8Array	undefined	For each triangle, by the tree's numbering, bit k set when its edge from corner k to the next may push on its own.	-	-	packages/bvh/src/MeshCollider.ts:27
bvh	readonly	MeshBVH	undefined	-	-	-	packages/bvh/src/MeshCollider.ts:25
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
geometry	readonly	BufferGeometry	undefined	-	-	-	packages/bvh/src/MeshCollider.ts:24
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	"mesh"	'mesh'	Name of the shape, used to find the right collision test for a pair of colliders.	Collider.shape	-	packages/bvh/src/MeshCollider.ts:23

Accessors

boundingRadius

Get Signature

get boundingRadius(): number;

Defined in: packages/bvh/src/MeshCollider.ts:45

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

Returns

number

Overrides

Collider.boundingRadius

---

triangleCount

Get Signature

get triangleCount(): number;

Defined in: packages/bvh/src/MeshCollider.ts:49

Returns

number

Methods

bounds()

bounds(pose, target): Box3;

Defined in: packages/bvh/src/MeshCollider.ts:58

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(): undefined;

Defined in: packages/bvh/src/MeshCollider.ts:68

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

Returns

undefined

Overrides

Collider.massProperties

---

toGeometry()

toGeometry(): BufferGeometry;

Defined in: packages/bvh/src/MeshCollider.ts:54

The triangles in the collider's frame, e.g. to draw it: a copy of its geometry.

Returns

BufferGeometry