model::Plane< dim > Struct Template Reference

#include <Plane.h>

Inheritance diagram for model::Plane< dim >:

Collaboration diagram for model::Plane< dim >:

Public Types
typedef Eigen::Matrix< double, dim, 1 >	VectorDim
typedef Eigen::Matrix< double, dim-1, 1 >	VectorLowerDim
typedef Eigen::Matrix< double, dim, dim >	MatrixDim

Public Member Functions
	Plane (const VectorDim &p, const VectorDim &n)
bool	contains (const VectorDim &P0) const
bool	isAbove (const VectorDim &P0) const
bool	isBelow (const VectorDim &P0) const
VectorDim	snapToPlane (const VectorDim &P0) const
double	distanceTo (const VectorDim &P0) const
double	signedDistanceTo (const VectorDim &P0) const
VectorLowerDim	localPosition (const VectorDim &point) const
VectorDim	globalPosition (const VectorLowerDim &point) const
VectorLowerDim	localDirection (const VectorDim &dir) const
VectorDim	globalDirection (const VectorLowerDim &dir) const

Static Public Member Functions
static MatrixDim	getL2G (const VectorDim &z)

Public Attributes
const VectorDim	P
const VectorDim	unitNormal
const MatrixDim	L2G

Detailed Description

template<int dim>
struct model::Plane< dim >

Definition at line 54 of file Plane.h.

Member Typedef Documentation

MatrixDim

template<int dim>

typedef Eigen::Matrix<double,dim,dim> model::Plane< dim >::MatrixDim

Definition at line 58 of file Plane.h.

VectorDim

template<int dim>

typedef Eigen::Matrix<double,dim,1> model::Plane< dim >::VectorDim

Definition at line 56 of file Plane.h.

VectorLowerDim

template<int dim>

typedef Eigen::Matrix<double,dim-1,1> model::Plane< dim >::VectorLowerDim

Definition at line 57 of file Plane.h.

Constructor & Destructor Documentation

Plane()

template<int dim>

model::Plane< dim >::Plane	(	const VectorDim &	p,
		const VectorDim &	n )

Definition at line 20 of file Plane.cpp.

Member Function Documentation

contains()

template<int dim>

bool model::Plane< dim >::contains

(

const VectorDim &

P0

)

const

Definition at line 33 of file Plane.cpp.

distanceTo()

template<int dim>

double model::Plane< dim >::distanceTo

(

const VectorDim &

P0

)

const

Definition at line 57 of file Plane.cpp.

getL2G()

template<int dim>

Plane< dim >::MatrixDim model::Plane< dim >::getL2G ( const VectorDim & z )

static

Definition at line 110 of file Plane.cpp.

globalDirection()

template<int dim>

Plane< dim >::VectorDim model::Plane< dim >::globalDirection

(

const VectorLowerDim &

dir

)

const

Definition at line 104 of file Plane.cpp.

globalPosition()

template<int dim>

Plane< dim >::VectorDim model::Plane< dim >::globalPosition

(

const VectorLowerDim &

point

)

const

Definition at line 84 of file Plane.cpp.

isAbove()

template<int dim>

bool model::Plane< dim >::isAbove

(

const VectorDim &

P0

)

const

Returns

true if the plane is above point P0.

Definition at line 39 of file Plane.cpp.

isBelow()

template<int dim>

bool model::Plane< dim >::isBelow

(

const VectorDim &

P0

)

const

Returns

true if the plane is below point P0.

Definition at line 45 of file Plane.cpp.

localDirection()

template<int dim>

Plane< dim >::VectorLowerDim model::Plane< dim >::localDirection

(

const VectorDim &

dir

)

const

Definition at line 90 of file Plane.cpp.

localPosition()

template<int dim>

Plane< dim >::VectorLowerDim model::Plane< dim >::localPosition

(

const VectorDim &

point

)

const

Definition at line 69 of file Plane.cpp.

signedDistanceTo()

template<int dim>

double model::Plane< dim >::signedDistanceTo

(

const VectorDim &

P0

)

const

Definition at line 63 of file Plane.cpp.

snapToPlane()

template<int dim>

Plane< dim >::VectorDim model::Plane< dim >::snapToPlane

(

const VectorDim &

P0

)

const

Definition at line 51 of file Plane.cpp.

Member Data Documentation

L2G

template<int dim>

const MatrixDim model::Plane< dim >::L2G

Definition at line 62 of file Plane.h.

P

template<int dim>

const VectorDim model::Plane< dim >::P

Definition at line 60 of file Plane.h.

unitNormal

template<int dim>

const VectorDim model::Plane< dim >::unitNormal

Definition at line 61 of file Plane.h.

---

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

• Plane.h
• Plane.cpp