Public Member Functions | Static Public Member Functions

MPlane Class Reference

Search for all occurrences

Detailed Description

A plane equation.

This class describes a mathematical plane.

#include <MPlane.h>

List of all members.

Public Member Functions

 MPlane ()
 Class default constructor.
 MPlane (const MPlane &)
 Class copy constructor.
MVector normal () const
 Returns the normal of the plane.
double distance () const
 Returns the distance of the plane along the normal.
void setPlane (double a, double b, double c, double d)
 Directly set the equation of the plane in the form: ax + by +cz + d = 0.
void setPlane (const MVector &n, double d)
 Set the equation of the plane from a normal and offset.
double distance (const MVector &) const
 Returns the unsigned distance from the plane to the specified point.
double directedDistance (const MVector &) const
 Returns the signed distance from the plane to the specified point.

Static Public Member Functions

static const char * className ()
 Returns the name of this class.

Constructor & Destructor Documentation

MPlane ( )

Class default constructor.

Create a new default plane.

MPlane ( const MPlane src)

Class copy constructor.

Create a new vector and initialize it to the same values as the given plane.

Parameters:
[in]srcthe plane to copy

Member Function Documentation

MVector normal ( ) const

Returns the normal of the plane.

Returns:
The plane's normal
double distance ( ) const

Returns the distance of the plane along the normal.

Returns:
The distance of the plane along the normal
void setPlane ( double  a,
double  b,
double  c,
double  d 
)

Directly set the equation of the plane in the form: ax + by +cz + d = 0.

Parameters:
[in]aThe plane equation's x coefficent
[in]bThe plane equation's y coefficent
[in]cThe plane equation's z coefficent
[in]dThe plane equation's constant distance term
void setPlane ( const MVector n,
double  d 
)

Set the equation of the plane from a normal and offset.

Parameters:
[in]nThe plane's normal
[in]dThe offset of the plane along the normal
double distance ( const MVector point) const

Returns the unsigned distance from the plane to the specified point.

Parameters:
[in]pointThe point from which to calculate the distance
Returns:
The distance from the specified point to the plane.
double directedDistance ( const MVector point) const

Returns the signed distance from the plane to the specified point.

Parameters:
[in]pointThe point from which to calculate the distance
Returns:
The distance from the specified point to the plane.
const char * className ( ) [static]

Returns the name of this class.

Returns:
The name of this class.

MPlane MPlane MPlane MPlane MPlane MPlane MPlane MPlane MPlane MPlane
MPlane MPlane MPlane MPlane MPlane MPlane MPlane MPlane MPlane MPlane