vctMatrixRotation3Ref< _elementType, _rowStride, _colStride > Class Template Reference

Define a rotation matrix for a space of dimension 3. More...

#include <vctMatrixRotation3Ref.h>

Inheritance diagram for vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >:

Public Types
enum	{ ROWS = 3 , COLS = 3 }
enum	{ DIMENSION = 3 }
typedef vctFixedSizeMatrixRef< value_type, ROWS, COLS, _rowStride, _colStride >	ContainerType
typedef vctMatrixRotation3Base< ContainerType >	BaseType
typedef vctMatrixRotation3Ref< value_type, _rowStride, _colStride >	ThisType
typedef cmnTypeTraits< value_type >	TypeTraits
Public Types inherited from vctMatrixRotation3Base< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >
enum
enum
typedef vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride >	ContainerType
typedef vctMatrixRotation3ConstBase< ContainerType >	BaseType
typedef vctMatrixRotation3Base< ContainerType >	ThisType
typedef vctMatrixRotation3Base< typename ContainerType::MatrixValueType >	RotationValueType
typedef cmnTypeTraits< value_type >	TypeTraits
Public Types inherited from vctMatrixRotation3ConstBase< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >
enum
enum
typedef vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride >	BaseType
typedef vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride >	ContainerType
typedef vctMatrixRotation3ConstBase< ContainerType >	ThisType
typedef vctMatrixRotation3< value_type >	RotationValueType
typedef cmnTypeTraits< value_type >	TypeTraits

Public Member Functions
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)
	vctMatrixRotation3Ref (void)
	vctMatrixRotation3Ref (const ThisType &other)
	vctMatrixRotation3Ref (const BaseType &other)
ThisType &	operator= (const ContainerType &other)
ThisType &	operator= (const ThisType &other)
ThisType &	operator= (const BaseType &other)
Public Member Functions inherited from vctMatrixRotation3Base< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >
vctMatrixRotation3Base< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > > &	FromRaw (const vctAxisAngleRotation3< typename vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride >::value_type > &axisAngleRotation)
	VCT_CONTAINER_TRAITS_TYPEDEFS (typename ContainerType::value_type)
	vctMatrixRotation3Base ()
ThisType &	From (const vctMatrixRotation3Base< __containerType > &other) CISST_THROW(std
ThisType &	FromNormalized (const vctMatrixRotation3Base< __containerType > &other) CISST_THROW(std
ThisType &	NormalizedSelf (void)
ThisType &	NormalizedOf (ThisType &otherMatrix)
ThisType &	InverseSelf (void)
ThisType &	InverseOf (const ThisType &otherRotation)
Public Member Functions inherited from vctMatrixRotation3ConstBase< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >
	VCT_CONTAINER_TRAITS_TYPEDEFS (typename ContainerType::value_type)
RotationValueType	Normalized (void) const
bool	IsNormalized (value_type tolerance=TypeTraits::Tolerance()) const
RotationValueType	Inverse (void) const
void	ApplyTo (const vctFixedSizeConstVectorBase< DIMENSION, __stride1, value_type, __dataPtrType1 > &input, vctFixedSizeVectorBase< DIMENSION, __stride2, value_type, __dataPtrType2 > &output) const
void	ApplyInverseTo (const vctFixedSizeConstVectorBase< DIMENSION, __stride1, value_type, __dataPtrType1 > &input, vctFixedSizeVectorBase< DIMENSION, __stride2, value_type, __dataPtrType2 > &output) const
RotationValueType	operator* (const ThisType &input) const
bool	AlmostEquivalent (const ThisType &other, value_type tolerance=TypeTraits::Tolerance()) const

Additional Inherited Members
Static Public Member Functions inherited from vctMatrixRotation3ConstBase< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >
static CISST_EXPORT const RotationValueType &	Identity ()
Protected Member Functions inherited from vctMatrixRotation3ConstBase< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >
void	ThrowUnlessIsNormalized (void) const CISST_THROW(std

Detailed Description

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>
class vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >

Define a rotation matrix for a space of dimension 3.

This class is templated by the element type. It is derived from vctMatrixRotation3Base 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

vctMatrixRotation3Base vctFixedSizeMatrix

Member Typedef Documentation

BaseType

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef vctMatrixRotation3Base<ContainerType> vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::BaseType

ContainerType

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef vctFixedSizeMatrixRef<value_type, ROWS, COLS, _rowStride, _colStride> vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::ContainerType

ThisType

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef vctMatrixRotation3Ref<value_type, _rowStride, _colStride> vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::ThisType

TypeTraits

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef cmnTypeTraits<value_type> vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::TypeTraits

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

Member Enumeration Documentation

anonymous enum

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

anonymous enum

Enumerator
DIMENSION

anonymous enum

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

anonymous enum

Enumerator
ROWS
COLS

Constructor & Destructor Documentation

vctMatrixRotation3Ref() [1/3]

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::vctMatrixRotation3Ref ( void )

inline

Default constructor. Sets the rotation matrix to identity.

vctMatrixRotation3Ref() [2/3]

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::vctMatrixRotation3Ref ( const ThisType & other )

inline

vctMatrixRotation3Ref() [3/3]

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::vctMatrixRotation3Ref ( const BaseType & other )

inline

Member Function Documentation

operator=() [1/3]

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

ThisType & vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::operator= ( const BaseType & other )

inline

operator=() [2/3]

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

ThisType & vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::operator= ( const ContainerType & other )

inline

The assignment from BaseType (i.e. a 3 by 3 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.

operator=() [3/3]

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

ThisType & vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::operator= ( const ThisType & other )

inline

VCT_CONTAINER_TRAITS_TYPEDEFS()

template<class _elementType, vct::stride_type _rowStride, vct::stride_type _colStride>

vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >::VCT_CONTAINER_TRAITS_TYPEDEFS

(

_elementType

)

---

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

• tmp/cisst-saw/cisst/cisstVector/vctForwardDeclarations.h
• tmp/cisst-saw/cisst/cisstVector/vctMatrixRotation3Ref.h