lvr2::Plane< BaseVecT > Struct Template Reference

A plane. More...

#include <Plane.hpp>

Public Member Functions
float	distance (const BaseVecT &other) const
	Calculates the distance between the plane and the given point. More...
Line< BaseVecT >	intersect (const Plane< BaseVecT > &other) const
	Calculates the intersection between this and other. More...
	Plane ()
BaseVecT	project (const BaseVecT &other) const
	Projects the given point onto the plane and returns the projection point. More...

Public Attributes
Normal< typename BaseVecT::CoordType >	normal
BaseVecT	pos

Detailed Description

template<typename BaseVecT>
struct lvr2::Plane< BaseVecT >

A plane.

A plane represented by a normal and a position vector.

Definition at line 50 of file Plane.hpp.

Constructor & Destructor Documentation

Plane()

template<typename BaseVecT>

lvr2::Plane< BaseVecT >::Plane ( )

inline

Definition at line 52 of file Plane.hpp.

Member Function Documentation

distance()

template<typename BaseVecT>

float lvr2::Plane< BaseVecT >::distance

(

const BaseVecT &

other

)

const

Calculates the distance between the plane and the given point.

Returns

This can be < 0, == 0 or > 0 the cases mean: < 0: The point lies between the plane and the origin == 0: The point lies in the plane > 0: The point lies behind the plane, oberserved from the origin

intersect()

template<typename BaseVecT>

Line<BaseVecT> lvr2::Plane< BaseVecT >::intersect

(

const Plane< BaseVecT > &

other

)

const

Calculates the intersection between this and other.

project()

template<typename BaseVecT>

BaseVecT lvr2::Plane< BaseVecT >::project

(

const BaseVecT &

other

)

const

Projects the given point onto the plane and returns the projection point.

Member Data Documentation

normal

template<typename BaseVecT>

Normal<typename BaseVecT::CoordType> lvr2::Plane< BaseVecT >::normal

Definition at line 54 of file Plane.hpp.

pos

template<typename BaseVecT>

BaseVecT lvr2::Plane< BaseVecT >::pos

Definition at line 55 of file Plane.hpp.

---

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

• Plane.hpp