Plane

Defines a plane.

A plane is defined by a position axis returned by position.

Extends

• ElementarySurface

Constructors

Constructor

‍new Plane(position): Plane

Creates a plane from a position axis.

Parameters

position

Axis3d

Position axis of the plane.

Returns

Plane

Overrides

ElementarySurface.constructor

Constructor

‍new Plane(location, direction): Plane

Creates a plane from an origin point and normal direction.

Parameters

location

Point

Origin point of the plane.

direction

Direction

Normal direction of the plane.

Returns

Plane

Overrides

ElementarySurface.constructor

Constructor

‍new Plane(a, b, c, d): Plane

Creates a plane from the Cartesian equation Ax + By + Cz + D = 0.

Throws a RangeError if a, b, and c are all equal to 0.

Parameters

a

number

Coefficient A of the plane equation.

b

number

Coefficient B of the plane equation.

c

number

Coefficient C of the plane equation.

d

number

Coefficient D of the plane equation.

Returns

Plane

Overrides

ElementarySurface.constructor

Properties

position

‍readonly position: Axis3d

Position axis of the surface.

Inherited from

ElementarySurface.position

---

type

‍readonly type: SurfaceType = SurfaceType.UNDEFINED

Type of the surface.

Inherited from

ElementarySurface.type

Accessors

direction

Get Signature

‍get direction(): Direction

Returns the Z direction of the surface axis.

Returns

Direction

Inherited from

ElementarySurface.direction

---

id

Get Signature

‍get id(): bigint

Returns the unique identifier of the object.

Returns

bigint

Inherited from

ElementarySurface.id

---

location

Get Signature

‍get location(): Point

Returns the origin point of the surface axis.

Returns

Point

Inherited from

ElementarySurface.location