ERC CISST - cisst software

---

vctRodriguezRotation3< _elementType > Class Template Reference
[Vectors]

#include <vctRodriguezRotation3.h>

Inheritance diagram for vctRodriguezRotation3< _elementType >:

[legend]Collaboration diagram for vctRodriguezRotation3< _elementType >:

[legend]List of all members.

---

Detailed Description

template<class _elementType>
class vctRodriguezRotation3< _elementType >

Define a rotation based on the rodriguez representation for a space of dimension 3. This representation is based on a vector. The direction of the vector determines the axis of rotation and its norm defines the amplitude of the rotation.

This class is templated by the element type.

Parameters:

_elementType

The type of elements.

See also:

vctQuaternion

Definition at line 49 of file vctRodriguezRotation3.h.

Public Types

• enum
• typedef vctFixedSizeVector<
  value_type, 3 > ContainerType
• typedef vctRodriguezRotation3Base<
  ContainerType > BaseType
• typedef vctRodriguezRotation3<
  value_type > ThisType
• typedef cmnTypeTraits< value_type > TypeTraits

Public Member Functions

• vctRodriguezRotation3 ()
• vctRodriguezRotation3 (const ThisType &other)
• vctRodriguezRotation3 (const BaseType &other)

Public Attributes

• _elementType

---

Member Typedef Documentation

template<class _elementType>

typedef vctRodriguezRotation3Base<ContainerType> vctRodriguezRotation3< _elementType >::BaseType

Type of the base class.

Reimplemented from vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >.

Definition at line 56 of file vctRodriguezRotation3.h.

template<class _elementType>

typedef vctRodriguezRotation3<value_type> vctRodriguezRotation3< _elementType >::ThisType

Type of the vector itself.

Reimplemented from vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >.

Definition at line 57 of file vctRodriguezRotation3.h.

template<class _elementType>

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

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

Reimplemented from vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >.

Definition at line 59 of file vctRodriguezRotation3.h.

---

Constructor & Destructor Documentation

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

)

[inline]

Default constructor. Sets the rotation to (0, 0, 0).

Definition at line 64 of file vctRodriguezRotation3.h.

template<class _elementType>

template<stride_type __stride, class __dataPtrType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

const vctFixedSizeConstVectorBase< DIMENSION, __stride, value_type, __dataPtrType > &

axis

)

throw (std::runtime_error) [inline]

Constructor from a 3D vector.

Parameters:

axis

A vector of size 3, its norm represents the angle.

Definition at line 96 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	value_type	x,
		value_type	y,
		value_type	z
	)			throw (std::runtime_error) [inline]

Constructor from a elements representing a 3D vector.

Parameters:

x,y,z

A vector of size 3, its norm represents the angle.

Definition at line 105 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

template<class __containerType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

const vctQuaternionRotation3Base< __containerType > &

quaternionRotation

)

throw (std::runtime_error) [inline]

Constructor from a vctQuaternionRotation3.

Definition at line 113 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

template<class __containerType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

const vctMatrixRotation3Base< __containerType > &

matrixRotation

)

throw (std::runtime_error) [inline]

Constructor from a vctMatrixRotation3.

Definition at line 121 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

const vctAxisAngleRotation3< value_type > &

axisAngleRotation

)

throw (std::runtime_error) [inline]

Constructor from a vctAxisAngleRotation3.

Definition at line 128 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

template<stride_type __stride, class __dataPtrType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	const vctFixedSizeConstVectorBase< DIMENSION, __stride, value_type, __dataPtrType > &	axis,
		bool	normalizeInput
	)			[inline]

Constructor from a 3D vector.

Parameters:

	axis	A vector of size 3, its norm represents the angle.
	normalizeInput	Normalize the input or convert as is (VCT_NORMALIZE or VCT_DO_NOT_NORMALIZE)

Definition at line 166 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	value_type	x,
		value_type	y,
		value_type	z,
		bool	normalizeInput
	)			[inline]

Constructor from 3 elements representing a 3D vector.

Parameters:

	x,y,z	A vector of size 3, its norm represents the angle.
	normalizeInput	Normalize the input or convert as is (VCT_NORMALIZE or VCT_DO_NOT_NORMALIZE)

Definition at line 180 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

template<class __containerType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	const vctQuaternionRotation3Base< __containerType > &	quaternionRotation,
		bool	normalizeInput
	)			[inline]

Constructor from a vctQuaternionRotation3.

Definition at line 192 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

template<class __containerType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	const vctMatrixRotation3Base< __containerType > &	matrixRotation,
		bool	normalizeInput
	)			[inline]

Constructor from a vctMatrixRotation3.

Definition at line 204 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	const vctAxisAngleRotation3< value_type > &	axisAngleRotation,
		bool	normalizeInput
	)			[inline]

Constructor from a vctAxisAngleRotation3.

Definition at line 215 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

template<stride_type __stride, class __dataPtrType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

const vctFixedSizeConstVectorBase< DIMENSION, __stride, value_type, __dataPtrType > &

axis

)

throw (std::runtime_error) [inline]

Constructor from a 3D vector.

Parameters:

axis

A vector of size 3, its norm represents the angle.

Definition at line 96 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	value_type	x,
		value_type	y,
		value_type	z
	)			throw (std::runtime_error) [inline]

Constructor from a elements representing a 3D vector.

Parameters:

x,y,z

A vector of size 3, its norm represents the angle.

Definition at line 105 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

template<class __containerType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

const vctQuaternionRotation3Base< __containerType > &

quaternionRotation

)

throw (std::runtime_error) [inline]

Constructor from a vctQuaternionRotation3.

Definition at line 113 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

template<class __containerType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

const vctMatrixRotation3Base< __containerType > &

matrixRotation

)

throw (std::runtime_error) [inline]

Constructor from a vctMatrixRotation3.

Definition at line 121 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3

(

const vctAxisAngleRotation3< value_type > &

axisAngleRotation

)

throw (std::runtime_error) [inline]

Constructor from a vctAxisAngleRotation3.

Definition at line 128 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::From().

template<class _elementType>

template<stride_type __stride, class __dataPtrType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	const vctFixedSizeConstVectorBase< DIMENSION, __stride, value_type, __dataPtrType > &	axis,
		bool	normalizeInput
	)			[inline]

Constructor from a 3D vector.

Parameters:

	axis	A vector of size 3, its norm represents the angle.
	normalizeInput	Normalize the input or convert as is (VCT_NORMALIZE or VCT_DO_NOT_NORMALIZE)

Definition at line 166 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	value_type	x,
		value_type	y,
		value_type	z,
		bool	normalizeInput
	)			[inline]

Constructor from 3 elements representing a 3D vector.

Parameters:

	x,y,z	A vector of size 3, its norm represents the angle.
	normalizeInput	Normalize the input or convert as is (VCT_NORMALIZE or VCT_DO_NOT_NORMALIZE)

Definition at line 180 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

template<class __containerType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	const vctQuaternionRotation3Base< __containerType > &	quaternionRotation,
		bool	normalizeInput
	)			[inline]

Constructor from a vctQuaternionRotation3.

Definition at line 192 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

template<class __containerType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	const vctMatrixRotation3Base< __containerType > &	matrixRotation,
		bool	normalizeInput
	)			[inline]

Constructor from a vctMatrixRotation3.

Definition at line 204 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

template<class _elementType>

vctRodriguezRotation3< _elementType >::vctRodriguezRotation3	(	const vctAxisAngleRotation3< value_type > &	axisAngleRotation,
		bool	normalizeInput
	)			[inline]

Constructor from a vctAxisAngleRotation3.

Definition at line 215 of file vctRodriguezRotation3.h.

References vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromNormalized(), and vctRodriguezRotation3Base< vctFixedSizeVector< _elementType, 3 > >::FromRaw().

---

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

• vctRodriguezRotation3.h

---