math::Plane3< T > Class Template Reference

Class that represents a plane in hesse form. More...

#include <plane.h>

Collaboration diagram for math::Plane3< T >:

Public Types
typedef Vector< T, 3 >	Vec3T

Public Member Functions
	Plane3 (Vec3T const &n, T const &d)
	Creates a plane with normal n and distance d from the origin.
	Plane3 (Vec3T const &n, Vec3T const &p)
	Creates a plane containing p with normal n.
	Plane3 (Vec3T const &p1, Vec3T const &p2, Vec3T const &p3)
	Creates the plane from three points.
	Plane3 (void)
	Creates an uninitialized plane.
Plane3< T > &	invert (void)
	Flips the orientation of the plane.
Plane3< T >	inverted (void) const
	Returns plane with flipped orientation.
T	point_dist (Vec3T const &p) const
	Returns the signed distance from a point to the plane.

Public Attributes
T	d
Vec3T	n

Detailed Description

template<class T>
class math::Plane3< T >

Class that represents a plane in hesse form.

This type of plane allows efficient calculation of orthogonal distances. The normal is expected to have unit length.

Definition at line 28 of file plane.h.

Member Typedef Documentation

Vec3T

template<class T >

typedef Vector<T, 3> math::Plane3< T >::Vec3T

Definition at line 31 of file plane.h.

Constructor & Destructor Documentation

Plane3() [1/4]

template<class T >

math::Plane3< T >::Plane3 ( void  )

inline

Creates an uninitialized plane.

Definition at line 64 of file plane.h.

Plane3() [2/4]

template<class T >

math::Plane3< T >::Plane3 ( Vec3T const &  n, T const &  d  )

inline

Creates a plane with normal n and distance d from the origin.

Definition at line 70 of file plane.h.

Plane3() [3/4]

template<class T >

math::Plane3< T >::Plane3 ( Vec3T const &  n, Vec3T const &  p  )

inline

Creates a plane containing p with normal n.

Definition at line 77 of file plane.h.

Plane3() [4/4]

template<class T >

math::Plane3< T >::Plane3 ( Vec3T const &  p1, Vec3T const &  p2, Vec3T const &  p3  )

inline

Creates the plane from three points.

Definition at line 84 of file plane.h.

Member Function Documentation

invert()

template<class T >

Plane3< T > & math::Plane3< T >::invert

(

void

)

Flips the orientation of the plane.

Definition at line 99 of file plane.h.

inverted()

template<class T >

Plane3< T > math::Plane3< T >::inverted ( void  ) const

inline

Returns plane with flipped orientation.

Definition at line 108 of file plane.h.

point_dist()

template<class T >

T math::Plane3< T >::point_dist ( Vec3T const &  p ) const

inline

Returns the signed distance from a point to the plane.

Definition at line 92 of file plane.h.

Member Data Documentation

d

template<class T >

T math::Plane3< T >::d

Definition at line 57 of file plane.h.

n

template<class T >

Vec3T math::Plane3< T >::n

Definition at line 56 of file plane.h.

---

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

• /builddir/build/BUILD/mve-354a652461377939ca136f451ba3271a1c52ee65/libs/math/plane.h