Class Plane

Immutable plane.

Implements

IPlane

Index

Constructors

Properties

firstAxis normal origin xy yz zx

Methods

point project projectedAngle equals

Constructors

constructor

new Plane(origin: Vec3, normal: Vec3, firstAxis: Vec3): Plane
Constructor
Parameters
- origin: Vec3
  The origin.
- normal: Vec3
  The normal.
- firstAxis: Vec3
  The first axis.
Returns Plane

Properties

`Readonly`firstAxis

firstAxis: Vec3

The first axis of the plane.

`Readonly`normal

normal: Vec3

The normal of the plane.

`Readonly`origin

origin: Vec3

The origin of the plane.

`Static` `Readonly`xy

xy: Plane = ...

Plane aligned with the x and y axes, with normal in the z axis.

`Static` `Readonly`yz

yz: Plane = ...

Plane aligned with the y and z axes, with normal in the x axis.

`Static` `Readonly`zx

zx: Plane = ...

Plane aligned with the z and x axes, with normal in the y axis.

Methods

point

point(coordinate: IVec2): Vec3
Converts a 2D coordinate in the plane's local coordinate system to a 3D point.
Parameters
- coordinate: IVec2
  The 2D coordinate.
Returns Vec3
The corresponding 3D point.

project

project(point: IVec3): Vec3
Projects a point onto the plane.
Parameters
- point: IVec3
  The point.
Returns Vec3
The projected point.

projectedAngle

projectedAngle(point: IVec3): number
Calculates the angle for the specified point when projected onto the plane.
Parameters
- point: IVec3
  The point.
Returns number
The angle for the projected point.

Remarks
The angle is measured from the first axis about the normal in a right-handed sense.

Implementation of IPlane.projectedAngle

`Static`equals

equals(lhs: IPlane, rhs: IPlane): boolean
Determines whether two planes are exactly equal.
Parameters
- lhs: IPlane
  The first plane.
- rhs: IPlane
  The second plane.
Returns boolean
True if the two planes are exactly equal, false otherwise.