ERC CISST - cisst software

---

vctMatrixRotation2< _elementType > Class Template Reference
[Vectors]

#include <vctMatrixRotation2.h>

Inheritance diagram for vctMatrixRotation2< _elementType >:

[legend]Collaboration diagram for vctMatrixRotation2< _elementType >:

[legend]List of all members.

---

Detailed Description

template<class _elementType>
class vctMatrixRotation2< _elementType >

Define a rotation matrix for a space of dimension 2.

This class is templated by the element type. It is derived from vctMatrixRotation2Base and uses a vctFixedSizeMatrix as underlying container. It provides a more humain interface for programmers only interested in templating by _elementType.

Parameters:

_elementType

The type of elements of the matrix.

See also:

vctMatrixRotation2Base vctFixedSizeMatrix

Definition at line 51 of file vctMatrixRotation2.h.

Public Types

• enum
• enum
• typedef vctFixedSizeMatrix<
  value_type, ROWS, COLS > ContainerType
• typedef vctMatrixRotation2Base<
  ContainerType > BaseType
• typedef vctMatrixRotation2<
  value_type > ThisType
• typedef cmnTypeTraits< value_type > TypeTraits

Public Member Functions

• vctMatrixRotation2 ()
• vctMatrixRotation2 (const ThisType &other)
• vctMatrixRotation2 (const BaseType &other)
• ThisType & operator= (const ContainerType &other)
• ThisType & operator= (const ThisType &other)
• ThisType & operator= (const BaseType &other)
• vctMatrixRotation2 (const value_type &element00, const value_type &element01, const value_type &element10, const value_type &element11) throw (std::runtime_error)
• template<stride_type __stride1, class __dataPtrType1, stride_type __stride2, class __dataPtrType2> vctMatrixRotation2 (const vctFixedSizeConstVectorBase< DIMENSION, __stride1, value_type, __dataPtrType1 > &v1, const vctFixedSizeConstVectorBase< DIMENSION, __stride2, value_type, __dataPtrType2 > &v2, bool vectorsAreColumns=true) throw (std::runtime_error)
• template<class __vectorOwnerType1, class __vectorOwnerType2> vctMatrixRotation2 (const vctDynamicConstVectorBase< __vectorOwnerType1, value_type > &v1, const vctDynamicConstVectorBase< __vectorOwnerType2, value_type > &v2, bool vectorsAreColumns=true) throw (std::runtime_error)
• vctMatrixRotation2 (const vctAngleRotation2 &angleRotation) throw (std::runtime_error)
• vctMatrixRotation2 (const value_type &element00, const value_type &element01, const value_type &element10, const value_type &element11, bool normalizeInput)
• template<stride_type __stride1, class __dataPtrType1, stride_type __stride2, class __dataPtrType2> vctMatrixRotation2 (const vctFixedSizeConstVectorBase< DIMENSION, __stride1, value_type, __dataPtrType1 > &v1, const vctFixedSizeConstVectorBase< DIMENSION, __stride2, value_type, __dataPtrType2 > &v2, bool vectorsAreColumns, bool normalizeInput)
• template<class __vectorOwnerType1, class __vectorOwnerType2> vctMatrixRotation2 (const vctDynamicConstVectorBase< __vectorOwnerType1, value_type > &v1, const vctDynamicConstVectorBase< __vectorOwnerType2, value_type > &v2, bool vectorsAreColumns, bool normalizeInput)
• vctMatrixRotation2 (const vctAngleRotation2 &angleRotation, bool normalizeInput)
• template<stride_type __rowStride, stride_type __colStride, class __dataPtrType> vctMatrixRotation2 (const vctFixedSizeMatrixBase< ROWS, COLS, __rowStride, __colStride, value_type, __dataPtrType > &matrix)

Public Attributes

• _elementType

---

Member Typedef Documentation

template<class _elementType>

typedef vctMatrixRotation2Base<ContainerType> vctMatrixRotation2< _elementType >::BaseType

Type of the base class

Reimplemented from vctMatrixRotation2Base< vctFixedSizeMatrix< _elementType, 2, 2 > >.

Definition at line 59 of file vctMatrixRotation2.h.

template<class _elementType>

typedef vctMatrixRotation2<value_type> vctMatrixRotation2< _elementType >::ThisType

Type of the matrix itself.

Reimplemented from vctMatrixRotation2Base< vctFixedSizeMatrix< _elementType, 2, 2 > >.

Definition at line 60 of file vctMatrixRotation2.h.

template<class _elementType>

typedef cmnTypeTraits<value_type> vctMatrixRotation2< _elementType >::TypeTraits

Traits used for all useful types and values related to the element type.

Reimplemented from vctMatrixRotation2Base< vctFixedSizeMatrix< _elementType, 2, 2 > >.

Definition at line 63 of file vctMatrixRotation2.h.

---

Constructor & Destructor Documentation

template<class _elementType>

vctMatrixRotation2< _elementType >::vctMatrixRotation2

(

)

[inline]

Default constructor. Sets the rotation matrix to identity.

Definition at line 66 of file vctMatrixRotation2.h.

template<class _elementType>

template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>

vctMatrixRotation2< _elementType >::vctMatrixRotation2

(

const vctFixedSizeMatrixBase< ROWS, COLS, __rowStride, __colStride, value_type, __dataPtrType > &

matrix

)

[inline, explicit]

Initialize this rotation matrix with a 2x2 matrix. This constructor only takes a matrix of the same element type.

Note:

This constructor does not verify normalization. It is introduced to allow using results of matrix operations and assign them to a rotation matrix.

The constructor is declared explicit, to force the user to be aware of the conversion being made.

Definition at line 169 of file vctMatrixRotation2.h.

---

Member Function Documentation

template<class _elementType>

ThisType& vctMatrixRotation2< _elementType >::operator=

(

const ContainerType &

other

)

[inline]

The assignment from BaseType (i.e. a 2 by 2 fixed size matrix) has to be redefined for this class (C++ restriction). This operator uses the Assign() method inherited from the BaseType. This operator (as well as the Assign method) allows to set a rotation matrix to whatever value without any further validity checking. It is recommended to use it with caution.

Definition at line 84 of file vctMatrixRotation2.h.

References vctFixedSizeMatrixBase< _rows, _cols, _rowMajor?_cols:1, _rowMajor?1:_rows, _elementType, vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowMajor?_cols:1, _rowMajor?1:_rows >::array >::Assign().

---

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

• vctMatrixRotation2.h

---