Ceylan::Maths::Linear::Rotation3DFunctor Class Reference
Functor for 3D rotation relative to specified axis, of specified angle. More...
#include <CeylanEndomorphism.h>
Public Types | |
| enum | TextOutputFormat { rawText, html } |
| Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
| Rotation3DFunctor (const Vector3 &axis, AngleInDegrees angle) | |
| Creates the endomorphism corresponding to the 3D rotation of specified axis and angle. | |
| virtual | ~Rotation3DFunctor () throw () |
| Virtual destructor. | |
| virtual Vector3 | operator() (const Vector3 &v) |
| The callable method, returning the projection of v on the axis. | |
| virtual const std::string | toString (VerbosityLevels level=high) const |
| Returns a user-friendly description of the state of this object. | |
Static Public Member Functions | |
| static const std::string | ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high) |
| Returns a user-friendly description of this list of pointers to text displayable instances. | |
| static TextOutputFormat | GetOutputFormat () |
| Returns the current overall text format to be used by TextDisplayable instances. | |
| static void | SetOutputFormat (TextOutputFormat newOutputFormat) |
| Sets the current overall text format to be used by TextDisplayable instances. | |
Protected Attributes | |
| Vector3 | _axis |
| The normalized axis. | |
| AngleInRadians | _angle |
| The rotation angle, in radians. | |
Static Protected Attributes | |
| static TextOutputFormat | _OutputFormat = rawText |
| The text format to be used currently by TextDisplayable instances. | |
Detailed Description
Functor for 3D rotation relative to specified axis, of specified angle.Definition at line 342 of file CeylanEndomorphism.h.
Member Enumeration Documentation
enum Ceylan::TextDisplayable::TextOutputFormat [inherited] |
Defines what text output formats for TextDisplayable instances are available.
Definition at line 124 of file CeylanTextDisplayable.h.
Constructor & Destructor Documentation
| Rotation3DFunctor::Rotation3DFunctor | ( | const Vector3 & | axis, | |
| AngleInDegrees | angle | |||
| ) | [explicit] |
Creates the endomorphism corresponding to the 3D rotation of specified axis and angle.
- Parameters:
-
axis The axis of this rotation. angle The axis, in degrees, of this rotation.
- Note:
- axis does not need to be normalized, the constructor will do it.
Definition at line 180 of file CeylanEndomorphism.cc.
References _angle, _axis, Ceylan::Maths::DegreeToRadian(), and Ceylan::Maths::Linear::Vector3::normalize().
| Rotation3DFunctor::~Rotation3DFunctor | ( | ) | throw () [virtual] |
Member Function Documentation
| TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat | ( | ) | [static, inherited] |
Returns the current overall text format to be used by TextDisplayable instances.
Definition at line 63 of file CeylanTextDisplayable.cc.
References Ceylan::TextDisplayable::_OutputFormat.
Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().
The callable method, returning the projection of v on the axis.
Implements Ceylan::Maths::Linear::Endomorphism3DFunctor.
Definition at line 200 of file CeylanEndomorphism.cc.
References _angle, _axis, Ceylan::Maths::Cos(), and Ceylan::Maths::Sin().
| void TextDisplayable::SetOutputFormat | ( | TextOutputFormat | newOutputFormat | ) | [static, inherited] |
Sets the current overall text format to be used by TextDisplayable instances.
- Parameters:
-
newOutputFormat the new output format.
Definition at line 72 of file CeylanTextDisplayable.cc.
References Ceylan::TextDisplayable::_OutputFormat.
Referenced by Ceylan::Log::LogHolder::LogHolder().
| const std::string TextDisplayable::ToString | ( | std::list< TextDisplayable * > | displayables, | |
| Ceylan::VerbosityLevels | level = Ceylan::high | |||
| ) | [static, inherited] |
Returns a user-friendly description of this list of pointers to text displayable instances.
- Parameters:
-
displayables a list of pointers to TextDisplayable instances/ level the requested verbosity level.
- Note:
- Text output format is determined from overall settings.
- See also:
- toString, Ceylan::VerbosityLevels
Definition at line 45 of file CeylanTextDisplayable.cc.
References Ceylan::formatStringList().
| const string Rotation3DFunctor::toString | ( | VerbosityLevels | level = high |
) | const [virtual] |
Returns a user-friendly description of the state of this object.
- Parameters:
-
level the requested verbosity level.
- Note:
- Text output format is determined from overall settings.
- See also:
- TextDisplayable
Reimplemented from Ceylan::Maths::Linear::Endomorphism3DFunctor.
Definition at line 211 of file CeylanEndomorphism.cc.
References _angle, _axis, and Ceylan::Maths::Linear::Vector3::toString().
Member Data Documentation
The rotation angle, in radians.
Definition at line 405 of file CeylanEndomorphism.h.
Referenced by operator()(), Rotation3DFunctor(), and toString().
The normalized axis.
Definition at line 401 of file CeylanEndomorphism.h.
Referenced by operator()(), Rotation3DFunctor(), and toString().
TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited] |
The text format to be used currently by TextDisplayable instances.
- Note:
- Defaults to raw text.
Definition at line 158 of file CeylanTextDisplayable.h.
Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().
The documentation for this class was generated from the following files:
