Ceylan::Maths::Linear::Endomorphism3DFunctor Class Reference

Functor encapsulating a 3D endomorphism. More...

#include <CeylanEndomorphism.h>

Inheritance diagram for Ceylan::Maths::Linear::Endomorphism3DFunctor:

Inheritance graph
[legend]
Collaboration diagram for Ceylan::Maths::Linear::Endomorphism3DFunctor:

Collaboration graph
[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

 Endomorphism3DFunctor ()
 Constructs a new functor encapsulating a 3D endomorphism.
virtual ~Endomorphism3DFunctor () throw ()
 Basic virtual destructor.
virtual Vector3 operator() (const Vector3 &v)=0
 The callable method, returning the endomorphism's value corresponding to v.
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.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText
 The text format to be used currently by TextDisplayable instances.


Detailed Description

Functor encapsulating a 3D endomorphism.

Functors are especially useful when the endomorphism can be parametrized.

For example, a rotation needs an angle and an axis to be specified, which a simple pointer to function would not allow nicely, since its only argument should be the vector to transform, not the rotation settings.

Note:
These endomorphisms are in the Linear namespace since they are mostly used with linear matrix-based algrebra, but it does not imply that the endomorphisms must be linear too.

Definition at line 218 of file CeylanEndomorphism.h.


Member Enumeration Documentation

Defines what text output formats for TextDisplayable instances are available.

Enumerator:
rawText 
html 

Definition at line 124 of file CeylanTextDisplayable.h.


Constructor & Destructor Documentation

Endomorphism3DFunctor::Endomorphism3DFunctor (  ) 

Constructs a new functor encapsulating a 3D endomorphism.

Definition at line 122 of file CeylanEndomorphism.cc.

Endomorphism3DFunctor::~Endomorphism3DFunctor (  )  throw () [virtual]

Basic virtual destructor.

Definition at line 128 of file CeylanEndomorphism.cc.


Member Function Documentation

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat (  )  [static, inherited]

virtual Vector3 Ceylan::Maths::Linear::Endomorphism3DFunctor::operator() ( const Vector3 v  )  [pure virtual]

The callable method, returning the endomorphism's value corresponding to v.

Implemented in Ceylan::Maths::Linear::LineProjection3DFunctor, and Ceylan::Maths::Linear::Rotation3DFunctor.

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 Endomorphism3DFunctor::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::Functor.

Reimplemented in Ceylan::Maths::Linear::LineProjection3DFunctor, and Ceylan::Maths::Linear::Rotation3DFunctor.

Definition at line 135 of file CeylanEndomorphism.cc.


Member Data Documentation

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:

Generated on Thu Jun 4 20:40:31 2009 for Ceylan by  doxygen 1.5.8