Base class to display content directly onto the screen. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/overlays/OrxonoxOverlay.h>

Inheritance diagram for orxonox::OrxonoxOverlay:

Public Types
enum	RotationState { RotationState::Horizontal, RotationState::Vertical, RotationState::Inbetween }
	Describes the rotational state of a an overlay. More...

Public Member Functions
	OrxonoxOverlay (Context *context)

virtual	~OrxonoxOverlay ()
	Make sure everything gets removed/destroyed. More...

virtual void	changedName () override
	This function gets called if the name of the object changes. More...

virtual void	changedOverlayGroup ()

virtual void	changedOwner ()

virtual void	changedVisibility () override
	Called by BaseObject when visibility has changed. More...

Vector2	getActualSize () const
	Gets the actual size of the overlay on the screen (corrected) More...

bool	getAspectCorrection () const
	Returns whether the window aspect is corrected. More...

const std::string &	getBackgroundMaterial () const
	Returns the the material name of the background. More...

const std::string &	getBackgroundTexture () const
	Returns the the texture name of the background. More...

OverlayGroup *	getOverlayGroup () const

BaseObject *	getOwner () const

const Vector2 &	getPickPoint () const
	Gets the pick point of this overlay. More...

const Vector2 &	getPosition () const
	Returns the current position on the screen. More...

const Degree &	getRotation () const
	Gets the rotation angle applied to this overlay in degrees. More...

const Vector2 &	getSize () const
	Gets the current size that was set (uncorrected) More...

const Vector2 &	getSizeCorrection () const
	Gets the current size correction (default: 1.0, 1.0) More...

void	hide ()
	Hides the overlay with an detour to BaseObject::visibility_. More...

void	rotate (const Degree &angle)
	Rotates the overlay by angle degrees. More...

void	scale (const Vector2 &scale)
	Scales the overlay by scale. More...

void	scroll (const Vector2 &offset)
	Scrolls the overlay. More...

void	setAspectCorrection (bool val)
	Sets whether the aspect of the overlay is corrected. More...

void	setBackgroundAlpha (float alpha)

void	setBackgroundColour (ColourValue colour)

void	setBackgroundMaterial (const std::string &material)
	Only sets the background material name if not "". More...

void	setBackgroundTexture (const std::string &texture)
	Sets the background texture name and creates a new material if necessary. More...

void	setOverlayGroup (OverlayGroup *group)

void	setOwner (BaseObject *owner)

void	setPickPoint (const Vector2 &position)
	Sets the point in the overlay where to pick it when translating. More...

void	setPosition (Vector2 pos)
	Sets the position of this overlay on the screen. More...

void	setRotation (const Degree &angle)
	Sets the rotation angle applied to this overlay in degrees. More...

void	setSize (const Vector2 &size)
	Sets the size of this overlay. More...

void	setZOrder (unsigned short order)

void	show ()
	Shows the overlay with an detour to BaseObject::visibility_. More...

virtual void	XMLPort (Element &xmlelement, XMLPort::Mode mode) override
	Loads the OrxonoxOverlay. 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...

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

BaseObject *	getCreator () const

BaseObject *	getEventListener (unsigned int index) const
	Returns an event listener with a given index. More...

BaseObject *	getEventSource (unsigned int index, const std::string &state) const
	Returns an eventsource with a given index. More...

const XMLFile *	getFile () 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...

Gametype *	getGametype () const

Level *	getLevel () 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...

Namespace *	getNamespace () const

const std::string &	getOldName () const
	Returns the old name of the object. More...

Scene *	getScene () const

virtual uint32_t	getSceneID () const

const std::set< Template * > &	getTemplates () const
	Returns the set of all aplied templates. More...

const mbool &	isActive () const
	Returns the state of the objects activity. More...

bool	isInitialized () const
	Returns if the object was initialized (passed the object registration). More...

const mbool &	isVisible () 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 ()

OrxonoxClass &	operator= (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...

Context *	getContext () 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 void *	getDerivedPointer (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...

Identifier *	getIdentifier () 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...

Static Public Member Functions
static void	rotateOverlay (const std::string &name, const Degree &angle)
	ConsoleCommand: Accesses the overlay by its name and rotates it. More...

static void	scaleOverlay (const std::string &name, float scale)
	ConsoleCommand: Accesses the overlay by its name and scales it. More...

static void	scrollOverlay (const std::string &name, const Vector2 &scroll)
	ConsoleCommand: Accesses the overlay by its name and scrolls it. More...

static void	showOverlay (const std::string &name)
	Shows Overlay by it's name. More...

static void	toggleVisibility (const std::string &name)
	Toggles the visibility of an Overlay by it's 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...

Protected Member Functions
virtual void	angleChanged ()
	Called whenever the rotation angle has changed. More...

virtual void	positionChanged ()
	Determines the position of the overlay. More...

virtual void	sizeChanged ()
	Sets the overlay size using the actual corrected size. More...

virtual void	sizeCorrectionChanged ()
	Called whenever the aspect ratio or the angle has changed. 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...

EventState *	getEventState (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::WindowEventListener
	WindowEventListener ()

virtual	~WindowEventListener ()=default

unsigned int	getWindowHeight () const
	Returns the current render window height. More...

unsigned int	getWindowWidth () const
	Returns the current render window width. More...

Protected Attributes
Degree	angle_
	Rotation angle of the overlay. More...

Ogre::PanelOverlayElement *	background_
	Background image (blank per default). More...

bool	bCorrectAspect_
	Whether or not to correct the size. More...

Ogre::Overlay *	overlay_
	The overlay the entire class is about. More...

Vector2	pickPoint_
	Point on the overlay to pick when translating. More...

Vector2	position_
	Position of the pickPoint on the screen. More...

RotationState	rotState_
	horizontal, vertical or inbetween More...

Vector2	size_
	Internal size of the overlay. More...

Vector2	sizeCorrection_
	Value to correct the size because of the window aspect. More...

float	windowAspectRatio_
	Screen.width / screen.height. More...

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

Private Member Functions
virtual void	windowResized (unsigned int newWidth, unsigned int newHeight) override
	Called by the GraphicsManager whenever the window size changes. More...

Private Attributes
Ogre::Pass *	backgroundAlphaPass_

OverlayGroup *	group_

BaseObject *	owner_

Static Private Attributes
static unsigned int	hudOverlayCounter_s = 0
	Static counter for hud elements. More...

static std::map< std::string, OrxonoxOverlay * >	overlays_s
	Contains all the overlays in a map for quick access via console commands. More...

Detailed Description

Base class to display content directly onto the screen.

This is merely a wrapper of the Ogre::Overlay to implement more features and integrate it in our class hierarchy for xml loading and config values. The mentioned features are:

Automatic positioning depending on the scale and the rotation angle. You can specify a "pick point" relative to the overlay itself. This point will always be exactly at the position (position_) of the overlay. That allows for margin/corner aligment. It even works when a rotation angle is applied.
Virtual methods for changedVisibilty() (BaseObject), angleChanged(), sizeCorrectionChanged(), sizeChanged() and positionChanged(), that can be overridden by any derivative. This enables for custom configurability of the size, position and rotation attributes. For intance, the HUDNavigation should behave differently to sizeChanged() than a standard overlay.
Console commands for scale, rotate and scroll (accessed by name)
Standard Ogre::PanelOverlayElement for a background image (class doesn't have to be derived only for displaying a picture).
Reacts to changes of the window aspect
Last but not least: On demand you can tell the overlay to automatically rescale to correct for aspect distortion. E.g. if you play 1024x768 you wouldn't want a round object to be oval. Remark: This can (due to the Ogre::Overlay transformation order) only work for angle that are multiples of 90 degrees. But it's only a small drawback.

Member Enumeration Documentation

enum orxonox::OrxonoxOverlay::RotationState

strong

Describes the rotational state of a an overlay.

Horizontal means 0/180 degrees, Vertical is 90/270 degrees and in between is everything else.

Enumerator
Horizontal
Vertical
Inbetween

Constructor & Destructor Documentation

orxonox::OrxonoxOverlay::OrxonoxOverlay ( Context * context )

orxonox::OrxonoxOverlay::~OrxonoxOverlay ( )

virtual

Make sure everything gets removed/destroyed.

Remarks: We assume that the Ogre::OverlayManager exists (there is an assert in Ogre for that!)

Member Function Documentation

void orxonox::OrxonoxOverlay::angleChanged ( )

protectedvirtual

Called whenever the rotation angle has changed.

Reimplemented in orxonox::HUDNavigation, and orxonox::WagnisHUD.

void orxonox::OrxonoxOverlay::changedName ( void )

overridevirtual

This function gets called if the name of the object changes.

Reimplemented from orxonox::BaseObject.

Reimplemented in orxonox::HUDWeaponMode, orxonox::HUDWeapon, orxonox::HUDWeaponSystem, and orxonox::HUDHealthBar.

virtual void orxonox::OrxonoxOverlay::changedOverlayGroup ( )

inlinevirtual

Reimplemented in orxonox::HUDWeaponMode, orxonox::HUDWeapon, orxonox::HUDWeaponSystem, and orxonox::HUDHealthBar.

virtual void orxonox::OrxonoxOverlay::changedOwner ( )

inlinevirtual

Reimplemented in orxonox::PongScore, orxonox::TetrisScore, orxonox::HUDNavigation, orxonox::WagnisHUD, orxonox::HUDWeaponMode, orxonox::HUDWeapon, orxonox::TowerDefenseHUDController, orxonox::HUDRadar, orxonox::ShroomHUD, orxonox::GUIOverlay, orxonox::HUDPickupSystem, orxonox::HUDRocketFuelBar, orxonox::HUDShieldBar, orxonox::HUDWeaponSystem, orxonox::FlagHUD, orxonox::TimeHUD, orxonox::OrxyRoadHUDinfo, orxonox::HUDEnemyShieldBar, orxonox::HUDHealthBar, orxonox::DodgeRaceHUDinfo, orxonox::TimeHUD, orxonox::JumpScore, orxonox::GametypeStaticMessage, orxonox::Asteroids2DHUDinfo, orxonox::CountDown, orxonox::HUDSpeedBar, orxonox::HUDTimer, orxonox::LastManStandingInfos, orxonox::LastTeamStandingInfos, orxonox::TeamBaseMatchScore, orxonox::HUDBoostBar, orxonox::PacmanHUDinfo, orxonox::FlappyOrxHUDinfo, orxonox::AnnounceMessage, orxonox::DeathMessage, orxonox::GametypeFadingMessage, orxonox::HUDEnemyHealthBar, orxonox::KillMessage, orxonox::InvaderHUDinfo, orxonox::PauseNotice, and orxonox::SOBHUDInfo.

void orxonox::OrxonoxOverlay::changedVisibility ( void )

overridevirtual

Called by BaseObject when visibility has changed.

Reimplemented from orxonox::BaseObject.

Reimplemented in orxonox::HUDWeaponMode, orxonox::HUDWeapon, orxonox::HUDWeaponSystem, orxonox::Scoreboard, orxonox::GUIOverlay, and orxonox::HUDHealthBar.

Vector2 orxonox::OrxonoxOverlay::getActualSize ( ) const

inline

Gets the actual size of the overlay on the screen (corrected)

bool orxonox::OrxonoxOverlay::getAspectCorrection ( ) const

inline

Returns whether the window aspect is corrected.

const std::string & orxonox::OrxonoxOverlay::getBackgroundMaterial ( ) const

Returns the the material name of the background.

const std::string & orxonox::OrxonoxOverlay::getBackgroundTexture ( ) const

Returns the the texture name of the background.

OverlayGroup* orxonox::OrxonoxOverlay::getOverlayGroup ( ) const

inline

BaseObject* orxonox::OrxonoxOverlay::getOwner ( ) const

inline

const Vector2& orxonox::OrxonoxOverlay::getPickPoint ( ) const

inline

Gets the pick point of this overlay.

See also: setPickPoint()

const Vector2& orxonox::OrxonoxOverlay::getPosition ( void ) const

inline

Returns the current position on the screen.

const Degree& orxonox::OrxonoxOverlay::getRotation ( ) const

inline

Gets the rotation angle applied to this overlay in degrees.

const Vector2& orxonox::OrxonoxOverlay::getSize ( void ) const

inline

Gets the current size that was set (uncorrected)

const Vector2& orxonox::OrxonoxOverlay::getSizeCorrection ( ) const

inline

Gets the current size correction (default: 1.0, 1.0)

void orxonox::OrxonoxOverlay::hide ( )

inline

Hides the overlay with an detour to BaseObject::visibility_.

void orxonox::OrxonoxOverlay::positionChanged ( void )

protectedvirtual

Determines the position of the overlay.

This works also well when a rotation angle is applied. The overlay always gets aligned correctly as well as possible.

Reimplemented in orxonox::HUDHealthBar, orxonox::HUDNavigation, orxonox::WagnisHUD, orxonox::HUDWeaponMode, orxonox::HUDWeapon, and orxonox::HUDWeaponSystem.

void orxonox::OrxonoxOverlay::rotate ( const Degree & angle )

inline

Rotates the overlay by angle degrees.

void orxonox::OrxonoxOverlay::rotateOverlay	(	const std::string &	name,
		const Degree &	angle
	)

static

ConsoleCommand: Accesses the overlay by its name and rotates it.

Rotates an overlay by its name.

Parameters

name	The name of the overlay defined BaseObject::setName() (usually done with the "name" attribute in the xml file).
angle	The rotation angle in degree

void orxonox::OrxonoxOverlay::scale ( const Vector2 & scale )

inline

Scales the overlay by scale.

void orxonox::OrxonoxOverlay::scaleOverlay	(	const std::string &	name,
		float	scale
	)

static

ConsoleCommand: Accesses the overlay by its name and scales it.

Scales an overlay by its name.

Parameters

name	The name of the overlay defined BaseObject::setName() (usually done with the "name" attribute in the xml file).
scale	The scaling factor

void orxonox::OrxonoxOverlay::scroll ( const Vector2 & offset )

inline

Scrolls the overlay.

Parameters

offset The offset given.

void orxonox::OrxonoxOverlay::scrollOverlay	(	const std::string &	name,
		const Vector2 &	scroll
	)

static

ConsoleCommand: Accesses the overlay by its name and scrolls it.

Scrolls an overlay by its name.

Parameters

name	The name of the overlay defined BaseObject::setName() (usually done with the "name" attribute in the xml file).
scroll	The relative translation of the overlay

void orxonox::OrxonoxOverlay::setAspectCorrection ( bool val )

inline

Sets whether the aspect of the overlay is corrected.

This is for instance useful for round objects that should stay round no matter what the screen resolution is.

void orxonox::OrxonoxOverlay::setBackgroundAlpha ( float alpha )

void orxonox::OrxonoxOverlay::setBackgroundColour ( ColourValue colour )

void orxonox::OrxonoxOverlay::setBackgroundMaterial ( const std::string & material )

Only sets the background material name if not "".

void orxonox::OrxonoxOverlay::setBackgroundTexture ( const std::string & texture )

Sets the background texture name and creates a new material if necessary.

void orxonox::OrxonoxOverlay::setOverlayGroup ( OverlayGroup * group )

void orxonox::OrxonoxOverlay::setOwner ( BaseObject * owner )

inline

void orxonox::OrxonoxOverlay::setPickPoint ( const Vector2 & position )

inline

Sets the point in the overlay where to pick it when translating.

For instance setting it to (1.0,1.0) means that the lower right corner of the overlay will be put at position_. This primarily helps aligning an overlay to any corner/margin on the screen.

void orxonox::OrxonoxOverlay::setPosition ( Vector2 pos )

inline

Sets the position of this overlay on the screen.

void orxonox::OrxonoxOverlay::setRotation ( const Degree & angle )

inline

Sets the rotation angle applied to this overlay in degrees.

void orxonox::OrxonoxOverlay::setSize ( const Vector2 & size )

inline

Sets the size of this overlay.

void orxonox::OrxonoxOverlay::setZOrder ( unsigned short order )

void orxonox::OrxonoxOverlay::show ( )

inline

Shows the overlay with an detour to BaseObject::visibility_.

void orxonox::OrxonoxOverlay::showOverlay ( const std::string & name )

static

Shows Overlay by it's name.

Parameters

name	The name of the overlay defined BaseObject::setName() (usually done with the "name" attribute in the xml file).

void orxonox::OrxonoxOverlay::sizeChanged ( )

protectedvirtual

Sets the overlay size using the actual corrected size.

Reimplemented in orxonox::HUDHealthBar, orxonox::OverlayText, orxonox::HUDNavigation, orxonox::HUDWeaponMode, orxonox::HUDWeapon, orxonox::WagnisHUD, and orxonox::HUDWeaponSystem.

void orxonox::OrxonoxOverlay::sizeCorrectionChanged ( )

protectedvirtual

Called whenever the aspect ratio or the angle has changed.

The method calculates a correction factor for the size to compensate for aspect distortion if desired.

Remarks: This only works when the angle is about 0 or 90 degrees.

void orxonox::OrxonoxOverlay::toggleVisibility ( const std::string & name )

static

Toggles the visibility of an Overlay by it's name.

Parameters

name	The name of the overlay defined BaseObject::setName() (usually done with the "name" attribute in the xml file).

void orxonox::OrxonoxOverlay::windowResized	(	unsigned int	newWidth,
		unsigned int	newHeight
	)

overrideprivatevirtual

Called by the GraphicsManager whenever the window size changes.

Calculates the aspect ratio only.

Reimplemented from orxonox::WindowEventListener.

void orxonox::OrxonoxOverlay::XMLPort	(	Element &	xmlelement,
		XMLPort::Mode	mode
	)

overridevirtual

Loads the OrxonoxOverlay.

This has to be called before usage, otherwise strange behaviour is guaranteed! (there should be no segfaults however). XML loading and saving.

Parameters

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

Reimplemented from orxonox::BaseObject.

Reimplemented in orxonox::HUDBar, orxonox::PongScore, orxonox::TowerDefenseHUDController, orxonox::HUDWeapon, orxonox::OverlayText, orxonox::HUDNavigation, orxonox::HUDRadar, orxonox::HUDWeaponSystem, orxonox::WagnisHUD, orxonox::OrxyRoadHUDinfo, orxonox::StoryModeHUD, orxonox::DodgeRaceHUDinfo, orxonox::JumpScore, orxonox::HUDHealthBar, orxonox::Asteroids2DHUDinfo, orxonox::FadeoutText, orxonox::GUIOverlay, orxonox::CountDown, orxonox::LastManStandingInfos, orxonox::LastTeamStandingInfos, orxonox::TeamBaseMatchScore, orxonox::PacmanHUDinfo, orxonox::FlappyOrxHUDinfo, orxonox::InvaderHUDinfo, and orxonox::SOBHUDInfo.

Member Data Documentation

Degree orxonox::OrxonoxOverlay::angle_

protected

Rotation angle of the overlay.

Ogre::PanelOverlayElement* orxonox::OrxonoxOverlay::background_

protected

Background image (blank per default).

Ogre::Pass* orxonox::OrxonoxOverlay::backgroundAlphaPass_

private

bool orxonox::OrxonoxOverlay::bCorrectAspect_

protected

Whether or not to correct the size.

See also: setAspectCorrection()

OverlayGroup* orxonox::OrxonoxOverlay::group_

private

unsigned int orxonox::OrxonoxOverlay::hudOverlayCounter_s = 0

staticprivate

Static counter for hud elements.

Ogre::Overlay* orxonox::OrxonoxOverlay::overlay_

protected

The overlay the entire class is about.

std::map< std::string, OrxonoxOverlay * > orxonox::OrxonoxOverlay::overlays_s

staticprivate

Contains all the overlays in a map for quick access via console commands.

We could also use the ObjectList, but that doesn't guarantee XMLPort(.) was called and is slower.

BaseObject* orxonox::OrxonoxOverlay::owner_

private

Vector2 orxonox::OrxonoxOverlay::pickPoint_

protected

Point on the overlay to pick when translating.

Vector2 orxonox::OrxonoxOverlay::position_

protected

Position of the pickPoint on the screen.

RotationState orxonox::OrxonoxOverlay::rotState_

protected

horizontal, vertical or inbetween

Vector2 orxonox::OrxonoxOverlay::size_

protected

Internal size of the overlay.

Vector2 orxonox::OrxonoxOverlay::sizeCorrection_

protected

Value to correct the size because of the window aspect.

float orxonox::OrxonoxOverlay::windowAspectRatio_

protected

Screen.width / screen.height.

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

orxonox/overlays/OrxonoxOverlay.h
orxonox/overlays/OrxonoxOverlay.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation