Track::Plane Class Reference

A three dimensional plane. More...

#include <Geometry.h>

List of all members.

Public Member Functions
	Plane (btVector3 vector, btScalar distance)
	Make a plane containg points p such that vector * p = distance.
	Plane ()
	Construct without initalising plane.
bool	find_side (btVector3 point) const
	Determine which side of the plane a point is on.
btScalar	find_distance (btVector3 point) const
	Find minimum distance to the plane.
btScalar	find_signed_distance (btVector3 point) const
	Find signed minimum distance to the plane.
btVector3	find_nearest_point (btVector3 point) const
	Find the nearest point to the plane.
Protected Member Functions
void	normalise ()
	Put plane in Hessian normal form.
Protected Attributes
btVector3	m_vector
btScalar	m_distance

---

Detailed Description

A three dimensional plane.

Definition at line 22 of file Geometry.h.

---

Constructor & Destructor Documentation

Track::Plane::Plane	(	btVector3	vector,
		btScalar	distance
	)			[inline]

Make a plane containg points p such that vector * p = distance.

If used as a half space, find_side will return true if the point lies further in the direction of vector. Negate distance and vector to define the same plane but the opposite half space.

Definition at line 31 of file Geometry.h.

Track::Plane::Plane

(

)

[inline]

Construct without initalising plane.

Definition at line 38 of file Geometry.h.

---

Member Function Documentation

btScalar Track::Plane::find_distance

(

btVector3

point

)

const [inline]

Find minimum distance to the plane.

Definition at line 47 of file Geometry.h.

btVector3 Track::Plane::find_nearest_point

(

btVector3

point

)

const [inline]

Find the nearest point to the plane.

Definition at line 57 of file Geometry.h.

bool Track::Plane::find_side

(

btVector3

point

)

const [inline]

Determine which side of the plane a point is on.

Definition at line 42 of file Geometry.h.

btScalar Track::Plane::find_signed_distance

(

btVector3

point

)

const [inline]

Find signed minimum distance to the plane.

Definition at line 52 of file Geometry.h.

void Track::Plane::normalise

(

)

[inline, protected]

Put plane in Hessian normal form.

This makes m_vector unit length, but keeps the object describing the same plane. It means that some functions are simpler as they do not need to consider the length of m_vector.

Definition at line 70 of file Geometry.h.

---

Member Data Documentation

btScalar Track::Plane::m_distance [protected]

Definition at line 64 of file Geometry.h.

btVector3 Track::Plane::m_vector [protected]

Definition at line 63 of file Geometry.h.

---

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

• libtrack/Geometry.h

---

Generated at Mon Sep 6 00:41:18 2010 by Doxygen version 1.4.7 for Racer version svn335.