In file include/csgeom/math3d.h:

class csPlane

A plane in 3D space

Public Fields

float DD
The D component of the plane.
csVector3 norm
The normal vector (or the (A,B,C) components).

Public Methods

inline float& A()
Return the A component of this plane.
inline float& B()
Return the B component of this plane.
inline float& C()
Return the C component of this plane.
static float Classify(float A, float B, float C, float D, const csVector3& pt)
Classify a vector with regards to four plane components.
inline float Classify(const csVector3& pt)
Classify the given vector with regards to this plane.
csPlane(float a, float b, float c, float d=0)
Initialize the plane.
csPlane()
Initialize to the xy plane.
csPlane(const csVector3& plane_norm, float d=0)
Initialize the plane.
inline float& D()
Return the D component of this plane.
inline float Distance(const csVector3& pt)
Compute the distance from the given vector to this plane
void Invert()
Reverses the direction of the plane while maintianing the plane itself.
inline csVector3& Normal()
Return the normal vector of this plane.
void Normalize()
Normalizes the plane equation so that 'norm' is a unit vector.
inline void Set(float a, float b, float c, float d)
Set the value of the four plane components.

Documentation

A plane in 3D space. The plane is given by the equation AAx + BBy + CCz + DD = 0, Where (AA,BB,CC) is given by the vector 'norm'.
csVector3 norm
The normal vector (or the (A,B,C) components).

float DD
The D component of the plane.

csPlane()
Initialize to the xy plane.

csPlane(const csVector3& plane_norm, float d=0)
Initialize the plane.

csPlane(float a, float b, float c, float d=0)
Initialize the plane.

inline csVector3& Normal()
Return the normal vector of this plane.

inline float& A()
Return the A component of this plane.

inline float& B()
Return the B component of this plane.

inline float& C()
Return the C component of this plane.

inline float& D()
Return the D component of this plane.

inline void Set(float a, float b, float c, float d)
Set the value of the four plane components.

inline float Classify(const csVector3& pt)
Classify the given vector with regards to this plane.

static float Classify(float A, float B, float C, float D, const csVector3& pt)
Classify a vector with regards to four plane components.

inline float Distance(const csVector3& pt)
Compute the distance from the given vector to this plane. This function assumes that 'norm' is a unit vector. If not, the function returns distance times the magnitude of 'norm'.

void Invert()
Reverses the direction of the plane while maintianing the plane itself.

void Normalize()
Normalizes the plane equation so that 'norm' is a unit vector.

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de