Plane

class Communicator.Plane()

Object representing a Plane.

Properties

• d

• normal

Methods

• assign()

• copy()

• determineSide()

• distanceToPoint()

• equals()

• getCoefficients()

• intersectsRay()

• rayIntersection()

• setFromCoefficients()

• setFromPointAndNormal()

• setFromPoints()

• createFromCoefficients()

• createFromPointAndNormal()

• createFromPoints()

---

Properties

Plane.d

Type

number

Plane.normal

Type

Point3()

Methods

assign

Plane.assign(plane)

Sets this plane equal to another plane

Arguments

• plane (Plane()) – the plane to assign

Return type

void

copy

Plane.copy()

Creates a copy of this plane

Return type

Plane()

Returns

a copy of this plane object

determineSide

Plane.determineSide(p)

Returns true if the point is on the side of the plane that the plane’s normal is directed. Returns false otherwise.

Arguments

• p (Point3()) – The point to test.

Return type

boolean

distanceToPoint

Plane.distanceToPoint(point)

Arguments

• point (Point3()) –

Return type

number

equals

Plane.equals(plane)

Returns true if the normal and d value are the same.

Arguments

• plane (Plane()) –

Return type

boolean

getCoefficients

Plane.getCoefficients()

Return type

(number, number, number, number)

intersectsRay

Plane.intersectsRay(ray[, outPoint])

Arguments

• ray (Ray()) –

• outPoint (Point3()) – optional

Return type

boolean

rayIntersection

Plane.rayIntersection(ray)

Arguments

• ray (Ray()) –

Return type

Point3() | null

setFromCoefficients

Plane.setFromCoefficients(a, b, c, d)

Arguments

• a (number()) –

• b (number()) –

• c (number()) –

• d (number()) –

Return type

void

setFromPointAndNormal

Plane.setFromPointAndNormal(point, normal)

Arguments

• point (Point3()) –

• normal (Point3()) –

Return type

Plane()

setFromPoints

Plane.setFromPoints(p1, p2, p3)

Update the plane to pass through the three points

Arguments

• p1 (Point3()) –

• p2 (Point3()) –

• p3 (Point3()) –

Return type

void

static createFromCoefficients

Plane.createFromCoefficients(a, b, c, d)

Arguments

• a (number()) –

• b (number()) –

• c (number()) –

• d (number()) –

Return type

Plane()

static createFromPointAndNormal

Plane.createFromPointAndNormal(point, normal)

Arguments

• point (Point3()) –

• normal (Point3()) –

Return type

Plane()

static createFromPoints

Plane.createFromPoints(p1, p2, p3)

Arguments

• p1 (Point3()) –

• p2 (Point3()) –

• p3 (Point3()) –

Return type

Plane()