math# Plane

Represents a mathematical plane in 3D space.

Constructor

new Plane()

Members

XY

Creates a Plane object representing the XY plane.

XZ

Creates a Plane object representing the XZ plane.

YX

Creates a Plane object representing the YX plane.

YZ

Creates a Plane object representing the YZ plane.

ZX

Creates a Plane object representing the ZX plane.

ZY

Creates a Plane object representing the ZY plane.

axis

Returns the axis of the plane.

normal

Returns the normal vector of the plane.

origin

Returns the origin of the plane.

xDirection

Returns the x-direction vector of the plane.

Methods

offset(offset) → {Plane}

Offsets the plane by a given vector.

Parameters:
NameTypeDescription
offsetVector

The offset vector to apply to the plane's origin.

Returns:

A new Plane object with the origin offset by the given vector.

Type: 
Plane

(static) fromFace(face) → {Plane|undefined}

Creates a Plane object from a given Face object.

Parameters:
NameTypeDescription
faceFace

The face from which to create a Plane object.

Returns:

A new Plane object if the face is a plane, otherwise undefined.

Type: 
Plane | undefined