Ceylan::Maths::Linear::LineProjection3DFunctor Class Reference

Functor of a line projection on specified axis. More...

#include <CeylanEndomorphism.h>

Inheritance diagram for Ceylan::Maths::Linear::LineProjection3DFunctor:

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

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

 LineProjection3DFunctor (const Vector3 &axis)
 Creates the endomorphism corresponding to the line projection of specified axis.
 ~LineProjection3DFunctor () 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.

Static Protected Attributes

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


Detailed Description

Functor of a line projection on specified axis.

Definition at line 274 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

LineProjection3DFunctor::LineProjection3DFunctor ( const Vector3 axis  )  [explicit]

Creates the endomorphism corresponding to the line projection of specified axis.

Note:
axis does not need to be normalized, the constructor will do it.

Definition at line 144 of file CeylanEndomorphism.cc.

References _axis, and Ceylan::Maths::Linear::Vector3::normalize().

LineProjection3DFunctor::~LineProjection3DFunctor (  )  throw ()

Virtual destructor.

Definition at line 154 of file CeylanEndomorphism.cc.


Member Function Documentation

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

Vector3 LineProjection3DFunctor::operator() ( const Vector3 v  )  [virtual]

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

Implements Ceylan::Maths::Linear::Endomorphism3DFunctor.

Definition at line 161 of file CeylanEndomorphism.cc.

References _axis.

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 LineProjection3DFunctor::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 170 of file CeylanEndomorphism.cc.

References _axis, and Ceylan::Maths::Linear::Vector3::toString().


Member Data Documentation

The normalized axis.

Definition at line 330 of file CeylanEndomorphism.h.

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

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