TPoint< _Scalar, _Dimension > Struct Template Reference

Generic N-dimensional point data structure based on Eigen::Matrix. More...

#include <vector.h>

Inheritance diagram for TPoint< _Scalar, _Dimension >:

List of all members.

Public Types
enum	{ Dimension = _Dimension }
typedef _Scalar	Scalar
typedef Eigen::Matrix< Scalar, Dimension, 1 >	Base
typedef TVector< Scalar, Dimension >	VectorType
typedef TPoint< Scalar, Dimension >	PointType
Public Member Functions
	TPoint (Scalar value=(Scalar) 0)
	Create a new point with constant component vlaues.
	TPoint (Scalar x, Scalar y)
	Create a new 2D point (type error if Dimension != 2)
	TPoint (Scalar x, Scalar y, Scalar z)
	Create a new 3D point (type error if Dimension != 3)
	TPoint (Scalar x, Scalar y, Scalar z, Scalar w)
	Create a new 4D point (type error if Dimension != 4)
template<typename Derived >
	TPoint (const Eigen::MatrixBase< Derived > &p)
	Construct a point from MatrixBase (needed to play nice with Eigen)
template<typename Derived >
TPoint &	operator= (const Eigen::MatrixBase< Derived > &p)
	Assign a point from MatrixBase (needed to play nice with Eigen)
QString	toString () const
	Return a human-readable string summary.

---

Detailed Description

template<typename _Scalar, int _Dimension>
struct TPoint< _Scalar, _Dimension >

Generic N-dimensional point data structure based on Eigen::Matrix.

Definition at line 85 of file vector.h.

---

Member Typedef Documentation

template<typename _Scalar, int _Dimension>

typedef Eigen::Matrix<Scalar, Dimension, 1> TPoint< _Scalar, _Dimension >::Base

Definition at line 92 of file vector.h.

template<typename _Scalar, int _Dimension>

typedef TPoint<Scalar, Dimension> TPoint< _Scalar, _Dimension >::PointType

Definition at line 94 of file vector.h.

template<typename _Scalar, int _Dimension>

typedef _Scalar TPoint< _Scalar, _Dimension >::Scalar

Definition at line 91 of file vector.h.

template<typename _Scalar, int _Dimension>

typedef TVector<Scalar, Dimension> TPoint< _Scalar, _Dimension >::VectorType

Definition at line 93 of file vector.h.

---

Member Enumeration Documentation

template<typename _Scalar, int _Dimension>

anonymous enum

Enumerator:

Dimension

Definition at line 87 of file vector.h.

---

Constructor & Destructor Documentation

template<typename _Scalar, int _Dimension>

TPoint< _Scalar, _Dimension >::TPoint

(

Scalar

value = (Scalar) 0

)

[inline]

Create a new point with constant component vlaues.

Definition at line 97 of file vector.h.

template<typename _Scalar, int _Dimension>

TPoint< _Scalar, _Dimension >::TPoint	(	Scalar	x,
		Scalar	y
	)		[inline]

Create a new 2D point (type error if Dimension != 2)

Definition at line 100 of file vector.h.

template<typename _Scalar, int _Dimension>

TPoint< _Scalar, _Dimension >::TPoint	(	Scalar	x,
		Scalar	y,
		Scalar	z
	)		[inline]

Create a new 3D point (type error if Dimension != 3)

Definition at line 103 of file vector.h.

template<typename _Scalar, int _Dimension>

TPoint< _Scalar, _Dimension >::TPoint	(	Scalar	x,
		Scalar	y,
		Scalar	z,
		Scalar	w
	)		[inline]

Create a new 4D point (type error if Dimension != 4)

Definition at line 106 of file vector.h.

template<typename _Scalar, int _Dimension>

template<typename Derived >

TPoint< _Scalar, _Dimension >::TPoint

(

const Eigen::MatrixBase< Derived > &

p

)

[inline]

Construct a point from MatrixBase (needed to play nice with Eigen)

Definition at line 109 of file vector.h.

---

Member Function Documentation

template<typename _Scalar, int _Dimension>

template<typename Derived >

TPoint& TPoint< _Scalar, _Dimension >::operator=

(

const Eigen::MatrixBase< Derived > &

p

)

[inline]

Assign a point from MatrixBase (needed to play nice with Eigen)

Definition at line 113 of file vector.h.

template<typename _Scalar, int _Dimension>

QString TPoint< _Scalar, _Dimension >::toString

(

)

const [inline]

Return a human-readable string summary.

Definition at line 119 of file vector.h.

---

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

• include/nori/vector.h