orxonox::FadingBillboard Class Reference

#include <src/orxonox/objects/worldentities/FadingBillboard.h>

Inheritance diagram for orxonox::FadingBillboard:

orxonox::Billboard orxonox::Tickable orxonox::StaticEntity orxonox::TeamColourable orxonox::OrxonoxClass orxonox::WorldEntity orxonox::OrxonoxClass orxonox::BaseObject orxonox::Synchronisable orxonox::OrxonoxClass orxonox::OrxonoxClass orxonox::Backlight

List of all members.

Public Member Functions

virtual void changedActivity ()
 This function gets called if the activity of the object changes.
virtual void changedVisibility ()
 This function gets called if the visibility of the object changes.
 FadingBillboard (BaseObject *creator)
const ColourValue & getFadedColour () const
float getTurnOffTime () const
float getTurnOnTime () const
void registerVariables ()
void setTurnOffTime (float turnofftime)
void setTurnOnTime (float turnontime)
virtual void tick (float dt)
 Gets called every frame.
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode)
 XML loading and saving.
virtual ~FadingBillboard ()

Protected Member Functions

virtual void changedColour ()
virtual void poststopturnonoff ()
virtual void startturnonoff ()
virtual void stopturnonoff ()

Protected Attributes

char changedirection_
ColourValue fadedColour_
float postprocessingtime_
float turnofftime_
Timer< FadingBillboardturnonofftimer_
float turnontime_


Constructor & Destructor Documentation

orxonox::FadingBillboard::FadingBillboard ( BaseObject creator  ) 

orxonox::FadingBillboard::~FadingBillboard (  )  [virtual]


Member Function Documentation

void orxonox::FadingBillboard::changedActivity (  )  [virtual]

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

Reimplemented from orxonox::BaseObject.

References startturnonoff(), and SUPER.

void orxonox::FadingBillboard::changedColour (  )  [protected, virtual]

void orxonox::FadingBillboard::changedVisibility (  )  [virtual]

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

Reimplemented from orxonox::Billboard.

Reimplemented in orxonox::Backlight.

References changedirection_, orxonox::Billboard::getBillboardSet(), orxonox::BaseObject::isActive(), orxonox::BaseObject::isVisible(), orxonox::BillboardSet::setVisible(), and SUPER.

const ColourValue& orxonox::FadingBillboard::getFadedColour (  )  const [inline]

float orxonox::FadingBillboard::getTurnOffTime (  )  const [inline]

Referenced by XMLPort().

float orxonox::FadingBillboard::getTurnOnTime (  )  const [inline]

Referenced by XMLPort().

void orxonox::FadingBillboard::poststopturnonoff (  )  [protected, virtual]

void orxonox::FadingBillboard::registerVariables (  ) 

void orxonox::FadingBillboard::setTurnOffTime ( float  turnofftime  )  [inline]

Referenced by XMLPort().

void orxonox::FadingBillboard::setTurnOnTime ( float  turnontime  )  [inline]

Referenced by XMLPort().

void orxonox::FadingBillboard::startturnonoff (  )  [protected, virtual]

void orxonox::FadingBillboard::stopturnonoff (  )  [protected, virtual]

void orxonox::FadingBillboard::tick ( float  dt  )  [virtual]

Gets called every frame.

Parameters:
dt The time since the last frame in seconds

Implements orxonox::Tickable.

Reimplemented in orxonox::Backlight.

References changedirection_, orxonox::MT_Type::ColourValue, fadedColour_, orxonox::Billboard::getBillboardSet(), orxonox::Billboard::getColour(), orxonox::BillboardSet::setColour(), SUPER, turnofftime_, and turnontime_.

void orxonox::FadingBillboard::XMLPort ( Element &  xmlelement,
XMLPort::Mode  mode 
) [virtual]

XML loading and saving.

Parameters:
xmlelement The XML-element
loading Loading (true) or saving (false)
Returns:
The XML-element

Reimplemented from orxonox::Billboard.

Reimplemented in orxonox::Backlight.

References getTurnOffTime(), getTurnOnTime(), setTurnOffTime(), setTurnOnTime(), SUPER, and XMLPortParam.


Member Data Documentation

ColourValue orxonox::FadingBillboard::fadedColour_ [protected]

Referenced by startturnonoff(), and stopturnonoff().


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

Generated on Tue Jul 28 16:22:30 2009 for Orxonox by  doxygen 1.5.6