Public Member Functions
	plane ()

	plane (const VEC3 &a_p0, const VEC3 &a_p1, const VEC3 &a_p2)

	plane (const VEC3 &a_normal, const T &a_distance)

	plane (const VEC3 &a_normal, const VEC3 &a_point)

virtual	~plane ()

	plane (const plane &a_from)

plane &	operator= (const plane &a_from)

bool	is_valid () const

void	offset (const T &a_distance)

bool	intersect (const line< VEC3 > &a_line, VEC3 &a_intersection) const

bool	is_in_half_space (const VEC3 &a_point) const

const VEC3 &	normal () const

T	distance_from_origin () const

T	distance (const VEC3 &a_point) const

void	set (const VEC3 &a_normal, const T &a_distance)

void	set (const VEC3 &a_normal, const VEC3 &a_point)

const VEC3 &	getNormal () const

Protected Types
typedef VEC3::elem_t	T

Protected Attributes
VEC3	m_normal

T	m_distance

Detailed Description

template<class VEC3>
class tools::plane< VEC3 >

Definition at line 12 of file plane.

Member Typedef Documentation

◆ T

template<class VEC3 >

typedef VEC3::elem_t tools::plane< VEC3 >::T

protected

Definition at line 14 of file plane.

Constructor & Destructor Documentation

◆ plane() [1/5]

template<class VEC3 >

tools::plane< VEC3 >::plane ( )

inline

Definition at line 16 of file plane.

16 {}

◆ plane() [2/5]

template<class VEC3 >

tools::plane< VEC3 >::plane	(	const VEC3 &	a_p0,
		const VEC3 &	a_p1,
		const VEC3 &	a_p2
	)

inline

Definition at line 18 of file plane.

                                                             {
     // Construct a plane given 3 points.
     // Orientation is computed by taking (p1 - p0) x (p2 - p0) and
     // pointing the normal in that direction.
  
     VEC3 P = a_p1;
     P.subtract(a_p0);
     VEC3 P2 = a_p2;
     P2.subtract(a_p0);
     P.cross(P2,m_normal);
     if(!m_normal.normalize()) {} //throw
     m_distance =
       m_normal.v0() * a_p0.v0() +
       m_normal.v1() * a_p0.v1() +
       m_normal.v2() * a_p0.v2();
   }

◆ plane() [3/5]

template<class VEC3 >

tools::plane< VEC3 >::plane	(	const VEC3 &	a_normal,
		const T &	a_distance
	)

inline

Definition at line 35 of file plane.

                                                  {
     set(a_normal,a_distance);
   }

◆ plane() [4/5]

template<class VEC3 >

tools::plane< VEC3 >::plane	(	const VEC3 &	a_normal,
		const VEC3 &	a_point
	)

inline

Definition at line 39 of file plane.

                                                  {
     set(a_normal,a_point);
   }

◆ ~plane()

template<class VEC3 >

virtual tools::plane< VEC3 >::~plane ( )

inlinevirtual

Definition at line 43 of file plane.

43 {}

◆ plane() [5/5]

template<class VEC3 >

tools::plane< VEC3 >::plane ( const plane< VEC3 > & a_from )

inline

Definition at line 45 of file plane.

   :m_normal(a_from.m_normal)
   ,m_distance(a_from.m_distance)
   {}

Member Function Documentation

◆ distance()

template<class VEC3 >

T tools::plane< VEC3 >::distance ( const VEC3 & a_point ) const

inline

Definition at line 92 of file plane.

                                         {
     // Return the distance from point to plane. Positive distance means
     // the point is in the plane's half space.
     return a_point.dot(m_normal) - m_distance;
   }

◆ distance_from_origin()

template<class VEC3 >

T tools::plane< VEC3 >::distance_from_origin ( ) const

inline

Definition at line 90 of file plane.

90 {return m_distance;}

◆ getNormal()

template<class VEC3 >

const VEC3& tools::plane< VEC3 >::getNormal ( ) const

inline

Definition at line 116 of file plane.

116 {return m_normal;}

◆ intersect()

template<class VEC3 >

bool tools::plane< VEC3 >::intersect	(	const line< VEC3 > &	a_line,
		VEC3 &	a_intersection
	)		const

inline

Definition at line 63 of file plane.

                                                                       {
     // Intersect line and plane, returning true if there is an intersection
     // false if line is parallel to plane
     const VEC3& pos = a_line.position();
     const VEC3& dir = a_line.direction();
     T d = m_normal.dot(dir);
     if(d==T()) return false;
     T t = (m_distance - m_normal.dot(pos))/d;
     a_intersection = dir;
     a_intersection.multiply(t);
     a_intersection.add(pos);
     //a_intersection = pos + t * dir;
     return true;
   }

◆ is_in_half_space()

template<class VEC3 >

bool tools::plane< VEC3 >::is_in_half_space ( const VEC3 & a_point ) const

inline

Definition at line 78 of file plane.

                                                    {
     // Returns true if the given point is within the half-space
     // defined by the plane
     //vec pos = m_normal * m_distance;
     VEC3 pos = m_normal;
     pos.multiply(-m_distance);
     pos.add(a_point);
     return (m_normal.dot(pos) >= T() ? true : false);
   }

◆ is_valid()

template<class VEC3 >

bool tools::plane< VEC3 >::is_valid ( ) const

inline

Definition at line 56 of file plane.

56 {return m_normal.length()?true:false;}

◆ normal()

template<class VEC3 >

const VEC3& tools::plane< VEC3 >::normal ( ) const

inline

Definition at line 88 of file plane.

88 {return m_normal;}

◆ offset()

template<class VEC3 >

void tools::plane< VEC3 >::offset ( const T & a_distance )

inline

Definition at line 58 of file plane.

                                   {
     // Offset a plane by a given distance.
     m_distance += a_distance;
   }

◆ operator=()

template<class VEC3 >

plane& tools::plane< VEC3 >::operator= ( const plane< VEC3 > & a_from )

inline

Definition at line 49 of file plane.

                                         {
     m_normal = a_from.m_normal;
     m_distance = a_from.m_distance;
     return *this;
   }

◆ set() [1/2]

template<class VEC3 >

void tools::plane< VEC3 >::set	(	const VEC3 &	a_normal,
		const T &	a_distance
	)

inline

Definition at line 98 of file plane.

                                                     {
     m_normal = a_normal;
     if(!m_normal.normalize()) {} //throw
     m_distance = a_distance;
   }

◆ set() [2/2]

template<class VEC3 >

void tools::plane< VEC3 >::set	(	const VEC3 &	a_normal,
		const VEC3 &	a_point
	)

inline

Definition at line 104 of file plane.

                                                     {
     // Construct a plane given normal and a point to pass through
     // Orientation is given by the normal vector n.
     m_normal = a_normal;
     if(!m_normal.normalize()) {} //throw
     m_distance =
       m_normal.v0() * a_point.v0() +
       m_normal.v1() * a_point.v1() +
       m_normal.v2() * a_point.v2();
   }

Member Data Documentation

◆ m_distance

template<class VEC3 >

T tools::plane< VEC3 >::m_distance

protected

Definition at line 122 of file plane.

◆ m_normal

template<class VEC3 >

VEC3 tools::plane< VEC3 >::m_normal

protected

Definition at line 121 of file plane.

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

/Users/barrand/private/dev/softinex/g4tools/g4tools/tools/lina/plane

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

template<class VEC3> class tools::plane< VEC3 >

Member Typedef Documentation

◆ T

Constructor & Destructor Documentation

◆ plane() [1/5]

◆ plane() [2/5]

◆ plane() [3/5]

◆ plane() [4/5]

◆ ~plane()

◆ plane() [5/5]

Member Function Documentation

◆ distance()

◆ distance_from_origin()

◆ getNormal()

◆ intersect()

◆ is_in_half_space()

◆ is_valid()

◆ normal()

◆ offset()

◆ operator=()

◆ set() [1/2]

◆ set() [2/2]

Member Data Documentation

◆ m_distance

◆ m_normal

template<class VEC3>
class tools::plane< VEC3 >