cisst-saw
Loading...
Searching...
No Matches
vctEulerRotation3< _order > Class Template Reference

#include <vctEulerRotation3.h>

Inheritance diagram for vctEulerRotation3< _order >:
vctEulerRotation3Base

Public Types

typedef vctEulerRotation3< _order > ThisType
typedef vctEulerRotation3Base BaseType

Public Member Functions

 vctEulerRotation3 ()
 vctEulerRotation3 (const ThisType &other)
 vctEulerRotation3 (double phi, double theta, double psi)
 vctEulerRotation3 (double *angles)
 vctEulerRotation3 (const vct3 &angles)
ThisTypeoperator= (const ThisType &other)
template<class __containerType>
 vctEulerRotation3 (const vctMatrixRotation3Base< __containerType > &matrixRotation) CISST_THROW(std
template<class __containerType>
 vctEulerRotation3 (const vctMatrixRotation3Base< __containerType > &matrixRotation, bool normalizeInput)
 ~vctEulerRotation3 ()
template<class _matrixType>
ThisTypeFrom (const vctMatrixRotation3Base< _matrixType > &matrixRot) CISST_THROW(std
template<class _matrixType>
ThisTypeFromNormalized (const vctMatrixRotation3Base< _matrixType > &matrixRot)
template<class _matrixType>
ThisTypeFromRaw (const vctMatrixRotation3Base< _matrixType > &matrixRotation)
const vct3GetAngles (void) const
vct3GetAngles (void)
vct3 GetAnglesInDegrees (void) const
ThisTypeInverseOf (const ThisType &otherRotation)
ThisType Inverse (void) const
ThisTypeNormalizedOf (const ThisType &otherRotation)
ThisType Normalized (void) const
bool Equal (const ThisType &other) const
bool operator== (const ThisType &other) const
bool AlmostEqual (const ThisType &other, double tolerance=TypeTraits::Tolerance()) const
bool AlmostEquivalent (const ThisType &other, double tolerance=TypeTraits::Tolerance()) const
std::string ToString (void) const
void ToStream (std::ostream &outputStream) const
void ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const
void SerializeRaw (std::ostream &outputStream) const
void DeSerializeRaw (std::istream &inputStream)
Public Member Functions inherited from vctEulerRotation3Base
 vctEulerRotation3Base (void)
 vctEulerRotation3Base (const vctEulerRotation3Base &other)
 vctEulerRotation3Base (double phi, double theta, double psi)
 vctEulerRotation3Base (double *angles)
 vctEulerRotation3Base (const vct3 &angles)
 ~vctEulerRotation3Base ()
double phi (void) const
double theta (void) const
double psi (void) const
double alpha (void) const
double beta (void) const
double gamma (void) const
void Assign (double phi, double theta, double psi)
vctEulerRotation3BaseInverseSelf (void)
vctEulerRotation3BaseNormalizedSelf (void)
bool IsNormalized (double tolerance=TypeTraits::Tolerance()) const

Additional Inherited Members

Protected Types inherited from vctEulerRotation3Base
typedef cmnTypeTraits< double > TypeTraits
Protected Member Functions inherited from vctEulerRotation3Base
void ThrowUnlessIsNormalized (void) const CISST_THROW(std
template<class _inputType>
void ThrowUnlessIsNormalized (const _inputType &input) const CISST_THROW(std
Protected Attributes inherited from vctEulerRotation3Base
vct3 Angles

Member Typedef Documentation

◆ BaseType

◆ ThisType

Constructor & Destructor Documentation

◆ vctEulerRotation3() [1/7]

vctEulerRotation3< _order >::vctEulerRotation3 ( )
inline

◆ vctEulerRotation3() [2/7]

vctEulerRotation3< _order >::vctEulerRotation3 ( const ThisType & other)
inline

◆ vctEulerRotation3() [3/7]

vctEulerRotation3< _order >::vctEulerRotation3 ( double phi,
double theta,
double psi )
inline

◆ vctEulerRotation3() [4/7]

vctEulerRotation3< _order >::vctEulerRotation3 ( double * angles)
inline

◆ vctEulerRotation3() [5/7]

vctEulerRotation3< _order >::vctEulerRotation3 ( const vct3 & angles)
inline

◆ vctEulerRotation3() [6/7]

template<class __containerType>
vctEulerRotation3< _order >::vctEulerRotation3 ( const vctMatrixRotation3Base< __containerType > & matrixRotation)
inline

Constructor from a vctMatrixRotation3.

◆ vctEulerRotation3() [7/7]

template<class __containerType>
vctEulerRotation3< _order >::vctEulerRotation3 ( const vctMatrixRotation3Base< __containerType > & matrixRotation,
bool normalizeInput )
inline

Constructor from a vctMatrixRotation3.

◆ ~vctEulerRotation3()

Member Function Documentation

◆ AlmostEqual()

bool vctEulerRotation3< _order >::AlmostEqual ( const ThisType & other,
double tolerance = TypeTraits::Tolerance() ) const
inline

Return true if this rotation is effectively equal to the other rotation, up to the given tolerance. Rotations may be effectively equal if one is elementwise equal to the other.

The tolerance factor is used to compare each of the elements of the difference vector.

See also
AlmostEquivalent

◆ AlmostEquivalent()

bool vctEulerRotation3< _order >::AlmostEquivalent ( const ThisType & other,
double tolerance = TypeTraits::Tolerance() ) const
inline

Return true if this rotation is effectively equavilent to the other rotation, up to the given tolerance.

The tolerance factor is used to compare each of the elements of the difference vector.

See also
AlmostEqual

◆ DeSerializeRaw()

void vctEulerRotation3< _order >::DeSerializeRaw ( std::istream & inputStream)
inline

Binary deserialization

◆ Equal()

bool vctEulerRotation3< _order >::Equal ( const ThisType & other) const
inline

Return true if this rotation is exactly equal to the other rotation, without any tolerance error. Rotations may be effectively equal if one is elementwise equal to the other.

See also
AlmostEqual

◆ From()

template<class _matrixType>
ThisType & vctEulerRotation3< _order >::From ( const vctMatrixRotation3Base< _matrixType > & matrixRot)
inline

Conversion from a vctMatrixRotation3.

◆ FromNormalized()

template<class _matrixType>
ThisType & vctEulerRotation3< _order >::FromNormalized ( const vctMatrixRotation3Base< _matrixType > & matrixRot)
inline

Conversion from a vctMatrixRotation3.

◆ FromRaw()

template<class _matrixType>
ThisType & vctEulerRotation3< _order >::FromRaw ( const vctMatrixRotation3Base< _matrixType > & matrixRotation)
inline

Conversion from a vctMatrixRotation3.

◆ GetAngles() [1/2]

vct3 & vctEulerRotation3< _order >::GetAngles ( void )
inline

◆ GetAngles() [2/2]

const vct3 & vctEulerRotation3< _order >::GetAngles ( void ) const
inline

Returns the Euler angles in radians

◆ GetAnglesInDegrees()

vct3 vctEulerRotation3< _order >::GetAnglesInDegrees ( void ) const
inline

Returns the Euler angles in degrees

◆ Inverse()

ThisType vctEulerRotation3< _order >::Inverse ( void ) const
inline

Create and return by copy the inverse of this rotation.

◆ InverseOf()

ThisType & vctEulerRotation3< _order >::InverseOf ( const ThisType & otherRotation)
inline

Set this rotation as the inverse of another one. See also InverseSelf().

◆ Normalized()

ThisType vctEulerRotation3< _order >::Normalized ( void ) const
inline

Returns the normalized version of this rotation. This method returns a copy of the normalized rotation and does not modify this rotation. See also NormalizedSelf().

◆ NormalizedOf()

ThisType & vctEulerRotation3< _order >::NormalizedOf ( const ThisType & otherRotation)
inline

Sets this rotation as the normalized version of another one.

Parameters
otherRotationEuler rotation used to compute the normalized rotation.

◆ operator=()

ThisType & vctEulerRotation3< _order >::operator= ( const ThisType & other)
inline

◆ operator==()

bool vctEulerRotation3< _order >::operator== ( const ThisType & other) const
inline

◆ SerializeRaw()

void vctEulerRotation3< _order >::SerializeRaw ( std::ostream & outputStream) const
inline

Binary serialization

◆ ToStream()

void vctEulerRotation3< _order >::ToStream ( std::ostream & outputStream) const
inline

Print the Euler rotation in a human readable format

◆ ToStreamRaw()

void vctEulerRotation3< _order >::ToStreamRaw ( std::ostream & outputStream,
const char delimiter = ' ',
bool headerOnly = false,
const std::string & headerPrefix = "" ) const
inline

Print in machine processable format

◆ ToString()

std::string vctEulerRotation3< _order >::ToString ( void ) const
inline

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