com.bonzaiengine.math

Class Plane

java.lang.Object

com.bonzaiengine.math.Plane

public class Plane
extends java.lang.Object

All points (x, y, z) laying on the plane satisfies the plane equation:

  (a * x) + (b * y) + (c * z) + d = 0

(a, b, c, d) are the plane parameters. The normal of the plane is (a, b, c), .

Constructor Summary

Constructors

Constructor and Description
Plane()
Plane(float a, float b, float c, float d)

Method Summary

Modifier and Type	Method and Description
Plane	clone()
float	distance(Vec3 pt) Calculate the distance (oriented) between a point and this plane.
float	getA()
float	getB()
float	getC()
float	getD()
Vec3	getNormal()
Vec3	getRandomPointOnPlane(Vec3 dst)
Vec3	getRandomVectorOnPlane(Vec3 dst)
boolean	intersect(Percent dst, Line line) http://local.wasp.uwa.edu.au/~pbourke/geometry/planeline
boolean	intersect(Vec3 dst, Line line) http://local.wasp.uwa.edu.au/~pbourke/geometry/planeline
Quat	mirrorOrientation(Quat dst, Quat q)
Vec3	mirrorPoint(Vec3 dst, Vec3 point) point' = point - 2 * distance(point) * n
Vec3	mirrorVector(Vec3 dst, Vec3 vector) vector' = vector - 2 * dot(n,vector) * n
Vec3	projectAlongDirection(Vec3 dst, Vec3 pt, Vec3 dir)
Vec3	projectAlongDirection(Vec3 dst, Vec3 pt, Vec3 dir, boolean adjustDir)
Vec3	projectPoint(Vec3 dst, Vec3 point)
Vec3	projectVector(Vec3 dst, Vec3 vec)
Plane	set(float a, float b, float c, float d) Set a, b, c values of the Plane.
Plane	set(Plane plane)
Plane	setD(float d)
Plane	setFromDirections(Vec3 dir1OnPlane, Vec3 dir2OnPlane)
Plane	setFromDirections(Vec3 dir1OnPlane, Vec3 dir2OnPlane, Vec3 pointOnPlane)
Plane	setFromNormal(Vec3 normal, Vec3 point)
Plane	setNormal(Vec3 normal) Set the plane normal @param normal must be normalized

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Plane

public Plane()

Plane

public Plane(float a,
             float b,
             float c,
             float d)

Method Detail

clone

public final Plane clone()

Overrides:

clone in class java.lang.Object

setFromNormal

public final Plane setFromNormal(Vec3 normal,
                                 Vec3 point)

setFromDirections

public final Plane setFromDirections(Vec3 dir1OnPlane,
                                     Vec3 dir2OnPlane)

setFromDirections

public final Plane setFromDirections(Vec3 dir1OnPlane,
                                     Vec3 dir2OnPlane,
                                     Vec3 pointOnPlane)

set

public final Plane set(Plane plane)

set

public Plane set(float a,
                 float b,
                 float c,
                 float d)

Set a, b, c values of the Plane.
Those values are normalized, the magnitude is returned.

Parameters:

a -

b -

c -

Returns:

the magnitude of (a,b,c)

distance

public final float distance(Vec3 pt)

Calculate the distance (oriented) between a point and this plane.

Parameters:

pt - a point

Returns:

the distance of the point (positive or negative)

intersect

public final boolean intersect(Vec3 dst,
                               Line line)

http://local.wasp.uwa.edu.au/~pbourke/geometry/planeline

Parameters:

line -

dst -

Returns:

true if the intersection exists

intersect

public final boolean intersect(Percent dst,
                               Line line)

http://local.wasp.uwa.edu.au/~pbourke/geometry/planeline

Parameters:

line -

dst -

Returns:

true if the intersection exists

projectPoint

public final Vec3 projectPoint(Vec3 dst,
                               Vec3 point)

projectVector

public final Vec3 projectVector(Vec3 dst,
                                Vec3 vec)

projectAlongDirection

public final Vec3 projectAlongDirection(Vec3 dst,
                                        Vec3 pt,
                                        Vec3 dir)

projectAlongDirection

public final Vec3 projectAlongDirection(Vec3 dst,
                                        Vec3 pt,
                                        Vec3 dir,
                                        boolean adjustDir)

mirrorPoint

public final Vec3 mirrorPoint(Vec3 dst,
                              Vec3 point)

point' = point - 2 * distance(point) * n

mirrorVector

public final Vec3 mirrorVector(Vec3 dst,
                               Vec3 vector)

vector' = vector - 2 * dot(n,vector) * n

mirrorOrientation

public final Quat mirrorOrientation(Quat dst,
                                    Quat q)

getRandomVectorOnPlane

public final Vec3 getRandomVectorOnPlane(Vec3 dst)

Returns:

a random vector laying on the plane

getRandomPointOnPlane

public final Vec3 getRandomPointOnPlane(Vec3 dst)

Returns:

a random point laying on the plane

getNormal

public final Vec3 getNormal()

Returns:

the plane normal

setNormal

public final Plane setNormal(Vec3 normal)

Set the plane normal @param normal must be normalized

getA

public final float getA()

getB

public final float getB()

getC

public final float getC()

getD

public final float getD()

setD

public Plane setD(float d)