Class Plane

An infinite flat plane: the points p where normal · p + constant = 0

The ground y = 0 is new Plane(new Vector3(0, 1, 0), 0), and the upward-facing plane y = 2 has a constant of -2. Keep normal unit length, or distances come out scaled; Plane#normalize fixes one that isn't.

Example

const water = new Plane(new Vector3(0, 1, 0), -waterLevel);

app.ticker.add(() => {
  underwaterFilter.enabled = water.distanceToPoint(camera.position) < 0;
});

See

Ray#intersectPlane For the point where a ray hits the plane

Index

Constructors

constructor

new Plane(normal?: Vector3, constant?: number): Plane
Creates a new Plane

Left out, the plane is x = 0 facing +X. A normal passed in becomes the plane's own; it is not copied.
Parameters
- Optionalnormal: Vector3
  The unit-length normal of the plane
- constant: number = 0
  The origin's signed distance from the plane
Returns Plane

Properties

constant

constant: number = 0

The origin's signed distance from the plane, negative when the origin is behind it

Example

water.constant = -waterLevel;

`Readonly`normal

normal: Vector3

The unit-length direction the plane faces; its positive side

Example

const facingUp = slope.normal.y > 0.7;

`Readonly`type

type: SHAPE_PRIMITIVE_3D = 'plane'

Names the shape without an instanceof check, like the type on pixi's 2D shapes

Default

'plane'

Methods

applyMatrix4

applyMatrix4(matrix: Matrix4, out?: Plane): this
Transforms this plane by an affine matrix, so points on it stay on it

Non-uniform scale is fine, and the normal comes out unit length. A mirroring matrix swaps which side of the plane is positive. Needs a unit-length normal, and matrix must be affine (bottom row [0, 0, 0, 1]), as a Container3D#worldTransform always is.
Parameters
- matrix: Matrix4
  The affine matrix to transform by
- out: Plane = ...
  Target to write the result into instead of mutating this plane
Returns this
The result plane for chaining
Example
```
const worldMirror = new Plane();

localMirror.applyMatrix4(mirror.worldTransform, worldMirror);
```

clone

clone(): Plane
Creates a new Plane with the same normal and constant

Returns Plane
The new plane
Example
```
const worldPlane = localPlane.clone().applyMatrix4(portal.worldTransform);
```

copyFrom

copyFrom(plane: Plane): this
Copies plane into this plane
Parameters
- plane: Plane
  The plane to copy from
Returns this
This plane for chaining
Example
```
reflectionPlane.copyFrom(water);
```

copyTo

copyTo<T extends Plane>(target: T): T
Copies this plane into target and returns it
Type Parameters
- T extends Plane
Parameters
- target: T
  The plane to copy into
Returns T
The given target
Example
```
water.copyTo(reflectionPlane);
```

distanceToPoint

distanceToPoint(point: PointData3D): number
Returns the signed distance from point to this plane (positive on the side of normal)
Parameters
- point: PointData3D
  The point to measure from
Returns number
The signed distance to the plane
Example
```
const depth = -water.distanceToPoint(diver.position);
```

equals

equals(plane: Plane): boolean
Returns true when normal and constant match plane exactly (no epsilon tolerance)
Parameters
- plane: Plane
  The plane to compare with
Returns boolean
Whether the normal and constant match
Example
```
if (!clipPlane.equals(lastClipPlane)) rebuildClipping(clipPlane);
```

intersectsBox

intersectsBox(box: Box): boolean
Returns true when this plane passes through box or touches it; same as Box#intersectsPlane
Parameters
- box: Box
  The box to test
Returns boolean
Whether the plane passes through or touches the box
Example
```
const halfSubmerged = water.intersectsBox(boatBounds);
```

intersectsRay

intersectsRay(ray: Ray): boolean
Returns true when ray hits this plane; same as Ray#intersectsPlane
Parameters
- ray: Ray
  The ray to test
Returns boolean
Whether the ray intersects this plane
Example
```
cursor.visible = ground.intersectsRay(pointerRay);
```

intersectsSphere

intersectsSphere(sphere: Sphere): boolean
Returns true when this plane passes through sphere or touches it; never for an empty sphere
Parameters
- sphere: Sphere
  The sphere to test
Returns boolean
Whether the plane passes through or touches the sphere
Example
```
const splashing = water.intersectsSphere(ball.boundingSphere);
```

normalize

normalize(out?: Plane): this
Scales the plane so normal has unit length

The constant scales with it, so the plane stays in place. A zero-length normal gives NaN.
Parameters
- out: Plane = ...
  Target to write the result into instead of mutating this plane
Returns this
The result plane for chaining
Example
```
const slope = new Plane(new Vector3(0, 2, 1), 0).normalize();
```

projectPoint

projectPoint(point: PointData3D, out?: Vector3): Vector3
Writes the closest point on this plane to point into out (or a new Vector3)
Parameters
- point: PointData3D
  The point to project
- Optionalout: Vector3
  Optional vector to write into; a new Vector3 when omitted
Returns Vector3
The projected point
Example
```
const footprint = new Vector3();

ground.projectPoint(ball.position, footprint);
blobShadow.position.copyFrom(footprint);
```

set

set(normal: PointData3D, constant: number): this
Sets the normal and constant of this plane, copying the normal
Parameters
- normal: PointData3D
  The unit-length normal
- constant: number
  The origin's signed distance from the plane
Returns this
This plane for chaining
Example
```
ceiling.set({ x: 0, y: -1, z: 0 }, roomHeight);
```

setComponents

setComponents(x: number, y: number, z: number, w: number): this
Sets the normal to (x, y, z) and the constant to w, the four numbers of a plane equation

Equations from elsewhere, such as rows of a projection matrix, rarely have a unit-length normal, so call Plane#normalize after.
Parameters
- x: number
  The x component of the normal
- y: number
  The y component of the normal
- z: number
  The z component of the normal
- w: number
  The plane constant
Returns this
This plane for chaining
Example
```
clipPlane.setComponents(equation[0], equation[1], equation[2], equation[3]).normalize();
```

setFromNormalAndCoplanarPoint

setFromNormalAndCoplanarPoint(normal: PointData3D, point: PointData3D): this
Sets this plane from a unit-length normal and a coplanar point
Parameters
- normal: PointData3D
  The unit-length normal
- point: PointData3D
  A point on the plane
Returns this
This plane for chaining
Example
```
mirrorPlane.setFromNormalAndCoplanarPoint({ x: 0, y: 0, z: 1 }, mirror.position);
```

toString

toString(): string

Advanced
Returns a string representation of this plane

Returns string
A string in the form [@pixi/3d/math:Plane normal=(1, 0, 0) constant=0]

Class Plane

Example

See

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Plane

Properties

constant

Example

Readonlynormal

Example

Readonlytype

Default

Methods

applyMatrix4

Parameters

Returns this

Example

clone

Returns Plane

Example

copyFrom

Parameters

Returns this

Example

copyTo

Type Parameters

Parameters

Returns T

Example

distanceToPoint

Parameters

Returns number

Example

equals

Parameters

Returns boolean

Example

intersectsBox

Parameters

Returns boolean

Example

intersectsRay

Parameters

Returns boolean

Example

intersectsSphere

Parameters

Returns boolean

Example

normalize

Parameters

Returns this

Example

projectPoint

Parameters

Returns Vector3

Example

set

Parameters

Returns this

Example

setComponents

Parameters

Returns this

Example

setFromNormalAndCoplanarPoint

Parameters

Returns this

Example

toString

Returns string

Settings

On This Page

`Readonly`normal

`Readonly`type