Plane Class Reference

#include <plane.h>

Inheritance diagram for Plane:

[legend]Collaboration diagram for Plane:

[legend]List of all members.

---

Detailed Description

3D plane Class describing a 3D plane

Author:

Mattias Jansson (mattias@realityrift.com)

Public Member Functions
	Plane ()
	Plane (const Plane &rkPlane)
	Plane (const Vector3d &rkNormal, float fDistance)
	Plane (const Vector3d &rkPointOne, const Vector3d &rkPointTwo, const Vector3d &rkPointThree)
	Plane (const Vector3d &rkNormal, const Vector3d &rkPoint)
void	Set (const Vector3d &rkNormal, float fDistance)
void	Set (const Vector3d &rkPointOne, const Vector3d &rkPointTwo, const Vector3d &rkPointThree)
void	Set (const Vector3d &rkNormal, const Vector3d &rkPoint)
float	Distance (const Vector3d &rkPoint) const
Vector3d	GetPointOnPlane () const
bool	operator== (const Plane &rkPlane) const
Public Attributes
Vector3d	m_kNormal
float	m_fDistance

---

Constructor & Destructor Documentation

Plane (   )  [inline]

Reset data (normal [0,0,0], distance 0)

Plane (  const Plane &  rkPlane  )  [inline]

Copy data Parameters: rkPlane  Plane to copy data from

Plane (  const Vector3d &  rkNormal, float  fDistance )  [inline]

Set data Parameters: rkNormal  Plane normal fDistance  Distance

Plane (  const Vector3d &  rkPointOne, const Vector3d &  rkPointTwo, const Vector3d &  rkPointThree )  [inline]

Set data Parameters: rkPointOne  First point in plane rkPointTwo  Second point in plane rkPointThree  Third point in plane

Plane (  const Vector3d &  rkNormal, const Vector3d &  rkPoint )  [inline]

Set data Parameters: rkNormal  Plane normal rkPoint  Point in plane

---

Member Function Documentation

void Set (  const Vector3d &  rkNormal, float  fDistance )  [inline]

Set data Parameters: rkNormal  Plane normal fDistance  Distance

void Set (  const Vector3d &  rkPointOne, const Vector3d &  rkPointTwo, const Vector3d &  rkPointThree )  [inline]

Set data Parameters: rkPointOne  First point rkPointTwo  Second point rkPointThree  Third point

void Set (  const Vector3d &  rkNormal, const Vector3d &  rkPoint )  [inline]

Set data Parameters: rkNormal  Plane normal rkPoint  Point in plane

float Distance (  const Vector3d &  rkPoint  )  const [inline]

Get distance from plane to point Returns: Distance

Vector3d GetPointOnPlane (   )  const [inline]

Returns: A point on the plane

bool operator== (  const Plane &  rkPlane  )  const [inline]

Query if planes are identical Parameters: rkPlane  Plane to compare with

---

Member Data Documentation

Vector3d m_kNormal

Plane normal

float m_fDistance

Distance to origo along normal

---

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

• plane.h

---