Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | Private Member Functions | Private Attributes | List of all members
orxonox::NotificationQueueCEGUI Class Reference

Displays Notifications using CEGUI. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/notifications/NotificationQueueCEGUI.h>

Inheritance diagram for orxonox::NotificationQueueCEGUI:
orxonox::NotificationQueue orxonox::BaseObject orxonox::Tickable orxonox::Synchronisable orxonox::OrxonoxClass orxonox::OrxonoxInterface orxonox::OrxonoxInterface orxonox::Configurable orxonox::Destroyable orxonox::Configurable orxonox::Destroyable orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Listable orxonox::Listable orxonox::Identifiable orxonox::Identifiable orxonox::Identifiable

Public Member Functions

 NotificationQueueCEGUI (Context *context)
 
virtual ~NotificationQueueCEGUI ()
 
void alignmentChanged (void)
 Is called when the horizontal alignment of the Notifications text has changed. More...
 
virtual void changedName (void) override
 Is called when the name of the NotificationQueue has changed. More...
 
void destroy (bool noGraphics=false)
 Destroys the NotificationQueueCEGUI. More...
 
void displaySizeChanged (void)
 Is called when the display size has changed. More...
 
void fontColorChanged (void)
 Is called when the font color if the text displayed by this NotificationQueue. More...
 
void fontSizeChanged (void)
 Is called when the font size of the text displayed by this NotificationQueue has changed. More...
 
const std::string & getAlignment (void)
 Get the horizontal alignment of the Notifications text. More...
 
const Vector4 & getDisplaySize (void) const
 Get the size of the window that displays the NotificationQueue. More...
 
const Vector4 & getFontColor (void) const
 Get the font color of the text displayed by this NotificationQueue. More...
 
const std::string & getFontColorStr (void) const
 Get the font color of the text displayed by this NotificationQueue. More...
 
unsigned int getFontSize (void)
 Get the font size of the text displayed by this NotificationQueue. More...
 
const Vector4 & getPosition (void) const
 Get the position of the window that displays the NotificationQueue. More...
 
void positionChanged (void)
 Is called when the NotificationQueue's position has changed. More...
 
void setAlignment (const std::string &alignment)
 Set the horizontal alignment of the Notifications text. More...
 
void setDisplaySize (const Vector4 &size)
 Set the size of the window that displays the NotificationQueue. More...
 
void setFontColor (const Vector4 &color)
 Set the font color if the text displayed by this NotificationQueue. More...
 
void setFontSize (unsigned int size)
 Set the font size of the text displayed by this NotificationQueue. More...
 
void setPosition (const Vector4 &position)
 Set the position of the window that displays the NotificationQueue. More...
 
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode) override
 XML loading and saving. More...
 
- Public Member Functions inherited from orxonox::NotificationQueue
 NotificationQueue (Context *context)
 Default constructor. More...
 
virtual ~NotificationQueue ()
 Destructor. More...
 
void displayTimeChanged (void)
 Is called when the maximum number of seconds a Notification is displayed has changed. More...
 
int getDisplayTime (void) const
 Returns the time interval the Notification is displayed. More...
 
unsigned int getMaxSize (void) const
 Returns the maximum number of Notifications displayed. More...
 
const std::string & getName (void) const
 Get the name of the NotificationQueue. More...
 
unsigned int getSize (void) const
 Returns the current number of Notifications displayed. More...
 
const std::string & getTargets (void) const
 Produces all targets of the NotificationQueue concatenated as string, with commas (',') as separators. More...
 
const std::set< std::string > & getTargetsSet (void)
 Returns the targets of this NotificationQueue, reps. More...
 
bool isRegistered (void)
 Check whether the NotificationQueue is registered with the NotificationManager. More...
 
void maxSizeChanged (void)
 Is called when the maximum number of displayed Notifications has changed. More...
 
void setDisplayTime (int time)
 Sets the maximum number of seconds a Notification is displayed. More...
 
void setMaxSize (unsigned int size)
 Sets the maximum number of displayed Notifications. More...
 
void setTargets (const std::string &targets)
 Sets the targets of the NotificationQueue. More...
 
void targetsChanged (void)
 Is called when the NotificationQueue's targets have changed. More...
 
virtual void tick (float dt) override
 Updates the queue from time to time. More...
 
bool tidy (void)
 Pops all Notifications from the NotificationQueue. More...
 
void update (void)
 Updates the NotificationQueue. More...
 
void update (Notification *notification, const std::time_t &time)
 Updates the NotificationQueue by adding an new Notification. More...
 
- Public Member Functions inherited from orxonox::BaseObject
 BaseObject (Context *context)
 Constructor: Registers the object in the BaseObject-list. More...
 
virtual ~BaseObject ()
 Destructor. More...
 
void addEventListener (BaseObject *listener)
 Adds an object which listens to the events of this object. More...
 
void addEventSource (BaseObject *source, const std::string &state)
 Adds a new event source for a specific state. More...
 
void addTemplate (const std::string &name)
 Adds a Template to the object. More...
 
void addTemplate (Template *temp)
 Adds a Template to the object. More...
 
virtual void changedActivity ()
 This function gets called if the activity of the object changes. More...
 
virtual void changedMainStateName ()
 This function gets called if the main state name of the object changes. More...
 
virtual void changedVisibility ()
 This function gets called if the visibility of the object changes. More...
 
void fireEvent (const std::string &name="")
 Fires an event (without a state). More...
 
void fireEvent (bool activate, const std::string &name="")
 Fires an event which activates or deactivates a state. More...
 
void fireEvent (bool activate, BaseObject *originator, const std::string &name="")
 Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event). More...
 
void fireEvent (Event &event)
 Fires an event, using the Event struct. More...
 
BaseObjectgetCreator () const
 
BaseObjectgetEventListener (unsigned int index) const
 Returns an event listener with a given index. More...
 
BaseObjectgetEventSource (unsigned int index, const std::string &state) const
 Returns an eventsource with a given index. More...
 
const XMLFilegetFile () const
 Returns a pointer to the XMLFile that loaded this object. More...
 
const std::string & getFilename () const
 Returns the levelfile that loaded this object. More...
 
GametypegetGametype () const
 
LevelgetLevel () const
 
const std::string & getLoaderIndentation () const
 Returns the indentation of the debug output in the Loader. More...
 
const std::string & getMainStateName () const
 Returns the name of the main state. More...
 
const std::string & getName () const
 Returns the name of the object. More...
 
NamespacegetNamespace () const
 
const std::string & getOldName () const
 Returns the old name of the object. More...
 
ScenegetScene () const
 
virtual uint32_t getSceneID () const
 
const std::set< Template * > & getTemplates () const
 Returns the set of all aplied templates. More...
 
const mboolisActive () const
 Returns the state of the objects activity. More...
 
bool isInitialized () const
 Returns if the object was initialized (passed the object registration). More...
 
const mboolisVisible () const
 Returns the state of the objects visibility. More...
 
virtual void processEvent (Event &event)
 Processing an event by calling the right main state. More...
 
void removeEventSource (BaseObject *source)
 Removes an eventsource (but doesn't unregister itself at the source). More...
 
void setActive (bool bActive)
 Sets the state of the objects activity. More...
 
void setCreator (BaseObject *creator)
 
void setFile (const XMLFile *file)
 Sets a pointer to the xml file that loaded this object. More...
 
void setGametype (const StrongOrWeakPtr< Gametype > &gametype)
 
void setLevel (const StrongOrWeakPtr< Level > &level)
 
void setLoaderIndentation (const std::string &indentation)
 Sets the indentation of the debug output in the Loader. More...
 
void setMainState (bool state)
 Sets the main state of the object to a given boolean value. More...
 
void setMainStateName (const std::string &name)
 Sets the name of the main state (used for event reactions). More...
 
void setName (const std::string &name)
 Sets the name of the object. More...
 
void setNamespace (const StrongOrWeakPtr< Namespace > &ns)
 
void setScene (const StrongOrWeakPtr< Scene > &scene, uint32_t sceneID)
 
void setVisible (bool bVisible)
 Sets the state of the objects visibility. More...
 
virtual void XMLEventPort (Element &xmlelement, XMLPort::Mode mode)
 Defines the possible event states of this object and parses eventsources from an XML file. More...
 
- Public Member Functions inherited from orxonox::OrxonoxClass
 OrxonoxClass ()
 
OrxonoxClassoperator= (const OrxonoxClass &)=default
 
- Public Member Functions inherited from orxonox::Configurable
 Configurable ()
 
void setConfigValues ()
 Function to collect the SetConfigValue-macro calls. More...
 
- Public Member Functions inherited from orxonox::Listable
 Listable ()
 Constructor: Allocates space in the element list. More...
 
 Listable (Context *context)
 Constructor: Allocates space in the element list and assigns the context. More...
 
virtual ~Listable ()
 Destructor: Removes the object from the object-lists. More...
 
ContextgetContext () const
 
void setContext (Context *context)
 Changes the context. More...
 
void unregisterObject ()
 Removes this object from the object-lists. More...
 
- Public Member Functions inherited from orxonox::Identifiable
 Identifiable ()
 Constructor: Sets the default values. More...
 
virtual ~Identifiable ()
 
ORX_FORCEINLINE voidgetDerivedPointer (unsigned int classID)
 Returns a valid pointer of any derived type that is registered in the class hierarchy. More...
 
template<class T >
ORX_FORCEINLINE T * getDerivedPointer (unsigned int classID)
 Version of getDerivedPointer with template. More...
 
template<class T >
ORX_FORCEINLINE const T * getDerivedPointer (unsigned int classID) const
 Const version of getDerivedPointer with template. More...
 
IdentifiergetIdentifier () const
 Returns the Identifier of the object. More...
 
bool isA (const Identifier *identifier)
 Returns true if the object's class is of the given type or a derivative. More...
 
template<class B >
bool isA (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is of the given type or a derivative. More...
 
bool isA (const Identifiable *object)
 Returns true if the object's class is of the given type or a derivative. More...
 
bool isChildOf (const Identifier *identifier)
 Returns true if the object's class is a child of the given type. More...
 
template<class B >
bool isChildOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a child of the given type. More...
 
bool isChildOf (const Identifiable *object)
 Returns true if the object's class is a child of the given type. More...
 
bool isDirectChildOf (const Identifier *identifier)
 Returns true if the object's class is a direct child of the given type. More...
 
template<class B >
bool isDirectChildOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isDirectChildOf (const Identifiable *object)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isDirectParentOf (const Identifier *identifier)
 Returns true if the object's class is a direct parent of the given type. More...
 
template<class B >
bool isDirectParentOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a direct parent of the given type. More...
 
bool isDirectParentOf (const Identifiable *object)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isExactlyA (const Identifier *identifier)
 Returns true if the object's class is exactly of the given type. More...
 
template<class B >
bool isExactlyA (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is exactly of the given type. More...
 
bool isExactlyA (const Identifiable *object)
 Returns true if the object's class is exactly of the given type. More...
 
bool isParentOf (const Identifier *identifier)
 Returns true if the object's class is a parent of the given type. More...
 
template<class B >
bool isParentOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a parent of the given type. More...
 
bool isParentOf (const Identifiable *object)
 Returns true if the object's class is a parent of the given type. More...
 
- Public Member Functions inherited from orxonox::Destroyable
 Destroyable ()
 Constructor: Sets the default values. More...
 
virtual ~Destroyable ()
 Destructor: Notifies all DestructionListener (for example weak pointers) that this object is being deleted. More...
 
void destroy ()
 Deletes the object if no strong pointers point to this object. More...
 
void destroyLater ()
 Works like destroy() but doesn't destroy the object until the current tick has ended. More...
 
unsigned int getReferenceCount () const
 Returns the number of strong pointers that point to this object. More...
 
- Public Member Functions inherited from orxonox::OrxonoxInterface
 OrxonoxInterface ()
 
- Public Member Functions inherited from orxonox::Synchronisable
virtual ~Synchronisable ()
 Destructor: Delete all callback objects and remove objectID_ from the objectMap_. More...
 
uint32_t getClassID () const
 
unsigned int getContextID () const
 
uint32_t getNrOfVariables ()
 
uint32_t getObjectID () const
 
unsigned int getPriority () const
 
uint8_t getSyncMode () const
 
uint32_t getVarSize (VariableID ID)
 
template<>
_NetworkExport void registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
 
template<>
void registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
 
void setSyncMode (uint8_t mode)
 This function sets the synchronisation mode of the object If set to 0x0 variables will not be synchronised at all If set to 0x1 variables will only be synchronised to the client If set to 0x2 variables will only be synchronised to the server If set to 0x3 variables will be synchronised bidirectionally (only if set so in registerVar) More...
 
template<>
_NetworkExport void unregisterVariable (std::string &variable)
 
template<>
void unregisterVariable (std::string &variable)
 

Static Public Member Functions

static NotificationQueueCEGUIgetQueue (const std::string &name)
 Get the NotificationQueueCEGUI with the input name. More...
 
- Static Public Member Functions inherited from orxonox::BaseObject
static void loadAllEventStates (Element &xmlelement, XMLPort::Mode mode, BaseObject *object, Identifier *identifier)
 Manually loads all event states, even if the class doesn't officially support them. More...
 
- Static Public Member Functions inherited from orxonox::Synchronisable
static bool deleteObject (uint32_t objectID_)
 Finds and deletes the Synchronisable with the appropriate objectID_. More...
 
static Synchronisablefabricate (uint8_t *&mem, uint8_t mode=0x0)
 This function fabricated a new synchrnisable (and children of it), sets calls updateData and create After calling this function the mem pointer will be increased by the size of the needed data. More...
 
static unsigned int getNumberOfDeletedObject ()
 
static SynchronisablegetSynchronisable (uint32_t objectID_)
 This function looks up the objectID_ in the objectMap_ and returns a pointer to the right Synchronisable. More...
 
static uint32_t popDeletedObject ()
 
static void setClient (bool b)
 This function sets the internal mode for synchronisation. More...
 

Protected Member Functions

virtual void clear (bool noGraphics=false) override
 Clears the NotificationQueue by removing all NotificationContainers. More...
 
virtual void create (void) override
 Creates the NotificationQueue in lua. More...
 
virtual void notificationPopped (void) override
 Is called by the NotificationQueue when a Notification was popped. More...
 
virtual void notificationPushed (Notification *notification) override
 Is called by the NotificationQueue when a Notification was pushed. More...
 
virtual void notificationRemoved (unsigned int index) override
 Is called when a notification was removed. More...
 
void registerVariables ()
 
- Protected Member Functions inherited from orxonox::NotificationQueue
void registerVariables ()
 Registers Variables to be Synchronised. More...
 
- Protected Member Functions inherited from orxonox::BaseObject
void addEventState (const std::string &name, EventState *container)
 Adds a new event-state to the object. More...
 
EventStategetEventState (const std::string &name) const
 Returns the event-state with the given name. More...
 
- Protected Member Functions inherited from orxonox::Destroyable
virtual void preDestroy ()
 This virtual function is called if destroy() is called and no StrongPtr points to this object. More...
 
- Protected Member Functions inherited from orxonox::Tickable
 Tickable ()
 Constructor: Registers the object in the Tickable-list. More...
 
- Protected Member Functions inherited from orxonox::Synchronisable
 Synchronisable (Context *context)
 Constructor: Initializes all Variables and sets the right objectID_. More...
 
uint32_t findContextID (Context *context)
 Returns the id of the context. More...
 
template<class T >
void registerVariable (T &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)
 
template<class T >
void registerVariable (std::set< T > &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)
 
void setPriority (unsigned int freq)
 
template<class T >
void unregisterVariable (T &var)
 

Static Protected Attributes

static const std::string NOTIFICATION_LAYER
 The name of the NotificationLayer menu sheet. More...
 
- Static Protected Attributes inherited from orxonox::NotificationQueue
static const unsigned int DEFAULT_DISPLAY_TIME = 30
 The default display time. More...
 
static const unsigned int DEFAULT_SIZE = 5
 The default maximum number of Notifications displayed. More...
 
static const int INF = -1
 Constant denoting infinity. More...
 

Private Member Functions

void initialize (void)
 Initializes The NotificationQueueCEGUI. More...
 

Private Attributes

std::string alignment_
 The horizontal alignment of the Notifications text. More...
 
Vector4 displaySize_
 The size of the window that displays the NotificationQueue. More...
 
Vector4 fontColor_
 The font color of the Notifications text as a vector, in RGBA form, with values from 0 to 1. More...
 
std::string fontColorStr_
 The font color of the Notifications text as a string with the ARGB hexadecimal values. More...
 
unsigned int fontSize_
 The font size of the Notifications text. More...
 
Vector4 position_
 The position of the window that displays the NotificationQueue. More...
 

Additional Inherited Members

- Protected Attributes inherited from orxonox::BaseObject
mbool bActive_
 True = the object is active. More...
 
mbool bVisible_
 True = the object is visible. More...
 
FunctorPtr mainStateFunctor_
 
std::string mainStateName_
 
std::string name_
 The name of the object. More...
 
std::set< std::string > networkTemplateNames_
 
std::string oldName_
 The old name of the object. More...
 

Detailed Description

Displays Notifications using CEGUI.

Apart form the parameters inherited by the NotificationQueue, there are some more parameters that influence the behavior of the NotificationQueueCEGUI:

Author
Damian 'Mozork' Frick
See also
NotificationQueue

Constructor & Destructor Documentation

orxonox::NotificationQueueCEGUI::NotificationQueueCEGUI ( Context context)
orxonox::NotificationQueueCEGUI::~NotificationQueueCEGUI ( )
virtual

Member Function Documentation

void orxonox::NotificationQueueCEGUI::alignmentChanged ( void  )

Is called when the horizontal alignment of the Notifications text has changed.

void orxonox::NotificationQueueCEGUI::changedName ( void  )
overridevirtual

Is called when the name of the NotificationQueue has changed.

Clears and re-creates the NotificationQueue.

Reimplemented from orxonox::NotificationQueue.

void orxonox::NotificationQueueCEGUI::clear ( bool  noGraphics = false)
overrideprotectedvirtual

Clears the NotificationQueue by removing all NotificationContainers.

Parameters
noGraphicsIf this is set to true the GUI is not informed of the clearing of the NotificationQueue. This is needed only internally.

Reimplemented from orxonox::NotificationQueue.

void orxonox::NotificationQueueCEGUI::create ( void  )
overrideprotectedvirtual

Creates the NotificationQueue in lua.

Reimplemented from orxonox::NotificationQueue.

void orxonox::NotificationQueueCEGUI::destroy ( bool  noGraphics = false)

Destroys the NotificationQueueCEGUI.

Used in lua and NotificationManager.

Parameters
noGraphicsIf this is set to true (false is default), then the queue is not removed in lua. This is used to destroy the queue, after the GUIManager has been destroyed.
void orxonox::NotificationQueueCEGUI::displaySizeChanged ( void  )

Is called when the display size has changed.

void orxonox::NotificationQueueCEGUI::fontColorChanged ( void  )

Is called when the font color if the text displayed by this NotificationQueue.

void orxonox::NotificationQueueCEGUI::fontSizeChanged ( void  )

Is called when the font size of the text displayed by this NotificationQueue has changed.

const std::string& orxonox::NotificationQueueCEGUI::getAlignment ( void  )
inline

Get the horizontal alignment of the Notifications text.

Returns
Returns a string with the horizontal alignment property.
const Vector4& orxonox::NotificationQueueCEGUI::getDisplaySize ( void  ) const
inline

Get the size of the window that displays the NotificationQueue.

Returns
Returns a vector with the display size.
const Vector4& orxonox::NotificationQueueCEGUI::getFontColor ( void  ) const
inline

Get the font color of the text displayed by this NotificationQueue.

Returns
Returns a vector with the components being RGBA, with values from 0 to 1.
const std::string& orxonox::NotificationQueueCEGUI::getFontColorStr ( void  ) const
inline

Get the font color of the text displayed by this NotificationQueue.

Returns
Returns a string with the ARGB values in hexadecimal format.
unsigned int orxonox::NotificationQueueCEGUI::getFontSize ( void  )
inline

Get the font size of the text displayed by this NotificationQueue.

Returns
Returns the font size.
const Vector4& orxonox::NotificationQueueCEGUI::getPosition ( void  ) const
inline

Get the position of the window that displays the NotificationQueue.

Returns
Returns a vector with the position.
NotificationQueueCEGUI * orxonox::NotificationQueueCEGUI::getQueue ( const std::string &  name)
static

Get the NotificationQueueCEGUI with the input name.

Parameters
nameThe name of the NotificationQueueCEGUI to be got.
Returns
Returns a pointer to the NotificationQueueCEGUI, or nullptr if it doesn't exist.
void orxonox::NotificationQueueCEGUI::initialize ( void  )
private

Initializes The NotificationQueueCEGUI.

void orxonox::NotificationQueueCEGUI::notificationPopped ( void  )
overrideprotectedvirtual

Is called by the NotificationQueue when a Notification was popped.

Reimplemented from orxonox::NotificationQueue.

void orxonox::NotificationQueueCEGUI::notificationPushed ( Notification notification)
overrideprotectedvirtual

Is called by the NotificationQueue when a Notification was pushed.

Parameters
notificationThe Notification that was pushed.

Reimplemented from orxonox::NotificationQueue.

void orxonox::NotificationQueueCEGUI::notificationRemoved ( unsigned int  index)
overrideprotectedvirtual

Is called when a notification was removed.

Parameters
indexThe index the removed Notification was at.

Reimplemented from orxonox::NotificationQueue.

void orxonox::NotificationQueueCEGUI::positionChanged ( void  )

Is called when the NotificationQueue's position has changed.

void orxonox::NotificationQueueCEGUI::registerVariables ( void  )
protected
void orxonox::NotificationQueueCEGUI::setAlignment ( const std::string &  alignment)

Set the horizontal alignment of the Notifications text.

Parameters
alignmentThe alignment of the Notifications, they are the possible string that the CEGUI Falagard StaticText HorzFormatting property can take.
See also
http://cegui.org.uk/api_reference/classCEGUI_1_1FalagardStaticTextProperties_1_1HorzFormatting.html
void orxonox::NotificationQueueCEGUI::setDisplaySize ( const Vector4 &  size)

Set the size of the window that displays the NotificationQueue.

Parameters
sizeThe size is a vector with components:
  • The relative width of the window. (A value between 0 and 1)
  • The absolute width in pixels. (Additional to the relative width, can be negative)
  • The relative height of the window. (A value between 0 and 1)
  • The absolute height in pixels. (Additional to the relative width, can be negative.) If both the 3rd and 4th component of size are set to 0 the height is set such that exactly as many Notifications fit as is the maximum size of the NotificationQueue (in terms of the number of Notifications).
void orxonox::NotificationQueueCEGUI::setFontColor ( const Vector4 &  color)

Set the font color if the text displayed by this NotificationQueue.

Parameters
colorThe color is a vector with the components being RGBA and taking values from 0 to 1.
void orxonox::NotificationQueueCEGUI::setFontSize ( unsigned int  size)

Set the font size of the text displayed by this NotificationQueue.

Parameters
sizeThe font size.
void orxonox::NotificationQueueCEGUI::setPosition ( const Vector4 &  position)

Set the position of the window that displays the NotificationQueue.

Parameters
positionThe position is a vector with components:
  • The relative x-position of the window. (A value between 0 and 1)
  • The absolute x-position in pixels. (Additional to the relative x-position, can be negative)
  • The relative y-position of the window. (A value between 0 and 1)
  • The absolute y-position in pixels. (Additional to the relative y-position, can be negative.)
void orxonox::NotificationQueueCEGUI::XMLPort ( Element &  xmlelement,
XMLPort::Mode  mode 
)
overridevirtual

XML loading and saving.

Parameters
xmlelementThe XML-element
modeThe mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)

Reimplemented from orxonox::NotificationQueue.

Member Data Documentation

std::string orxonox::NotificationQueueCEGUI::alignment_
private

The horizontal alignment of the Notifications text.

Vector4 orxonox::NotificationQueueCEGUI::displaySize_
private

The size of the window that displays the NotificationQueue.

Vector4 orxonox::NotificationQueueCEGUI::fontColor_
private

The font color of the Notifications text as a vector, in RGBA form, with values from 0 to 1.

std::string orxonox::NotificationQueueCEGUI::fontColorStr_
private

The font color of the Notifications text as a string with the ARGB hexadecimal values.

unsigned int orxonox::NotificationQueueCEGUI::fontSize_
private

The font size of the Notifications text.

const std::string orxonox::NotificationQueueCEGUI::NOTIFICATION_LAYER
staticprotected

The name of the NotificationLayer menu sheet.

Vector4 orxonox::NotificationQueueCEGUI::position_
private

The position of the window that displays the NotificationQueue.


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