Ceylan::Maths::Linear::Rotation2DFunctor Class Reference

Functor of 2D rotation of specified angle. More...

#include <CeylanEndomorphism.h>

Inheritance diagram for Ceylan::Maths::Linear::Rotation2DFunctor:

[legend]

Collaboration diagram for Ceylan::Maths::Linear::Rotation2DFunctor:

[legend]

List of all members.

Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	Rotation2DFunctor (AngleInDegrees angle)
	Creates the endomorphism corresponding to the 2D rotation of specified angle.
virtual	~Rotation2DFunctor () throw ()
	Virtual destructor.
virtual Vector2	operator() (const Vector2 &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
AngleInRadians	_angle
	The rotation angle, in radian.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.

---

Detailed Description

Functor of 2D rotation of specified angle.

Definition at line 135 of file CeylanEndomorphism.h.

---

Member Enumeration Documentation

enum Ceylan::TextDisplayable::TextOutputFormat [inherited]

Defines what text output formats for TextDisplayable instances are available.

Enumerator:

rawText
html

Definition at line 124 of file CeylanTextDisplayable.h.

---

Constructor & Destructor Documentation

Rotation2DFunctor::Rotation2DFunctor

(

AngleInDegrees

angle

)

[explicit]

Creates the endomorphism corresponding to the 2D rotation of specified 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 76 of file CeylanEndomorphism.cc.

References _angle, and Ceylan::Maths::DegreeToRadian().

Rotation2DFunctor::~Rotation2DFunctor

(

)

throw () [virtual]

Virtual destructor.

Definition at line 86 of file CeylanEndomorphism.cc.

---

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().

Vector2 Rotation2DFunctor::operator()

(

const Vector2 &

v

)

[virtual]

The callable method, returning the projection of v on the axis.

Implements Ceylan::Maths::Linear::Endomorphism2DFunctor.

Definition at line 92 of file CeylanEndomorphism.cc.

References _angle, Ceylan::Maths::Cos(), Ceylan::Maths::Linear::Vector2::getElementAt(), 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 Rotation2DFunctor::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::Endomorphism2DFunctor.

Definition at line 108 of file CeylanEndomorphism.cc.

References _angle.

---

Member Data Documentation

AngleInRadians Ceylan::Maths::Linear::Rotation2DFunctor::_angle [protected]

The rotation angle, in radian.

Definition at line 194 of file CeylanEndomorphism.h.

Referenced by operator()(), Rotation2DFunctor(), 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:

• CeylanEndomorphism.h
• CeylanEndomorphism.cc