

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
java.lang.Object org.apache.commons.math3.geometry.euclidean.threed.Plane
public class Plane
The class represent planes in a three dimensional space.
Constructor Summary  

Plane(Plane plane)
Copy constructor. 

Plane(Vector3D normal)
Build a plane normal to a given direction and containing the origin. 

Plane(Vector3D p,
Vector3D normal)
Build a plane from a point and a normal. 

Plane(Vector3D p1,
Vector3D p2,
Vector3D p3)
Build a plane from three points. 
Method Summary  

boolean 
contains(Vector3D p)
Check if the instance contains a point. 
Plane 
copySelf()
Copy the instance. 
Vector3D 
getNormal()
Get the normalized normal vector. 
double 
getOffset(Plane plane)
Get the offset (oriented distance) of a parallel plane. 
double 
getOffset(Vector<Euclidean3D> point)
Get the offset (oriented distance) of a point. 
Vector3D 
getOrigin()
Get the origin point of the plane frame. 
Vector3D 
getPointAt(Vector2D inPlane,
double offset)
Get one point from the 3Dspace. 
Vector3D 
getU()
Get the plane first canonical vector. 
Vector3D 
getV()
Get the plane second canonical vector. 
Vector3D 
intersection(Line line)
Get the intersection of a line with the instance. 
Line 
intersection(Plane other)
Build the line shared by the instance and another plane. 
static Vector3D 
intersection(Plane plane1,
Plane plane2,
Plane plane3)
Get the intersection point of three planes. 
boolean 
isSimilarTo(Plane plane)
Check if the instance is similar to another plane. 
void 
reset(Plane original)
Reset the instance from another one. 
void 
reset(Vector3D p,
Vector3D normal)
Reset the instance as if built from a point and a normal. 
void 
revertSelf()
Revert the plane. 
Plane 
rotate(Vector3D center,
Rotation rotation)
Rotate the plane around the specified point. 
boolean 
sameOrientationAs(Hyperplane<Euclidean3D> other)
Check if the instance has the same orientation as another hyperplane. 
Vector3D 
toSpace(Vector<Euclidean2D> point)
Transform an inplane point into a 3D space point. 
Vector2D 
toSubSpace(Vector<Euclidean3D> point)
Transform a 3D space point into an inplane point. 
Plane 
translate(Vector3D translation)
Translate the plane by the specified amount. 
SubPlane 
wholeHyperplane()
Build a region covering the whole hyperplane. 
PolyhedronsSet 
wholeSpace()
Build a region covering the whole space. 
Methods inherited from class java.lang.Object 

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 
Constructor Detail 

public Plane(Vector3D normal) throws MathArithmeticException
normal
 normal direction to the plane
MathArithmeticException
 if the normal norm is too smallpublic Plane(Vector3D p, Vector3D normal) throws MathArithmeticException
p
 point belonging to the planenormal
 normal direction to the plane
MathArithmeticException
 if the normal norm is too smallpublic Plane(Vector3D p1, Vector3D p2, Vector3D p3) throws MathArithmeticException
The plane is oriented in the direction of
(p2p1) ^ (p3p1)
p1
 first point belonging to the planep2
 second point belonging to the planep3
 third point belonging to the plane
MathArithmeticException
 if the points do not constitute a planepublic Plane(Plane plane)
The instance created is completely independant of the original one. A deep copy is used, none of the underlying object are shared.
plane
 plane to copyMethod Detail 

public Plane copySelf()
The instance created is completely independant of the original one. A deep copy is used, none of the underlying objects are shared (except for immutable objects).
copySelf
in interface Hyperplane<Euclidean3D>
public void reset(Vector3D p, Vector3D normal) throws MathArithmeticException
p
 point belonging to the planenormal
 normal direction to the plane
MathArithmeticException
 if the normal norm is too smallpublic void reset(Plane original)
The updated instance is completely independant of the original one. A deep reset is used none of the underlying object is shared.
original
 plane to reset frompublic Vector3D getOrigin()
The point returned is the orthogonal projection of the 3Dspace origin in the plane.
public Vector3D getNormal()
The frame defined by (getU
, getV
,
getNormal
) is a rigthhanded orthonormalized
frame).
getU()
,
getV()
public Vector3D getU()
The frame defined by (getU
, getV
,
getNormal
) is a rigthhanded orthonormalized
frame).
getV()
,
getNormal()
public Vector3D getV()
The frame defined by (getU
, getV
,
getNormal
) is a rigthhanded orthonormalized
frame).
getU()
,
getNormal()
public void revertSelf()
Replace the instance by a similar plane with opposite orientation.
The new plane frame is chosen in such a way that a 3D point that had
(x, y)
inplane coordinates and z
offset with
respect to the plane and is unaffected by the change will have
(y, x)
inplane coordinates and z
offset with
respect to the new plane. This means that the u
and v
vectors returned by the getU()
and getV()
methods are exchanged,
and the w
vector returned by the getNormal()
method is
reversed.
public Vector2D toSubSpace(Vector<Euclidean3D> point)
toSubSpace
in interface Embedding<Euclidean3D,Euclidean2D>
point
 point of the space (must be a Vector3D
instance)
Vector2D
instance)toSpace(org.apache.commons.math3.geometry.Vector)
public Vector3D toSpace(Vector<Euclidean2D> point)
toSpace
in interface Embedding<Euclidean3D,Euclidean2D>
point
 inplane point (must be a Vector2D
instance)
Vector3D
instance)toSubSpace(org.apache.commons.math3.geometry.Vector)
public Vector3D getPointAt(Vector2D inPlane, double offset)
inPlane
 desired inplane coordinates for the point in the
planeoffset
 desired offset for the point
public boolean isSimilarTo(Plane plane)
Planes are considered similar if they contain the same points. This does not mean they are equal since they can have opposite normals.
plane
 plane to which the instance is compared
public Plane rotate(Vector3D center, Rotation rotation)
The instance is not modified, a new instance is created.
center
 rotation centerrotation
 vectorial rotation operator
public Plane translate(Vector3D translation)
The instance is not modified, a new instance is created.
translation
 translation to apply
public Vector3D intersection(Line line)
line
 line intersecting the instance
public Line intersection(Plane other)
other
 other plane
Line
instance)public static Vector3D intersection(Plane plane1, Plane plane2, Plane plane3)
plane1
 first plane1plane2
 second plane2plane3
 third plane2
public SubPlane wholeHyperplane()
wholeHyperplane
in interface Hyperplane<Euclidean3D>
public PolyhedronsSet wholeSpace()
wholeSpace
in interface Hyperplane<Euclidean3D>
PolyhedronsSet
instance)public boolean contains(Vector3D p)
p
 point to check
public double getOffset(Plane plane)
This method should be called only for parallel planes otherwise the result is not meaningful.
The offset is 0 if both planes are the same, it is positive if the plane is on the plus side of the instance and negative if it is on the minus side, according to its natural orientation.
plane
 plane to check
public double getOffset(Vector<Euclidean3D> point)
The offset is 0 if the point is on the underlying hyperplane, it is positive if the point is on one particular side of the hyperplane, and it is negative if the point is on the other side, according to the hyperplane natural orientation.
getOffset
in interface Hyperplane<Euclidean3D>
point
 point to check
public boolean sameOrientationAs(Hyperplane<Euclidean3D> other)
sameOrientationAs
in interface Hyperplane<Euclidean3D>
other
 other hyperplane to check against the instance


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 