eulerjs API / @eulerjs/core / BoxCollider

BoxCollider

Defined in: packages/core/src/colliders/BoxCollider.ts:17

A box, centred on the collider's position, its edges along the collider's axes.

Extends

• Collider

Constructors

Constructor

new BoxCollider(options): BoxCollider;

Defined in: packages/core/src/colliders/BoxCollider.ts:22

Parameters

Parameter	Type
options	BoxColliderOptions

Returns

BoxCollider

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
halfExtents	readonly	Vector3	undefined	Half the edge lengths.	-	-	packages/core/src/colliders/BoxCollider.ts:20
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	"box"	'box'	Name of the shape, used to find the right collision test for a pair of colliders.	Collider.shape	-	packages/core/src/colliders/BoxCollider.ts:18

Accessors

boundingRadius

Get Signature

get boundingRadius(): number;

Defined in: packages/core/src/colliders/BoxCollider.ts:30

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/BoxCollider.ts:34

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/BoxCollider.ts:46

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