Ceylan::Locatable Class Reference

Objects that should be locatable in space should inherit from this class. More...

#include <CeylanLocatable.h>

Inheritance diagram for Ceylan::Locatable:

Collaboration diagram for Ceylan::Locatable:

List of all members.

Public Types

enum TextOutputFormat { rawText, html }

Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

Locatable (Locatable &fatherLocatable)

Constructs a new Locatable, defined relatively to its specified fatherLocatable.

Locatable ()

Basic constructor, no father referential registered, therefore considered as an absolute one.

Locatable (Locatable &fatherLocatable, Maths::Linear::Matrix &localReferential)

Constructs a new Locatable, defined relatively to its specified father Locatable, starting with specified local referential.

Locatable (Maths::Linear::Matrix &localReferential)

Basic constructor, no father referential registered, this referential is therefore considered as an absolute one.

virtual ~Locatable () throw ()

Virtual destructor.

virtual bool isAbsolute () const

Returns whether this Locatable is defined absolutely (returns true) or relatively to a father referential (returns false).

virtual bool hasLocalReferential () const

Tells whether this Locatable has a local referential available.

virtual Maths::Linear::Matrix & getLocalReferential () const

Returns this Locatable's referential, expressed in father's space, i.e.

virtual void setLocalReferential (Maths::Linear::Matrix &newGlobalReferential)

Sets the local referential thanks to specified matrix.

virtual void blankLocalReferential ()=0

Blanks local referential, so that its matrix is the null matrix.

virtual bool hasGlobalReferential () const

Tells whether this Locatable has a valid global referential available.

virtual Maths::Linear::Matrix & getGlobalReferential ()

Returns this Locatable's referential, expressed in global (world) space.

virtual bool isUpToDate () const

Tells whether this Locatable's referential is deemed up-to-date in world (global) referential, i.e.

virtual void setUpToDateState (bool newState)

Assigns the up-to-date state of this Locatable, mostly used by father referentials to propagate a change down the referential tree.

virtual void beNotifiedOf (const Event &newEvent)

Notifies this Locatable of a new event.

virtual const std::string toString (VerbosityLevels level=high) const

Returns a user-friendly description of the state of this object.

virtual void add (EventListener &listener)

Registers the specified listener to this source, so that forthcoming events will be sent to it as well.

virtual void remove (const EventListener &listener)

Unregisters the specified listener from this source, no forthcoming event will be sent to the listener.

virtual void removeAllListeners ()

Unsubscribes all registered listeners from this source, no forthcoming event will be sent.

virtual void subscribeTo (EventSource &source)

Subscribes this listener to the specified source, so that forthcoming events will be sent to it as well.

virtual void unsubscribeFrom (EventSource &source)

Unsubscribes this listener from specified source, no forthcoming event will be received from it.

virtual void unsubscribeFromAllSources ()

Unsubscribes this listener from all registered sources, no forthcoming event will be received from any.

virtual void forgetSource (EventSource &source)

Forgets the specified source, but does not notify it that the unsubscription occured on the listener side.

std::list< EventSource * > getSources () const

Returns a shallow copy of the sources that listener is registered to.

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 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 Member Functions

virtual void changed ()

Method to be called when inner referential changed.

virtual void updateFromFather (const Maths::Linear::Matrix &upToDateFatherReferential)=0

Updates this Locatable's state (actually its global referential) from specified matrix, which has to be the up-to-date version of this Locatable's father global referential.

virtual void detachFromFather ()

Detaches this Locatable from its father: their referentials will not be synchronized anymore.

virtual const std::string describe (VerbosityLevels level) const

Returns a generic description of the Locatable.

virtual void notifyAllListeners (const Event &newEvent)

Notifies all currently registered listeners of a new event.

virtual bool isRegistered (const EventListener &listener)

Tells whether specified listener is registered to this source.

Protected Attributes

Locatable * _father

This referential's father, if any.

Maths::Linear::Matrix * _localReferential

The internal referential corresponding to this Locatable, expressed in father's space.

Maths::Linear::Matrix * _globalReferential

Pre-computed referential, from world space (global) to this referential.

ReferentialChangedEvent * _changedEvent

This internal event is allocated the first time this Locatable changes its referential, one time for all: for next changes, that same event will be changed accordingly abd then propagated again.

std::list< EventListener * > _listeners

The registered event listeners.

std::list< EventSource * > _sources

The event sources to which this listener is subscribed to.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText

The text format to be used currently by TextDisplayable instances.

static TextOutputFormat _OutputFormat = rawText

The text format to be used currently by TextDisplayable instances.

Private Member Functions

Locatable & operator= (const Locatable &source)

No private copy constructor could be declared, as there us already a constructor which takes a Locatable, even though this parameter is not 'const'.

Private Attributes

bool _isUpToDate

Tells whether the internal referential is up-to-date.

Detailed Description

Objects that should be locatable in space should inherit from this class.

Being Locatable is the synonym of having a referential, either local, i.e. defined relatively to another father referential, or absolute, i.e. directly expressed in 'world' coordinate.

Each Locatable owns two referentials, one, as explained before, relative to its father (called the local referential), and one that precomputes all the transformations between this referential and the root of the referential tree, i.e. the world referential. This second referential is called the global referential for the given Locatable instance.

A Locatable embeds two matrices, one for each of the two referentials. These matrices should be in most cases homogeneous matrices, allowing the Locatable to define a referential that locates this object relatively to its parent referential, both in terms of position and orientation.

The dimension of the matrix depends on the space into which the Locatable is defined (ex: 2D, 3D), and on whether an homogeneous matrix is used. In this case, the matrix dimension must be incremented: for instance, Locatable instances in a 2D world should embed two 3x3 homogeneous matrices.

A referential is defined by both a point in space and a set of angles or vectors that indicates its orientation: from that information, the relevant transformation (combination of translations and rotations) can be computed.

The local referential is a matrix Mlf that transforms points expressed in the local referential Pl into points expressed in the father referential Pf: Pf = Mlf.Pl

The referentials are organized as a tree, where the children of a node have referentials that are defined relatively to this node's referential.

There may be only one tree, therefore one root, so that taking into account the camera is easier: the global matrix, root of the referential hierarchy, may have for matrix the camera's one, so that the computed global matrices have all the necessary transformations registered, in order to perform all steps at once, including camera management.

The up-to-date state of a Locatable's global referential (world to local) is managed. Starting from a situation where all global referentials are up-to-date, a change of a node (its local referential changes relatively to its father) into the Locatable hierarchy triggers the following: its up-to-date state is set to false, therefore preventing the use of its now outdated global referential, and all the subtree it is the root of is recursively set as 'not up-to-date'. A property flows from it: there is no need to propagate 'not up-to-date' status when encountering a node which was already not up-to-date, since all its children must already be in 'not up-to-date' state.

See also:: The changed method.

For a node having registered the fact that its global referential is not up-to-date, but needing this global referential, it has to ask its father for its own global referential. The father node, depending on its up-to-date state, recomputes or returns directly its global referential. Then this node, from this returned father global referential and using its own new local referential, computes its new global referential. It is, from now on, up-to-date until a change occurs, at its level or in the path from itself to its root referential.

Note:: Some methods, such as setCenter(const Point & newCenter) could be proposed here, but it would involve dynamic casting, which may fail (ex: myPoint2D.setCenter( aPoint3D )), therefore they all would have to throw exceptions, which should would have to be caught, etc. To avoid such complications, these operators are defined specifically for each child class, instead of being defined generally in this root abstract class: a simpler approach is to define them appropriately, at the right level, the implementation one.
Always remember to call setUpToDateState(false) when any change is done on the local referential.

Definition at line 179 of file CeylanLocatable.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.

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

Locatable::Locatable ( Locatable & fatherLocatable ) [explicit]

Constructs a new Locatable, defined relatively to its specified fatherLocatable.

Note:: The father Locatable is not owned by this object, which has only a reference onto it. Reciprocally, this Locatable will register itself to its father, so that it can it can be notified of its father's change.
This is not meant to be a copy constructor. Father locatable cannot be 'const' since registering to it is a non-const operation.

Definition at line 87 of file CeylanLocatable.cc.

References _father, dataUtils::e, Ceylan::EventListener::subscribeTo(), and Ceylan::Exception::toString().

Locatable::Locatable ( )

Basic constructor, no father referential registered, therefore considered as an absolute one.

Definition at line 121 of file CeylanLocatable.cc.

Locatable::Locatable	(	Locatable &	fatherLocatable,
		Maths::Linear::Matrix &	localReferential
	)

Constructs a new Locatable, defined relatively to its specified father Locatable, starting with specified local referential.

Parameters:

	fatherLocatable	the referential this Locatable will be defined relatively to.
	localReferential	the transformation matrix that converts vectors expressed in the referential defined by this Locatable to vectors expressed in the referential defined by the parent Locatable. This Locatable takes ownership of the specified matrix.

Note:

The father Locatable is not owned by this object, which has only a reference onto it. Reciprocally, this Locatable will register itself to its father, so that it can it can be notified of its father's change.

Father locatable cannot be 'const' since registering to it is a non-const operation.

The Locatable will take ownership of the specified referential, hence will deallocate it when appropriate.

Definition at line 133 of file CeylanLocatable.cc.

References _father, dataUtils::e, Ceylan::EventListener::subscribeTo(), and Ceylan::Exception::toString().

Locatable::Locatable ( Maths::Linear::Matrix & localReferential ) [explicit]

Basic constructor, no father referential registered, this referential is therefore considered as an absolute one.

Its local referential, which is in this particular case a global one too, is specified.

Note:: The Locatable will take ownership of the specified referential.

Definition at line 164 of file CeylanLocatable.cc.

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

Virtual destructor.

Definition at line 176 of file CeylanLocatable.cc.

References _changedEvent, _father, _globalReferential, _localReferential, detachFromFather(), dataUtils::e, Ceylan::EventSource::removeAllListeners(), and Ceylan::Exception::toString().

Member Function Documentation

void EventSource::add ( EventListener & listener ) [virtual, inherited]

Registers the specified listener to this source, so that forthcoming events will be sent to it as well.

Exceptions:

EventException

if listener is already registered to the event source.

Definition at line 118 of file CeylanEventSource.cc.

References Ceylan::EventSource::_listeners, and Ceylan::EventListener::toString().

Referenced by Ceylan::EventListener::subscribeTo().

void Locatable::beNotifiedOf ( const Event & newEvent ) [virtual]

Notifies this Locatable of a new event.

Note:: Only ReferentialChangedEvents are taken into account, others are ignored.
This event remains property of the EventSource, which will take care of its life cycle.

Implements Ceylan::EventListener.

Definition at line 361 of file CeylanLocatable.cc.

References setUpToDateState().

virtual void Ceylan::Locatable::blankLocalReferential ( ) [pure virtual]

Blanks local referential, so that its matrix is the null matrix.

Note:: If no referential was existing, a new one is created.

This method is pure virtual since blanking and creation depend on the inner matrix.

Implemented in Ceylan::Locatable2D.

void Locatable::changed ( ) [protected, virtual]

Method to be called when inner referential changed.

Its role is to propagate a corresponding ReferentialChangedEvent to this Locatable's children.

Definition at line 389 of file CeylanLocatable.cc.

References _changedEvent, _globalReferential, and Ceylan::EventSource::notifyAllListeners().

Referenced by setUpToDateState().

const string Locatable::describe ( VerbosityLevels level ) const [protected, virtual]

Returns a generic description of the Locatable.

Useful to share this part of the description among the children to ease toString management.

Definition at line 430 of file CeylanLocatable.cc.

References _globalReferential, Ceylan::EventSource::_listeners, _localReferential, Ceylan::high, toString(), and Ceylan::Maths::Linear::Matrix::toString().

Referenced by Ceylan::Locatable2D::toString(), and toString().

void Locatable::detachFromFather ( ) [protected, virtual]

Detaches this Locatable from its father: their referentials will not be synchronized anymore.

Exceptions:

LocatableException

if this Locatable had no father or was not linked to it.

Definition at line 408 of file CeylanLocatable.cc.

References _father, dataUtils::e, Ceylan::Exception::toString(), and Ceylan::EventListener::unsubscribeFrom().

Referenced by ~Locatable().

void EventListener::forgetSource ( EventSource & source ) [virtual, inherited]

Forgets the specified source, but does not notify it that the unsubscription occured on the listener side.

Therefore, if the source were to send new events, this listener would be notified, and may not be aware it received an event from a source it is not registered to any more.

See also:: beNotifiedOf

This method should mostly be used by event sources being deallocated, having realized that some listeners were still subscribed, and wanting nevertheless that the listeners remove these sources from their list. Otherwise, on the source side, should unsubscribeFrom be used instead, the listeners list would be modified in turn while iterating on it in the source destructor, which may cause a crash.

Alternatively, on these listener deallocations, if nothing was done in the case of a deallocated source still having at least one listener left, a call to the remove method of these source instances would be tempted, and may cause a crash since sources could be already deallocated.

Note:: This method is therefore a parachute which should not be used by the application. It is used too when the source has to manage the life cycle of its listeners, and has to deallocate them.

This listener can be registered multiple times to this source.

Exceptions:

EventException

if listener was not already registered to the event source, and if debug mode for events is activated.

Definition at line 191 of file CeylanEventListener.cc.

References Ceylan::EventListener::_sources, generalUtils::false, Ceylan::EventSource::toString(), and generalUtils::true.

Matrix & Locatable::getGlobalReferential ( ) [virtual]

Returns this Locatable's referential, expressed in global (world) space.

Returns:: the internal up-to-date global referential. It is still owned by the Locatable.

Exceptions:

LocatableException

if no referential is available.

Note:: Everything necessary is done to return the global referential, be it already available, up-to-date, etc., or not.

Definition at line 262 of file CeylanLocatable.cc.

References _father, _globalReferential, _isUpToDate, _localReferential, Ceylan::emergencyShutdown(), getGlobalReferential(), isAbsolute(), setUpToDateState(), and updateFromFather().

Referenced by getGlobalReferential().

Matrix & Locatable::getLocalReferential ( ) const [virtual]

Returns this Locatable's referential, expressed in father's space, i.e.

returns the local referential of this Locatable 'as is'.

Exceptions:

LocatableException

if no local referential is available.

Reimplemented in Ceylan::Locatable2D.

Definition at line 231 of file CeylanLocatable.cc.

References _localReferential.

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

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

list< EventSource * > EventListener::getSources ( ) const [inherited]

Returns a shallow copy of the sources that listener is registered to.

Note:: The returned list contains the same pointer values as the internal one.

Definition at line 238 of file CeylanEventListener.cc.

References Ceylan::EventListener::_sources.

bool Locatable::hasGlobalReferential ( ) const [virtual]

Tells whether this Locatable has a valid global referential available.

Definition at line 253 of file CeylanLocatable.cc.

References _globalReferential.

bool Locatable::hasLocalReferential ( ) const [virtual]

Tells whether this Locatable has a local referential available.

Note:: It should be the case in most situations.

Definition at line 222 of file CeylanLocatable.cc.

References _localReferential.

bool Locatable::isAbsolute ( ) const [virtual]

Returns whether this Locatable is defined absolutely (returns true) or relatively to a father referential (returns false).

Note:: Only the root referential is absolute. For the world tree, the local referential of absolute referentials corresponds to the camera matrix.

Definition at line 213 of file CeylanLocatable.cc.

References _father.

Referenced by getGlobalReferential(), Ceylan::Locatable2D::toString(), and toString().

bool EventSource::isRegistered ( const EventListener & listener ) [protected, virtual, inherited]

Tells whether specified listener is registered to this source.

Definition at line 252 of file CeylanEventSource.cc.

References Ceylan::EventSource::_listeners, and generalUtils::false.

bool Locatable::isUpToDate ( ) const [virtual]

Tells whether this Locatable's referential is deemed up-to-date in world (global) referential, i.e.

if all the Locatable instances from this one to the root of its tree are up-to-date, bounds included.

Definition at line 324 of file CeylanLocatable.cc.

References _isUpToDate.

void EventSource::notifyAllListeners ( const Event & newEvent ) [protected, virtual, inherited]

Notifies all currently registered listeners of a new event.

Note:: This source takes ownership of this event.

Definition at line 270 of file CeylanEventSource.cc.

References Ceylan::EventSource::_listeners.

Referenced by changed(), and Ceylan::Model::notifyAllViews().

Locatable& Ceylan::Locatable::operator= ( const Locatable & source ) [private]

No private copy constructor could be declared, as there us already a constructor which takes a Locatable, even though this parameter is not 'const'.

Assignment operator made private to ensure that it will be never called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

void EventSource::remove ( const EventListener & listener ) [virtual, inherited]

Unregisters the specified listener from this source, no forthcoming event will be sent to the listener.

Exceptions:

EventException

if listener was not already registered to the event source.

Note:: This method does nothing special with regard to the listener instance, it acts only on the source. The reason for that is that the unsubscriptions should be initiated on the listener side, not on the source one.

See also:: Ceylan::EventListener::unsubscribeFrom

Definition at line 142 of file CeylanEventSource.cc.

References Ceylan::EventSource::_listeners, generalUtils::false, Ceylan::EventListener::toString(), and generalUtils::true.

void EventSource::removeAllListeners ( ) [virtual, inherited]

Unsubscribes all registered listeners from this source, no forthcoming event will be sent.

This source will request each of its listeners to unsubscribe from it, then the source will forget them in turn.

The links will be removed, but no instance will be deleted by this call.

See also:: Ceylan::EventListener::unsubscribeFromAllSources

Definition at line 204 of file CeylanEventSource.cc.

References Ceylan::EventSource::_listeners.

Referenced by Ceylan::Model::removeAllViews(), and ~Locatable().

void Locatable::setLocalReferential ( Maths::Linear::Matrix & newGlobalReferential ) [virtual]

Sets the local referential thanks to specified matrix.

Note:: This Locatable takes ownership of the specified matrix.

Definition at line 244 of file CeylanLocatable.cc.

References _localReferential.

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

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

void Locatable::setUpToDateState ( bool newState ) [virtual]

Assigns the up-to-date state of this Locatable, mostly used by father referentials to propagate a change down the referential tree.

Definition at line 333 of file CeylanLocatable.cc.

References _isUpToDate, and changed().

Referenced by beNotifiedOf(), getGlobalReferential(), and Ceylan::Locatable2D::setCenter().

void EventListener::subscribeTo ( EventSource & source ) [virtual, inherited]

Subscribes this listener to the specified source, so that forthcoming events will be sent to it as well.

Note:: A listener can be subscribed to multiple sources at once.

Exceptions:

EventException

if listener is already registered to the specified event source.

Definition at line 87 of file CeylanEventListener.cc.

References Ceylan::EventListener::_sources, Ceylan::EventSource::add(), and Ceylan::EventSource::toString().

Referenced by Ceylan::Controller::Controller(), Ceylan::EventListener::EventListener(), Locatable(), and Ceylan::Model::subscribeToController().

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 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 Locatable::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::EventListener.

Reimplemented in Ceylan::Locatable2D.

Definition at line 373 of file CeylanLocatable.cc.

References describe(), and isAbsolute().

Referenced by describe().

void EventListener::unsubscribeFrom ( EventSource & source ) [virtual, inherited]

Unsubscribes this listener from specified source, no forthcoming event will be received from it.

This is the usual method to call when one wants that this listener to not listen any more to the specified source.

It is in fact implemented by notifying this source of the unsubscription of this listener, and by forgetting it.

Exceptions:

EventException

if listener was not already registered to the event source.

Definition at line 113 of file CeylanEventListener.cc.

References Ceylan::EventListener::_sources, and Ceylan::EventSource::toString().

Referenced by detachFromFather(), and Ceylan::Model::unsubscribeFromController().

void EventListener::unsubscribeFromAllSources ( ) [virtual, inherited]

Unsubscribes this listener from all registered sources, no forthcoming event will be received from any.

Definition at line 160 of file CeylanEventListener.cc.

References Ceylan::EventListener::_sources.

Referenced by Ceylan::Model::unsubscribeFromAllControllers(), and Ceylan::EventListener::~EventListener().

virtual void Ceylan::Locatable::updateFromFather ( const Maths::Linear::Matrix & upToDateFatherReferential ) [protected, pure virtual]

Updates this Locatable's state (actually its global referential) from specified matrix, which has to be the up-to-date version of this Locatable's father global referential.

Note:: Basically, it consists on applying the father transformation to the local one to have a fully world-to-local precomputed transformation.
This is a pure virtual method since only the relevant Matrix type shall be called (ex: Matrix3).

Implemented in Ceylan::Locatable2D.

Referenced by getGlobalReferential().

Member Data Documentation

ReferentialChangedEvent* Ceylan::Locatable::_changedEvent [protected]

This internal event is allocated the first time this Locatable changes its referential, one time for all: for next changes, that same event will be changed accordingly abd then propagated again.

Definition at line 502 of file CeylanLocatable.h.

Referenced by changed(), and ~Locatable().

Locatable* Ceylan::Locatable::_father [protected]

This referential's father, if any.

Note:: The father is not owned by any of its children.

Definition at line 468 of file CeylanLocatable.h.

Referenced by detachFromFather(), getGlobalReferential(), isAbsolute(), Locatable(), and ~Locatable().

Maths::Linear::Matrix* Ceylan::Locatable::_globalReferential [protected]

Pre-computed referential, from world space (global) to this referential.

Note:: This referential may be blank, as long as its computation is not requested.

Definition at line 490 of file CeylanLocatable.h.

Referenced by changed(), describe(), getGlobalReferential(), hasGlobalReferential(), Ceylan::Locatable2D::updateFromFather(), and ~Locatable().

bool Ceylan::Locatable::_isUpToDate [private]

Tells whether the internal referential is up-to-date.

Note:: Not private since child classes will have to manage it specifically as well.

Definition at line 516 of file CeylanLocatable.h.

Referenced by getGlobalReferential(), isUpToDate(), and setUpToDateState().

std::list<EventListener *> Ceylan::EventSource::_listeners [protected, inherited]

The registered event listeners.

Definition at line 204 of file CeylanEventSource.h.

Referenced by Ceylan::EventSource::add(), describe(), Ceylan::EventSource::isRegistered(), Ceylan::EventSource::notifyAllListeners(), Ceylan::EventSource::remove(), Ceylan::EventSource::removeAllListeners(), Ceylan::Model::toString(), Ceylan::EventSource::toString(), Ceylan::Controller::toString(), and Ceylan::EventSource::~EventSource().

Maths::Linear::Matrix* Ceylan::Locatable::_localReferential [protected]

The internal referential corresponding to this Locatable, expressed in father's space.

Note:: Even the local referential must be a pointer, since Matrix is abstract.

Definition at line 479 of file CeylanLocatable.h.

Referenced by Ceylan::Locatable2D::blankLocalReferential(), describe(), getGlobalReferential(), Ceylan::Locatable2D::getLocalReferential(), getLocalReferential(), hasLocalReferential(), Ceylan::Locatable2D::setCenter(), setLocalReferential(), Ceylan::Locatable2D::updateFromFather(), and ~Locatable().

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

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

std::list<EventSource *> Ceylan::EventListener::_sources [protected, inherited]

The event sources to which this listener is subscribed to.

Definition at line 233 of file CeylanEventListener.h.

Referenced by Ceylan::EventListener::forgetSource(), Ceylan::View::getModel(), Ceylan::EventListener::getSources(), Ceylan::EventListener::subscribeTo(), Ceylan::View::toString(), Ceylan::Model::toString(), Ceylan::EventListener::toString(), Ceylan::EventListener::unsubscribeFrom(), Ceylan::EventListener::unsubscribeFromAllSources(), and Ceylan::EventListener::~EventListener().

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


Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	Locatable (Locatable &fatherLocatable)
	Constructs a new Locatable, defined relatively to its specified fatherLocatable.
	Locatable ()
	Basic constructor, no father referential registered, therefore considered as an absolute one.
	Locatable (Locatable &fatherLocatable, Maths::Linear::Matrix &localReferential)
	Constructs a new Locatable, defined relatively to its specified father Locatable, starting with specified local referential.
	Locatable (Maths::Linear::Matrix &localReferential)
	Basic constructor, no father referential registered, this referential is therefore considered as an absolute one.
virtual	~Locatable () throw ()
	Virtual destructor.
virtual bool	isAbsolute () const
	Returns whether this Locatable is defined absolutely (returns true) or relatively to a father referential (returns false).
virtual bool	hasLocalReferential () const
	Tells whether this Locatable has a local referential available.
virtual Maths::Linear::Matrix &	getLocalReferential () const
	Returns this Locatable's referential, expressed in father's space, i.e.
virtual void	setLocalReferential (Maths::Linear::Matrix &newGlobalReferential)
	Sets the local referential thanks to specified matrix.
virtual void	blankLocalReferential ()=0
	Blanks local referential, so that its matrix is the null matrix.
virtual bool	hasGlobalReferential () const
	Tells whether this Locatable has a valid global referential available.
virtual Maths::Linear::Matrix &	getGlobalReferential ()
	Returns this Locatable's referential, expressed in global (world) space.
virtual bool	isUpToDate () const
	Tells whether this Locatable's referential is deemed up-to-date in world (global) referential, i.e.
virtual void	setUpToDateState (bool newState)
	Assigns the up-to-date state of this Locatable, mostly used by father referentials to propagate a change down the referential tree.
virtual void	beNotifiedOf (const Event &newEvent)
	Notifies this Locatable of a new event.
virtual const std::string	toString (VerbosityLevels level=high) const
	Returns a user-friendly description of the state of this object.
virtual void	add (EventListener &listener)
	Registers the specified listener to this source, so that forthcoming events will be sent to it as well.
virtual void	remove (const EventListener &listener)
	Unregisters the specified listener from this source, no forthcoming event will be sent to the listener.
virtual void	removeAllListeners ()
	Unsubscribes all registered listeners from this source, no forthcoming event will be sent.
virtual void	subscribeTo (EventSource &source)
	Subscribes this listener to the specified source, so that forthcoming events will be sent to it as well.
virtual void	unsubscribeFrom (EventSource &source)
	Unsubscribes this listener from specified source, no forthcoming event will be received from it.
virtual void	unsubscribeFromAllSources ()
	Unsubscribes this listener from all registered sources, no forthcoming event will be received from any.
virtual void	forgetSource (EventSource &source)
	Forgets the specified source, but does not notify it that the unsubscription occured on the listener side.
std::list< EventSource * >	getSources () const
	Returns a shallow copy of the sources that listener is registered to.
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 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 Member Functions
virtual void	changed ()
	Method to be called when inner referential changed.
virtual void	updateFromFather (const Maths::Linear::Matrix &upToDateFatherReferential)=0
	Updates this Locatable's state (actually its global referential) from specified matrix, which has to be the up-to-date version of this Locatable's father global referential.
virtual void	detachFromFather ()
	Detaches this Locatable from its father: their referentials will not be synchronized anymore.
virtual const std::string	describe (VerbosityLevels level) const
	Returns a generic description of the Locatable.
virtual void	notifyAllListeners (const Event &newEvent)
	Notifies all currently registered listeners of a new event.
virtual bool	isRegistered (const EventListener &listener)
	Tells whether specified listener is registered to this source.
Protected Attributes
Locatable *	_father
	This referential's father, if any.
Maths::Linear::Matrix *	_localReferential
	The internal referential corresponding to this Locatable, expressed in father's space.
Maths::Linear::Matrix *	_globalReferential
	Pre-computed referential, from world space (global) to this referential.
ReferentialChangedEvent *	_changedEvent
	This internal event is allocated the first time this Locatable changes its referential, one time for all: for next changes, that same event will be changed accordingly abd then propagated again.
std::list< EventListener * >	_listeners
	The registered event listeners.
std::list< EventSource * >	_sources
	The event sources to which this listener is subscribed to.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.
Private Member Functions
Locatable &	operator= (const Locatable &source)
	No private copy constructor could be declared, as there us already a constructor which takes a Locatable, even though this parameter is not 'const'.
Private Attributes
bool	_isUpToDate
	Tells whether the internal referential is up-to-date.