Size< T, 3 > Class Template Reference

Specialization for 3D with special members width(),height() and depth(). More...

#include <geometry/Size.h>

Inheritance diagram for Size< T, 3 >:

Public Types
typedef Eigen::Matrix< T, 3, 1 >	BaseType
typedef Point< T, 3 >	PointType
typedef class Eigen::Map< Matrix, Aligned >	AlignedMapType
typedef class Eigen::Map< Matrix, Unaligned >	UnalignedMapType

Public Member Functions
const Base &	base () const
Base &	base ()
const Scalar &	coeff (int index) const
const Scalar &	coeff (int row, int col) const
Scalar &	coeffRef (int index)
Scalar &	coeffRef (int row, int col)
int	cols () const
Scalar *	data ()
const Scalar *	data () const
PacketScalar	packet (int index) const
PacketScalar	packet (int row, int col) const
void	resize (int size)
void	resize (int rows, int cols)
int	rows () const
Matrix &	setConstant (int rows, int cols, const Scalar &value)
Matrix &	setConstant (int size, const Scalar &value)
Matrix &	setIdentity (int rows, int cols)
Matrix &	setOnes (int rows, int cols)
Matrix &	setOnes (int size)
Matrix &	setRandom (int rows, int cols)
Matrix &	setRandom (int size)
Matrix &	setZero (int rows, int cols)
Matrix &	setZero (int size)
int	stride (void) const
void	swap (const MatrixBase< OtherDerived > &other)
void	writePacket (int index, const PacketScalar &x)
void	writePacket (int row, int col, const PacketScalar &x)
Constructors
	Size ()
	the default constructor More...
template<typename MatrixDerived >
	Size (const Eigen::MatrixBase< MatrixDerived > &matrix)
	a constructor to initialize width and height with a Eigen-matrix of correct dimension More...
	Size (T width, T height, T depth)
	a constructor to initialize the size with width, height, and depth in the 3D case More...
Generic operations
T	width () const
	return the width More...
T	height () const
	return the height More...
T	depth () const
	return the depth More...
T &	width ()
	return the width More...
T &	height ()
	return the height More...
T &	depth ()
	return the depth More...
template<typename Reflector >
void	reflect (Reflector &reflector)
	the serialization definition More...
Implicit conversion operators
	operator PointType () const
	converts to mira Point More...

Static Public Member Functions
static UnalignedMapType	Map (Scalar *data, int rows, int cols)
static const UnalignedMapType	Map (const Scalar *data, int rows, int cols)
static UnalignedMapType	Map (Scalar *data, int size)
static const UnalignedMapType	Map (const Scalar *data, int size)
static UnalignedMapType	Map (Scalar *data)
static const UnalignedMapType	Map (const Scalar *data)
static AlignedMapType	MapAligned (Scalar *data, int rows, int cols)
static const AlignedMapType	MapAligned (const Scalar *data, int rows, int cols)
static AlignedMapType	MapAligned (Scalar *data, int size)
static const AlignedMapType	MapAligned (const Scalar *data, int size)
static AlignedMapType	MapAligned (Scalar *data)
static const AlignedMapType	MapAligned (const Scalar *data)

Protected Attributes
ei_matrix_storage< Scalar, MaxSizeAtCompileTime, RowsAtCompileTime, ColsAtCompileTime, Options >	m_storage

Detailed Description

template<typename T>
class mira::Size< T, 3 >

Specialization for 3D with special members width(),height() and depth().

Member Typedef Documentation

BaseType

typedef Eigen::Matrix<T,3,1> BaseType

PointType

typedef Point<T,3> PointType

Constructor & Destructor Documentation

Size() [1/3]

Size ( )

inline

the default constructor

Size() [2/3]

Size ( const Eigen::MatrixBase< MatrixDerived > &  matrix )

inline

a constructor to initialize width and height with a Eigen-matrix of correct dimension

Size() [3/3]

Size ( T  width, T  height, T  depth  )

inline

a constructor to initialize the size with width, height, and depth in the 3D case

Member Function Documentation

width() [1/2]

T width ( ) const

inline

return the width

height() [1/2]

T height ( ) const

inline

return the height

depth() [1/2]

T depth ( ) const

inline

return the depth

width() [2/2]

T& width ( )

inline

return the width

height() [2/2]

T& height ( )

inline

return the height

depth() [2/2]

T& depth ( )

inline

return the depth

reflect()

void reflect ( Reflector &  reflector )

inline

the serialization definition

operator PointType()

operator PointType ( ) const

inline

converts to mira Point

---

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

• base/include/geometry/Size.h