srm::OrientationAxisAngle Class Reference

The OrientationAxisAngle class. The Orientation subclass in (axis, angle) representation. More...

#include <Orientation.h>

Inheritance diagram for srm::OrientationAxisAngle:

[legend]Collaboration diagram for srm::OrientationAxisAngle:

[legend]List of all members.

Public Member Functions
	OrientationAxisAngle ()
	Default constructor.
	OrientationAxisAngle (const SRM_Axis_Angle_Params &params)
	Constructor using (axis, angle) parameter.
	OrientationAxisAngle (const SRM_Vector_3D &axis, SRM_Long_Float angle)
	Constructor using (axis, angle) parameters.
	OrientationAxisAngle (const Orientation &other)
	Copy constructor.
virtual Orientation &	operator= (const Orientation &other)
	Assignment operator.
virtual SRM_Axis_Angle_Params	getAxisAngle () const
	Gets the orientation in (axis, angle) representation.
virtual void	setAxisAngle (const SRM_Axis_Angle_Params &params)
	Sets the (axis, angle) orientation representation.
virtual void	setAxisAngle (const SRM_Vector_3D &axis, SRM_Long_Float angle)
	Sets the orientation using (axis, angle) parameters.
virtual std::string	toString () const
	Returns the string for the (axis, angle) orientation representation.
virtual SRM_Ori_Rep_Type	getOriRep () const
	Returns the native orientation representation type.
Static Public Member Functions
bool	isValidParams (const SRM_Axis_Angle_Params &params)
	Returns true if the axis angle parameters represent a valid orientation.
OrientationAxisAngle	compose (const Orientation &left, const Orientation &right)
	Composes the right orientation with the left orientation and returns the result in the output orientation, i.e., composed_ori = left*right.
bool	equivParams (const SRM_Axis_Angle_Params &params1, const SRM_Axis_Angle_Params &params2, SRM_Long_Float tolerance=0.0)
	ref: Table 7
Protected Member Functions
virtual void	_updateIntData () const
	the virtual function to convert the data from native representation to the internal representation
virtual void	_updateRepData ()
	the virtual function to convert the data from internal representation to the native representation
Protected Attributes
SRM_Axis_Angle_Params	_axis_angle

---

Detailed Description

The OrientationAxisAngle class. The Orientation subclass in (axis, angle) representation.

Author:

David Shen

Definition at line 386 of file Orientation.h.

---

Constructor & Destructor Documentation

srm::OrientationAxisAngle::OrientationAxisAngle (   )

Default constructor. The default value is ((1, 0, 0), 0),

srm::OrientationAxisAngle::OrientationAxisAngle (  const SRM_Axis_Angle_Params &  params  )

Constructor using (axis, angle) parameter. Note: the input axis is a unit vector the input angle is in radians in the range of [-2PI, 2PI] Parameters: params  in: the (axis, angle) parameter Exceptions: This  method throws srm::Exception

srm::OrientationAxisAngle::OrientationAxisAngle (  const SRM_Vector_3D &  axis, SRM_Long_Float  angle )

Constructor using (axis, angle) parameters. Parameters: axis  in: the axis of rotation, which is a unit vector angle  in: the angle of rotation, which is in radians in the range of [-2PI, 2PI] Exceptions: This  method throws srm::Exception

---

Member Function Documentation

OrientationAxisAngle srm::OrientationAxisAngle::compose (  const Orientation &  left, const Orientation &  right )  [static]

Composes the right orientation with the left orientation and returns the result in the output orientation, i.e., composed_ori = left*right. Exceptions: This  method throws srm::Exception

virtual void srm::OrientationAxisAngle::setAxisAngle (  const SRM_Vector_3D &  axis, SRM_Long_Float  angle )  [inline, virtual]

Sets the orientation using (axis, angle) parameters. Parameters: axis  in: the axis of rotation, which is a unit vector angle  in: the angle of rotation, which is in radians in the range of [-2PI, 2PI] Exceptions: This  method throws srm::Exception Reimplemented from srm::Orientation. Definition at line 437 of file Orientation.h.

virtual void srm::OrientationAxisAngle::setAxisAngle (  const SRM_Axis_Angle_Params &  params  )  [virtual]

Sets the (axis, angle) orientation representation. Note: the input axis is a unit vector the input angle is in radians in the range of [-2PI, 2PI] Exceptions: This  method throws srm::Exception Reimplemented from srm::Orientation.

---

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

• Orientation.h

---

Spatial Reference Model C++ API	Version 4.4 - December 7, 2009
Copyright © 2009 SEDRIS™	Docs by Doxygen 1.3.2