#include
<MPlane.h>
List of all
members.
Detailed Description
A plane equation.
This class describes a mathematical plane.
Constructor & Destructor Documentation
Class default constructor. Create a new default plane.
MPlane::MPlane |
( |
const MPlane & |
src |
) |
|
Class copy constructor. Create a new vector and initialize it to
the same values as the given plane.
- Parameters:
-
[in] |
src |
the plane to copy |
Member Function Documentation
Returns the normal of the plane.
- Returns:
- The plane's normal
double MPlane::distance |
( |
|
) |
const |
Returns the distance of the plane along the normal.
- Returns:
- The distance of the plane along the normal
void MPlane::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] |
a |
The plane equation's x coefficent |
[in] |
b |
The plane equation's y coefficent |
[in] |
c |
The plane equation's z coefficent |
[in] |
d |
The plane equation's constant distance term |
void MPlane::setPlane |
( |
const MVector & |
n, |
|
|
double |
d |
|
|
) |
|
|
|
Set the equation of the plane from a normal and offset.
- Parameters:
-
[in] |
n |
The plane's normal |
[in] |
d |
The offset of the plane along the normal |
double MPlane::distance |
( |
const MVector & |
point |
) |
const |
Returns the unsigned distance from the plane to the specified
point.
- Parameters:
-
[in] |
point |
The point from which to calculate the distance |
- Returns:
- The distance from the specified point to the plane.
double MPlane::directedDistance |
( |
const MVector & |
point |
) |
const |
Returns the signed distance from the plane to the specified
point.
- Parameters:
-
[in] |
point |
The point from which to calculate the distance |
- Returns:
- The distance from the specified point to the plane.