plane Struct Reference

Plane structure. More...

#include <3dmath.h>

List of all members.

Public Member Functions
	plane (float _a=0, float _b=0, float _c=0, float _d=0)
	Constructor.
	plane (const plane &p)
	Copy constructor.
plane &	operator= (const plane &p)
	Assignment operator.
plane	Normalize () const
	Get normalized plane.
float	DotCoord (const vector3 &p) const
	Get point distance from plane.
wxString	ToString () const
	Get string.
plane *	Clone () const
	Get copy of instance.
Static Public Member Functions
static plane	FromPointNorm (const vector3 &point, const vector3 &normal)
	Get plane from point and normal.
static plane	FromPoints (const vector3 &p1, const vector3 &p2, const vector3 &p3)
	Get plane from three points.
Public Attributes
union {
struct {
float   a
	Components.
float   b
float   c
float   d
}
float   _p [4]
	Components.
};
Friends
std::ostream &	operator<< (std::ostream &os, const plane &p)
	Output stream operator.

---

Detailed Description

Plane structure.

Definition at line 344 of file 3dmath.h.

---

Constructor & Destructor Documentation

plane::plane	(	float	_a = 0,
		float	_b = 0,
		float	_c = 0,
		float	_d = 0
	)			[inline]

Constructor.

Definition at line 358 of file 3dmath.h.

: a(_a), b(_b), c(_c), d(_d)       {}

plane::plane

(

const plane &

p

)

[inline]

Copy constructor.

Definition at line 361 of file 3dmath.h.

: a(p.a), b(p.b), c(p.c), d(p.d)          {}

---

Member Function Documentation

plane& plane::operator=

(

const plane &

p

)

[inline]

Assignment operator.

Definition at line 364 of file 3dmath.h.

       {
              a = p.a;
              b = p.b;
              c = p.c;
              d = p.d;
              return *this;
       }

plane plane::Normalize

(

)

const [inline]

Get normalized plane.

Definition at line 374 of file 3dmath.h.

       {
              float imag = 1.0f / sqrtf(a*a + b*b + c*c);
              return plane(a * imag, b * imag, c * imag, d * imag);
       }

static plane plane::FromPointNorm	(	const vector3 &	point,
		const vector3 &	normal
	)			[inline, static]

Get plane from point and normal.

Definition at line 381 of file 3dmath.h.

       {
              return plane(normal.x, normal.y, normal.z, -normal.Dot(point));
       }

static plane plane::FromPoints	(	const vector3 &	p1,
		const vector3 &	p2,
		const vector3 &	p3
	)			[inline, static]

Get plane from three points.

Definition at line 387 of file 3dmath.h.

       {
              vector3 v1 = p2 - p1;
              vector3 v2 = p3 - p1;
              vector3 n = v1.Cross(v2);
              return FromPointNorm(p1, n.Normalize());
       }

float plane::DotCoord

(

const vector3 &

p

)

const [inline]

Get point distance from plane.

Definition at line 396 of file 3dmath.h.

       {
              return a * p.x + b * p.y + c * p.z + d;
       }

wxString plane::ToString

(

)

const [inline]

Get string.

Definition at line 402 of file 3dmath.h.

       {
              return wxString(wxT("(")) << a << wxT(", ") << b << wxT(", ") << c << wxT(", ") << d << wxT(")");
       }

plane* plane::Clone

(

)

const [inline]

Get copy of instance.

Definition at line 414 of file 3dmath.h.

       {
              return new plane(*this);
       }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const plane &	p
	)			[friend]

Output stream operator.

Definition at line 408 of file 3dmath.h.

       {
              return os << "(" << p.a << ", " << p.b << ", " << p.c << ", " << p.d << ")";
       }

---

Member Data Documentation

float plane::a

Components.

Definition at line 351 of file 3dmath.h.

float plane::b

Definition at line 351 of file 3dmath.h.

float plane::c

Definition at line 351 of file 3dmath.h.

float plane::d

Definition at line 351 of file 3dmath.h.

float plane::_p[4]

Components.

Definition at line 354 of file 3dmath.h.

union { ... }

---

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

• /cygdrive/d/src/svn/vrut/trunk/core/src/3dmath.h