Ceylan::Locatable2D Class Reference

Objects that should be locatable in a 2D-space should inherit from this class. More...

#include <CeylanLocatable2D.h>

Inheritance diagram for Ceylan::Locatable2D:

[legend]

Collaboration diagram for Ceylan::Locatable2D:

[legend]

List of all members.

Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	Locatable2D (Locatable2D &fatherLocatable)
	Constructs a new Locatable2D, defined relatively to its specified fatherLocatable.
	Locatable2D ()
	Basic constructor, no local nor father referential registered.
	Locatable2D (Locatable2D &fatherLocatable, Maths::Linear::Matrix &localReferential)
	Constructs a new Locatable2D, defined relatively to its specified father Locatable, starting with specified local referential.
	Locatable2D (Maths::Linear::Matrix &localReferential)
	Basic constructor, no father referential registered, this referential is therefore considered as an absolute on.
virtual	~Locatable2D () throw ()
	Virtual destructor.
virtual Maths::Linear::Matrix &	getLocalReferential () const
	Returns this Locatable's referential, expressed in father's space.
virtual void	blankLocalReferential ()
	Blanks local referential, so that its matrix is the identity matrix.
virtual Ceylan::Maths::Linear::Bipoint	getCenter () const
	Returns the center of this Locatable, expressed in father space.
virtual void	setCenter (const Ceylan::Maths::Linear::Bipoint &newCenter)
	Sets the center of the local referential.
virtual void	setCenter (Ceylan::Maths::Real newX=0, Ceylan::Maths::Real newY=0)
	Sets the center of the local referential.
virtual const std::string	toString (VerbosityLevels level=high) const
	Returns a user-friendly description of the state of this object.
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 void	setLocalReferential (Maths::Linear::Matrix &newGlobalReferential)
	Sets the local referential thanks to specified 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 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 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 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 void	SetOutputFormat (TextOutputFormat newOutputFormat)
	Sets the current overall text format to be used by TextDisplayable instances.
Protected Member Functions
virtual void	updateFromFather (const Maths::Linear::Matrix &upToDateFatherReferential)
	Updates this Locatable's state (actually its precooked global referential) from specified matrix, which is the up-to-date version of this Locatable's father referential.
Ceylan::Maths::Linear::HomogeneousMatrix3 &	getLocalMatrix () const
	Helper non-virtual inline method to easily retrieve the internal matrix with correct (already casted) type (ex: HomogeneousMatrix3, not Matrix).
virtual void	changed ()
	Method to be called when inner referential changed.
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.

Detailed Description

Objects that should be locatable in a 2D-space should inherit from this class.

Note:: A Locatable2D embeds a 3x3 homogeneous matrix, allowing it to define a referential that locates this object relatively to its parent referential.

A referential is defined by both a point in space and a set of angles or vectors that indicates which orientation it has.

Definition at line 56 of file CeylanLocatable2D.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

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

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

This local referential describes on creation the same referential as the father one, since the transformation between this referential and its fathers is the identity.

Note:: The father Locatable2D is not owned by this object, which has only a reference onto it. It cannot be specified as 'const' since the non-const getGlobalReferential method should be callable on it.

Definition at line 54 of file CeylanLocatable2D.cc.

References blankLocalReferential().

Locatable2D::Locatable2D ( )

Basic constructor, no local nor father referential registered.

Definition at line 64 of file CeylanLocatable2D.cc.

References blankLocalReferential().

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

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

Parameters:

	fatherLocatable	the referential this referential is relative to.
	localReferential	the transformation from this local referential to its father referential.

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 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.; The Locatable will take ownership of the specified referential.

Definition at line 74 of file CeylanLocatable2D.cc.

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

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

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 83 of file CeylanLocatable2D.cc.

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

Virtual destructor.

Definition at line 91 of file CeylanLocatable2D.cc.

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::Model::addView(), Ceylan::EventSource::EventSource(), and Ceylan::EventListener::subscribeTo().

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

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 Ceylan::Locatable::setUpToDateState().

void Locatable2D::blankLocalReferential ( ) [virtual]

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

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

Implements Ceylan::Locatable.

Definition at line 120 of file CeylanLocatable2D.cc.

References Ceylan::Locatable::_localReferential, and Ceylan::Maths::Linear::Matrix::setToIdentity().

Referenced by Locatable2D().

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

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 Ceylan::Locatable::_changedEvent, Ceylan::Locatable::_globalReferential, and Ceylan::EventSource::notifyAllListeners().

Referenced by Ceylan::Locatable::setUpToDateState().

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

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 Ceylan::Locatable::_globalReferential, Ceylan::EventSource::_listeners, Ceylan::Locatable::_localReferential, Ceylan::high, Ceylan::Locatable::toString(), and Ceylan::Maths::Linear::Matrix::toString().

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

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

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 Ceylan::Locatable::_father, dataUtils::e, Ceylan::Exception::toString(), and Ceylan::EventListener::unsubscribeFrom().

Referenced by Ceylan::Locatable::~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.

Bipoint Locatable2D::getCenter ( ) const [virtual]

Returns the center of this Locatable, expressed in father space.

Coordinates are modified according to the homogeneous factor: they are normalized.

Exceptions:

LocatableException

if no relevant local referential was available, or if the homogeneous factor is zero.

Definition at line 133 of file CeylanLocatable2D.cc.

References Ceylan::Maths::Linear::Matrix3::getElementAt(), getLocalMatrix(), Ceylan::Maths::IsNull(), and Ceylan::toString().

Matrix & Locatable::getGlobalReferential ( ) [virtual, inherited]

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 Ceylan::Locatable::_father, Ceylan::Locatable::_globalReferential, Ceylan::Locatable::_isUpToDate, Ceylan::Locatable::_localReferential, Ceylan::emergencyShutdown(), Ceylan::Locatable::getGlobalReferential(), Ceylan::Locatable::isAbsolute(), Ceylan::Locatable::setUpToDateState(), and Ceylan::Locatable::updateFromFather().

Referenced by Ceylan::Locatable::getGlobalReferential().

Ceylan::Maths::Linear::HomogeneousMatrix3& Ceylan::Locatable2D::getLocalMatrix ( ) const [inline, protected]

Helper non-virtual inline method to easily retrieve the internal matrix with correct (already casted) type (ex: HomogeneousMatrix3, not Matrix).

Definition at line 255 of file CeylanLocatable2D.h.

References generalUtils::temp.

Referenced by getCenter(), and setCenter().

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

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

Note:: The C++ feature of returning a Matrix3 instead of its mother class Matrix could be used if gcc did not issue 'conflicting return type specified'.

Reimplemented from Ceylan::Locatable.

Definition at line 100 of file CeylanLocatable2D.cc.

References Ceylan::Locatable::_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, inherited]

Tells whether this Locatable has a valid global referential available.

Definition at line 253 of file CeylanLocatable.cc.

References Ceylan::Locatable::_globalReferential.

bool Locatable::hasLocalReferential ( ) const [virtual, inherited]

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 Ceylan::Locatable::_localReferential.

bool Locatable::isAbsolute ( ) const [virtual, inherited]

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 Ceylan::Locatable::_father.

Referenced by Ceylan::Locatable::getGlobalReferential(), toString(), and Ceylan::Locatable::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, inherited]

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 Ceylan::Locatable::_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 Ceylan::Locatable::changed(), and Ceylan::Model::notifyAllViews().

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 Ceylan::Locatable::~Locatable().

virtual void Ceylan::Locatable2D::setCenter	(	Ceylan::Maths::Real	newX = `0`,
		Ceylan::Maths::Real	newY = `0`
	)			`[virtual]`

Sets the center of the local referential.

As it is relative to father locatable, it must be defined in father space.

Parameters:

	newX	the new center abscissa, in father space.
	newX	the new center ordinate, in father space.

Exceptions:

LocatableException

if no local referential was available.

void Locatable2D::setCenter ( const Ceylan::Maths::Linear::Bipoint & newCenter ) [virtual]

Sets the center of the local referential.

As it is relative to father locatable, it must be defined in father space.

Parameters:

newCenter

the new center, in father space.

Exceptions:

LocatableException

if no local referential was available.

Definition at line 153 of file CeylanLocatable2D.cc.

References Ceylan::Locatable::_localReferential, getLocalMatrix(), Ceylan::Maths::Linear::Bipoint::getX(), Ceylan::Maths::Linear::Bipoint::getY(), Ceylan::Maths::Linear::Matrix3::setElementAt(), and Ceylan::Locatable::setUpToDateState().

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

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 Ceylan::Locatable::_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, inherited]

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 Ceylan::Locatable::_isUpToDate, and Ceylan::Locatable::changed().

Referenced by Ceylan::Locatable::beNotifiedOf(), Ceylan::Locatable::getGlobalReferential(), and 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(), Ceylan::Locatable::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 Locatable2D::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::Locatable.

Definition at line 200 of file CeylanLocatable2D.cc.

References Ceylan::Locatable::describe(), and Ceylan::Locatable::isAbsolute().

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 Ceylan::Locatable::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().

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

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

Note:: Basically, it consists on applying the father transformation to the local one to have a fully world-to-local precomputed transformation.; This Locatable must already have a local referential.

Implements Ceylan::Locatable.

Definition at line 217 of file CeylanLocatable2D.cc.

References Ceylan::Locatable::_globalReferential, Ceylan::Locatable::_localReferential, Ceylan::emergencyShutdown(), and dataUtils::m.

Member Data Documentation

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

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 Ceylan::Locatable::changed(), and Ceylan::Locatable::~Locatable().

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

This referential's father, if any.