eulerjs API / @eulerjs/core / PlaneCollider

PlaneCollider

Defined in: packages/core/src/colliders/PlaneCollider.ts:10

An infinite flat ground: everything on the side its normal points away from is solid. Its normal is the collider's +y axis; turn it with rotation. Only for static and kinematic bodies.

Extends

• Collider

Constructors

Constructor

new PlaneCollider(options?): PlaneCollider;

Defined in: packages/core/src/colliders/PlaneCollider.ts:13

Parameters

Parameter	Type
options?	ColliderOptions

Returns

PlaneCollider

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
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	"plane"	'plane'	Name of the shape, used to find the right collision test for a pair of colliders.	Collider.shape	-	packages/core/src/colliders/PlaneCollider.ts:11

Accessors

boundingRadius

Get Signature

get boundingRadius(): number;

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

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/PlaneCollider.ts:27

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/core/src/colliders/PlaneCollider.ts:33

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

Returns

undefined

Overrides

Collider.massProperties

---

normal()

normal(pose, target?): Vector3;

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

The plane's normal in world space at pose.

Parameters

Parameter	Type
pose	ColliderPose
target?	Vector3

Returns

Vector3