Class Plane

Object
   |
   +--Plane

class Plane

The Plane class is a very useful definition of a plane. A Plane object consists of a base point and a normal vector, thus implicitly representing the infinitude of a plane.
Defined in Plane.js

Requires:

- Line

Field Detail

base

point3D base

The "base" point of the plane.

norm

point3D norm

The normal vector of the plane, which wholly defines the Plane along with the base point.

XY

<static> Plane XY

The XY-plane. Base = (0,0,0), Direction = Vector.k

XZ

<static> Plane XZ

Same as Plane.ZX

YX

<static> Plane YX

Same as Plane.XY

YZ

<static> Plane YZ

The YZ-plane. Base = (0,0,0), Direction = Vector.i

ZX

<static> Plane ZX

The ZX-plane. Base = (0,0,0), Direction = Vector.j

ZY

<static> Plane ZY

Same as Plane.YZ

Plane

Plane(<point3D> base, <point3D> v1, <point3D> v2)

The constructor function for a new Plane.

Parameters:
base - the base point of the plane; if a Plane object, will create a duplicate of the plane
v1 - (can also be a 3D Vector) the normal vector if only one vector is supplied
v2 - (Optional) (can also be a 3D Vector) if supplied, assume that the three parameters are base point and two vectors, so the normal becomes (v1 cross v2)

Requires:
- Line

contains

Boolean contains(<Object> obj)

Tests if a line or point lies in the plane.

Parameters:
obj - the line or point to test

Returns:
true if plane contains line or point (also true if obj is an equivalent plane)

distanceFrom

Number distanceFrom(<Object> obj)

Gets the distance of a plane, line or point from the plane.

Parameters:
obj - the plane, line, or point from which to find the distance

Returns:
the distance between the plane and obj

equalTo

Boolean equalTo(<Plane> plane)

Tests whether two planes are equal.

Parameters:
plane - the plane to test for equality

Returns:
true if planes are equal, false otherwise

intersection

Object intersection(<Object> obj)

Gets the intersection of a plane with a given Line or Plane.

Parameters:
obj - the Line or Plane with which to find the intersection

Returns:
the intersection of this and Plane.prototype.obj = point3D (aka Vector);if obj is a Line, a Line if obj is a Plane

intersects

Boolean intersects(<Object> obj)

Tests to see if a line or plane intersects with this plane.

Parameters:
obj - the line or plane to test

Returns:
true iff an intersection exists, false otherwise

isParallel

Boolean isParallel(<Object> obj)

Tests to see if the plane is parallel to a given Plane or Line.

Parameters:
obj - the plane or line to check to see if parallel

Returns:
true if parallel, false otherwise

isPerpendicular

Boolean isPerpendicular(plane)

Tests to see if two planes are perpendicular to each other.

Returns:
true iff planes are perpendicular, false otherwise

pointClosestTo

Object pointClosestTo(<point3D> point)

Finds the point in the plane closest to the given point.

Parameters:
point - (can also be a 3D Vector) the point to which to find the closest point in the plane

Returns:
point3D or Vector (depending on type of point above) that is the closest point on the plane to point

rotate

Plane rotate(<Number> deg, line)

Rotates a plane through deg degrees about an arbitrary line.

Parameters:
deg - the number of degrees (in radians) to rotate the plane
the - Line about which to rotate the plane

Returns:
a new Plane that is the old rotated deg about line

toString

String toString()

Returns a string representation of the Plane.

Returns:
the string version of the plane

translate

Plane translate(<Number> dx, <Number> dy, <Number> dz)

Translates a plane by dx, dy and dz (normal does not change, only the base)

Parameters:
dx - the x translation
dy - the y translation
dz - the z translation

Returns:
the translated plane