Fork me
BeyondAR
Augmented Reality Framework for Android
 All Classes Functions Variables
com.beyondar.android.util.math.geom.Plane Class Reference

Represents a geometric plane. More...

Public Member Functions

 Plane (Point3 p, Vector3 n)
 Constructs a plane from a point and its normal. More...
 
 Plane (Point3 p1, Point3 p2, Point3 p3)
 Constructs a plane from three points. More...
 
Vector3 getNormal ()
 Returns the plane's normal vector. More...
 
Point3 getPoint ()
 Returns the plane's point. More...
 
float intersects (Ray ray)
 Returns the t parameter for the intersection with the given ray. More...
 

Static Public Member Functions

static Plane getVolatilePlane (Point3 point, Vector3 normal)
 Returns a volatile plane from a point and its normal. More...
 

Detailed Description

Represents a geometric plane.

Constructor & Destructor Documentation

com.beyondar.android.util.math.geom.Plane.Plane ( Point3  p,
Vector3  n 
)

Constructs a plane from a point and its normal.

Parameters
pPoint contained by the plane
nNormal vector for the plane
com.beyondar.android.util.math.geom.Plane.Plane ( Point3  p1,
Point3  p2,
Point3  p3 
)

Constructs a plane from three points.

Parameters
p1Point 1
p2Point 2
p3Point 3

Member Function Documentation

Vector3 com.beyondar.android.util.math.geom.Plane.getNormal ( )

Returns the plane's normal vector.

Returns
the plane's normal vector
Point3 com.beyondar.android.util.math.geom.Plane.getPoint ( )

Returns the plane's point.

Returns
the plane's point
static Plane com.beyondar.android.util.math.geom.Plane.getVolatilePlane ( Point3  point,
Vector3  normal 
)
static

Returns a volatile plane from a point and its normal.

Parameters
pointPoint contained by the plane
normalNormal vector for the plane
float com.beyondar.android.util.math.geom.Plane.intersects ( Ray  ray)

Returns the t parameter for the intersection with the given ray.

If plane and ray has no intersection returns -1 representing infinite. Value returned must be used with Ray#getPoint(float)

Parameters
rayRay to be checked
Returns
the t parameter for the ray in the intersection point. If plane and ray has no intersection returns -1

The documentation for this class was generated from the following file: