|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jme3.math.Plane
public class Plane
Plane
defines a plane where Normal dot (x,y,z) = Constant.
This provides methods for calculating a "distance" of a point from this
plane. The distance is pseudo due to the fact that it can be negative if the
point is on the non-normal side of the plane.
Nested Class Summary | |
---|---|
static class |
Plane.Side
|
Field Summary | |
---|---|
protected float |
constant
Constant of the plane. |
protected Vector3f |
normal
Vector normal to the plane. |
Constructor Summary | |
---|---|
Plane()
Constructor instantiates a new Plane object. |
|
Plane(Vector3f normal,
float constant)
Constructor instantiates a new Plane object. |
Method Summary | |
---|---|
Plane |
clone()
|
Vector3f |
getClosestPoint(Vector3f point)
|
Vector3f |
getClosestPoint(Vector3f point,
Vector3f store)
|
float |
getConstant()
getConstant returns the constant of the plane. |
Vector3f |
getNormal()
getNormal retrieves the normal of the plane. |
boolean |
isOnPlane(Vector3f point)
|
float |
pseudoDistance(Vector3f point)
pseudoDistance calculates the distance from this plane to
a provided point. |
void |
read(JmeImporter e)
|
Vector3f |
reflect(Vector3f point,
Vector3f store)
|
void |
setConstant(float constant)
setConstant sets the constant value that helps define the
plane. |
void |
setNormal(float x,
float y,
float z)
setNormal sets the normal of the plane. |
void |
setNormal(Vector3f normal)
setNormal sets the normal of the plane. |
void |
setOriginNormal(Vector3f origin,
Vector3f normal)
Initialize this plane using a point of origin and a normal. |
void |
setPlanePoints(AbstractTriangle t)
Initialize this plane using the three points of the given triangle. |
void |
setPlanePoints(Vector3f v1,
Vector3f v2,
Vector3f v3)
Initialize the Plane using the given 3 points as coplanar. |
java.lang.String |
toString()
toString returns a string thta represents the string
representation of this plane. |
Plane.Side |
whichSide(Vector3f point)
whichSide returns the side at which a point lies on the
plane. |
void |
write(JmeExporter e)
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected Vector3f normal
protected float constant
Constructor Detail |
---|
public Plane()
Plane
object. This is the
default object and contains a normal of (0,0,0) and a constant of 0.
public Plane(Vector3f normal, float constant)
Plane
object. The normal
and constant values are set at creation.
normal
- the normal of the plane.constant
- the constant of the plane.Method Detail |
---|
public void setNormal(Vector3f normal)
setNormal
sets the normal of the plane.
normal
- the new normal of the plane.public void setNormal(float x, float y, float z)
setNormal
sets the normal of the plane.
public Vector3f getNormal()
getNormal
retrieves the normal of the plane.
public void setConstant(float constant)
setConstant
sets the constant value that helps define the
plane.
constant
- the new constant value.public float getConstant()
getConstant
returns the constant of the plane.
public Vector3f getClosestPoint(Vector3f point, Vector3f store)
public Vector3f getClosestPoint(Vector3f point)
public Vector3f reflect(Vector3f point, Vector3f store)
public float pseudoDistance(Vector3f point)
pseudoDistance
calculates the distance from this plane to
a provided point. If the point is on the negative side of the plane the
distance returned is negative, otherwise it is positive. If the point is
on the plane, it is zero.
point
- the point to check.
public Plane.Side whichSide(Vector3f point)
whichSide
returns the side at which a point lies on the
plane. The positive values returned are: NEGATIVE_SIDE, POSITIVE_SIDE and
NO_SIDE.
point
- the point to check.
public boolean isOnPlane(Vector3f point)
public void setPlanePoints(AbstractTriangle t)
t
- the trianglepublic void setOriginNormal(Vector3f origin, Vector3f normal)
origin
- normal
- public void setPlanePoints(Vector3f v1, Vector3f v2, Vector3f v3)
v1
- the first pointv2
- the second pointv3
- the third pointpublic java.lang.String toString()
toString
returns a string thta represents the string
representation of this plane. It represents the normal as a
Vector3f
object, so the format is the following:
com.jme.math.Plane [Normal: org.jme.math.Vector3f [X=XX.XXXX, Y=YY.YYYY,
Z=ZZ.ZZZZ] - Constant: CC.CCCCC]
toString
in class java.lang.Object
public void write(JmeExporter e) throws java.io.IOException
write
in interface Savable
java.io.IOException
public void read(JmeImporter e) throws java.io.IOException
read
in interface Savable
java.io.IOException
public Plane clone()
clone
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |