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

Communicator.Plane.d

Communicator.Plane.normal

Methods

assign

Communicator.Plane.assign(plane)

Sets this plane equal to another plane

Arguments

plane (Communicator.Plane()) – the plane to assign

Return type

void

copy

Communicator.Plane.copy()

Creates a copy of this plane

Return type: Communicator.Plane
Returns: a copy of this plane object

determineSide

Communicator.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 (Communicator.Point3()) – The point to test.

Return type

boolean

distanceToPoint

Communicator.Plane.distanceToPoint(point)

Arguments

point (Communicator.Point3()) –

Return type

number

equals

Communicator.Plane.equals(plane)

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

Arguments

plane (Communicator.Plane()) –

Return type

boolean

getCoefficients

Communicator.Plane.getCoefficients()

Return type: (number, number, number, number)

intersectsRay

Communicator.Plane.intersectsRay(ray, outPoint)

Arguments

ray (Communicator.Ray()) –
outPoint (Communicator.Point3()) –

Return type

boolean

rayIntersection

Communicator.Plane.rayIntersection(ray)

Arguments

ray (Communicator.Ray()) –

Return type

{ }

setFromCoefficients

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

Arguments

a (number()) –
b (number()) –
c (number()) –
d (number()) –

Return type

void

setFromPointAndNormal

Communicator.Plane.setFromPointAndNormal(point, normal)

Arguments

point (Communicator.Point3()) –
normal (Communicator.Point3()) –

Return type

Communicator.Plane

setFromPoints

Communicator.Plane.setFromPoints(p1, p2, p3)

Update the plane to pass through the three points

Arguments

Return type

void

createFromCoefficients

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

Arguments

a (number()) –
b (number()) –
c (number()) –
d (number()) –

Return type

Communicator.Plane

createFromPointAndNormal

Communicator.Plane.createFromPointAndNormal(point, normal)

Arguments

point (Communicator.Point3()) –
normal (Communicator.Point3()) –

Return type

Communicator.Plane

createFromPoints

Communicator.Plane.createFromPoints(p1, p2, p3)

Arguments

Return type

Communicator.Plane