Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members | Tutorials

# irr::core::plane3d< T > Class Template Reference

Template plane class with some intersection testing methods. More...

`#include <plane3d.h>`

List of all members.

## Public Member Functions

EIntersectionRelation3D | classifyPointRelation (const vector3d< T > &point) const
| Classifies the relation of a point to this plane.
bool | existsIntersection (const plane3d< T > &other) const
| Tests if there is an intersection with the other plane.
T | getDistanceTo (const vector3d< T > &point) const
| Get the distance to a point.
bool | getIntersectionWithLimitedLine (const vector3d< T > &linePoint1, const vector3d< T > &linePoint2, vector3d< T > &outIntersection) const
| Get an intersection with a 3d line, limited between two 3d points.
bool | getIntersectionWithLine (const vector3d< T > &linePoint, const vector3d< T > &lineVect, vector3d< T > &outIntersection) const
| Get an intersection with a 3d line.
bool | getIntersectionWithPlane (const plane3d< T > &other, vector3d< T > &outLinePoint, vector3d< T > &outLineVect) const
| Intersects this plane with another.
bool | getIntersectionWithPlanes (const plane3d< T > &o1, const plane3d< T > &o2, vector3d< T > &outPoint) const
| Get the intersection point with two other planes if there is one.
f32 | getKnownIntersectionWithLine (const vector3d< T > &linePoint1, const vector3d< T > &linePoint2) const
| Get percentage of line between two points where an intersection with this plane happens.
vector3d< T > | getMemberPoint () const
| Gets a member point of the plane.
bool | isFrontFacing (const vector3d< T > &lookDirection) const
| Test if the triangle would be front or backfacing from any point.
bool | operator!= (const plane3d< T > &other) const
bool | operator== (const plane3d< T > &other) const
| plane3d (const vector3d< T > &normal, const T d)
| plane3d (const vector3d< T > &point1, const vector3d< T > &point2, const vector3d< T > &point3)
| plane3d (T px, T py, T pz, T nx, T ny, T nz)
| plane3d (const vector3d< T > &MPoint, const vector3d< T > &Normal)
| plane3d ()
void | recalculateD (const vector3d< T > &MPoint)
| Recalculates the distance from origin by applying a new member point to the plane.
void | setPlane (const vector3d< T > &point1, const vector3d< T > &point2, const vector3d< T > &point3)
void | setPlane (const vector3d< T > &nvect, T d)
void | setPlane (const vector3d< T > &point, const vector3d< T > &nvector)

## Public Attributes

T | D
| Distance from origin.
vector3d< T > | Normal
| Normal vector of the plane.

## Detailed Description

### template<class T>
class irr::core::plane3d< T >

Template plane class with some intersection testing methods.

Definition at line 28 of file plane3d.h.

## Constructor & Destructor Documentation

template<class T>

irr::core::plane3d< T >::plane3d | ( |  | ) | `[inline]`

Definition at line 34 of file plane3d.h.

template<class T>

irr::core::plane3d< T >::plane3d | ( | const vector3d< T > & | MPoint,
|  | const vector3d< T > & | Normal |
| ) |  |  | `[inline]`

Definition at line 36 of file plane3d.h.

template<class T>

irr::core::plane3d< T >::plane3d | ( | T | px,
|  | T | py,
|  | T | pz,
|  | T | nx,
|  | T | ny,
|  | T | nz |
| ) |  |  | `[inline]`

Definition at line 38 of file plane3d.h.

template<class T>

irr::core::plane3d< T >::plane3d | ( | const vector3d< T > & | point1,
|  | const vector3d< T > & | point2,
|  | const vector3d< T > & | point3 |
| ) |  |  | `[inline]`

Definition at line 40 of file plane3d.h.

template<class T>

irr::core::plane3d< T >::plane3d | ( | const vector3d< T > & | normal,
|  | const T | d |
| ) |  |  | `[inline]`

Definition at line 43 of file plane3d.h.

## Member Function Documentation

template<class T>

EIntersectionRelation3D irr::core::plane3d< T >::classifyPointRelation | ( | const vector3d< T > & | point | ) | const`[inline]`

Classifies the relation of a point to this plane.

Parameters:

  | point | Point to classify its relation.

Returns:
  ISREL3D_FRONT if the point is in front of the plane, ISREL3D_BACK if the point is behind of the plane, and ISREL3D_PLANAR if the point is within the plane.

Definition at line 130 of file plane3d.h.

template<class T>

bool irr::core::plane3d< T >::existsIntersection | ( | const plane3d< T > & | other | ) | const`[inline]`

Tests if there is an intersection with the other plane.

Returns:
  True if there is a intersection.

Definition at line 157 of file plane3d.h.

template<class T>

T irr::core::plane3d< T >::getDistanceTo | ( | const vector3d< T > & | point | ) | const`[inline]`

Get the distance to a point.

Note that this only works if the normal is normalized.

Definition at line 217 of file plane3d.h.

template<class T>

bool irr::core::plane3d< T >::getIntersectionWithLimitedLine | ( | const vector3d< T > & | linePoint1,
|  | const vector3d< T > & | linePoint2,
|  | vector3d< T > & | outIntersection |
| ) |  |  | const`[inline]`

Get an intersection with a 3d line, limited between two 3d points.

Parameters:

  | linePoint1 | Point 1 of the line.
  | linePoint2 | Point 2 of the line.
  | outIntersection | Place to store the intersection point, if there is one.

Returns:
  True if there was an intersection, false if there was not.

Definition at line 116 of file plane3d.h.

template<class T>

bool irr::core::plane3d< T >::getIntersectionWithLine | ( | const vector3d< T > & | linePoint,
|  | const vector3d< T > & | lineVect,
|  | vector3d< T > & | outIntersection |
| ) |  |  | const`[inline]`

Get an intersection with a 3d line.

Parameters:

  | lineVect | Vector of the line to intersect with.
  | linePoint | Point of the line to intersect with.
  | outIntersection | Place to store the intersection point, if there is one.

Returns:
  True if there was an intersection, false if there was not.

Definition at line 81 of file plane3d.h.

Referenced by irr::core::plane3d< f32 >::getIntersectionWithLimitedLine(), and irr::core::plane3d< f32 >::getIntersectionWithPlanes().

template<class T>

bool irr::core::plane3d< T >::getIntersectionWithPlane | ( | const plane3d< T > & | other,
|  | vector3d< T > & | outLinePoint,
|  | vector3d< T > & | outLineVect |
| ) |  |  | const`[inline]`

Intersects this plane with another.

Parameters:

  | other | Other plane to intersect with.
  | outLinePoint | Base point of intersection line.
  | outLineVect | Vector of intersection.

Returns:
  True if there is a intersection, false if not.

Definition at line 168 of file plane3d.h.

Referenced by irr::core::plane3d< f32 >::getIntersectionWithPlanes().

template<class T>

bool irr::core::plane3d< T >::getIntersectionWithPlanes | ( | const plane3d< T > & | o1,
|  | const plane3d< T > & | o2,
|  | vector3d< T > & | outPoint |
| ) |  |  | const`[inline]`

Get the intersection point with two other planes if there is one.

Definition at line 190 of file plane3d.h.

Referenced by irr::scene::SViewFrustum::getFarLeftDown(), irr::scene::SViewFrustum::getFarLeftUp(), irr::scene::SViewFrustum::getFarRightDown(), and irr::scene::SViewFrustum::getFarRightUp().

template<class T>

f32 irr::core::plane3d< T >::getKnownIntersectionWithLine | ( | const vector3d< T > & | linePoint1,
|  | const vector3d< T > & | linePoint2 |
| ) |  |  | const`[inline]`

Get percentage of line between two points where an intersection with this plane happens.

Only useful if known that there is an intersection.

Parameters:

  | linePoint1 | Point1 of the line to intersect with.
  | linePoint2 | Point2 of the line to intersect with.

Returns:
  Where on a line between two points an intersection with this plane happened. For example, 0.5 is returned if the intersection happened exactly in the middle of the two points.

Definition at line 102 of file plane3d.h.

Referenced by irr::scene::SViewFrustum::clipLine().

template<class T>

vector3d<T> irr::core::plane3d< T >::getMemberPoint | ( |  | ) | const`[inline]`

Gets a member point of the plane.

Definition at line 150 of file plane3d.h.

Referenced by irr::core::CMatrix4< T >::transformPlane().

template<class T>

bool irr::core::plane3d< T >::isFrontFacing | ( | const vector3d< T > & | lookDirection | ) | const`[inline]`

Test if the triangle would be front or backfacing from any point.

Thus, this method assumes a camera position from which the triangle is definitely visible when looking into the given direction. Note that this only works if the normal is Normalized. Do not use this method with points as it will give wrong results!

Parameters:

  | lookDirection,: | Look direction.

Returns:
  True if the plane is front facing and false if it is backfacing.

Definition at line 209 of file plane3d.h.

template<class T>

bool irr::core::plane3d< T >::operator!= | ( | const plane3d< T > & | other | ) | const`[inline]`

Definition at line 49 of file plane3d.h.

template<class T>

bool irr::core::plane3d< T >::operator== | ( | const plane3d< T > & | other | ) | const`[inline]`

Definition at line 47 of file plane3d.h.

template<class T>

void irr::core::plane3d< T >::recalculateD | ( | const vector3d< T > & | MPoint | ) | `[inline]`

Recalculates the distance from origin by applying a new member point to the plane.

Definition at line 144 of file plane3d.h.

Referenced by irr::core::plane3d< f32 >::plane3d(), and irr::core::plane3d< f32 >::setPlane().

template<class T>

void irr::core::plane3d< T >::setPlane | ( | const vector3d< T > & | point1,
|  | const vector3d< T > & | point2,
|  | const vector3d< T > & | point3 |
| ) |  |  | `[inline]`

Definition at line 65 of file plane3d.h.

template<class T>

void irr::core::plane3d< T >::setPlane | ( | const vector3d< T > & | nvect,
|  | T | d |
| ) |  |  | `[inline]`

Definition at line 59 of file plane3d.h.

template<class T>

void irr::core::plane3d< T >::setPlane | ( | const vector3d< T > & | point,
|  | const vector3d< T > & | nvector |
| ) |  |  | `[inline]`

Definition at line 53 of file plane3d.h.

Referenced by irr::core::plane3d< f32 >::plane3d(), and irr::core::CMatrix4< T >::transformPlane().

## Member Data Documentation

template<class T>

T irr::core::plane3d< T >::D

Distance from origin.

Definition at line 226 of file plane3d.h.

Referenced by irr::core::CMatrix4< T >::buildShadowMatrix(), irr::core::plane3d< f32 >::classifyPointRelation(), irr::core::plane3d< f32 >::getDistanceTo(), irr::core::plane3d< f32 >::getIntersectionWithLine(), irr::core::plane3d< f32 >::getIntersectionWithPlane(), irr::core::plane3d< f32 >::getKnownIntersectionWithLine(), irr::core::plane3d< f32 >::getMemberPoint(), irr::core::plane3d< f32 >::operator==(), irr::core::plane3d< f32 >::recalculateD(), irr::scene::SViewFrustum::setFrom(), and irr::core::plane3d< f32 >::setPlane().

template<class T>

vector3d<T> irr::core::plane3d< T >::Normal

Normal vector of the plane.

Definition at line 223 of file plane3d.h.

Referenced by irr::core::CMatrix4< T >::buildShadowMatrix(), irr::core::plane3d< f32 >::classifyPointRelation(), irr::core::plane3d< f32 >::existsIntersection(), irr::core::plane3d< f32 >::getDistanceTo(), irr::core::plane3d< f32 >::getIntersectionWithLine(), irr::core::plane3d< f32 >::getIntersectionWithPlane(), irr::core::plane3d< f32 >::getKnownIntersectionWithLine(), irr::core::plane3d< f32 >::getMemberPoint(), irr::core::plane3d< f32 >::isFrontFacing(), irr::core::plane3d< f32 >::operator==(), irr::core::plane3d< f32 >::recalculateD(), irr::scene::SViewFrustum::setFrom(), irr::core::plane3d< f32 >::setPlane(), and irr::core::CMatrix4< T >::transformPlane().

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

- plane3d.h

| The Irrlicht Engine Documentation © 2003-2010 by Nikolaus Gebhardt. Generated on Sun Feb 14 13:07:03 2010 by Doxygen (1.6.2)