orxonox::Backlight Class Reference

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

Inheritance diagram for orxonox::Backlight:

orxonox::FadingBillboard orxonox::TimeFactorListener orxonox::Billboard orxonox::Tickable orxonox::OrxonoxClass orxonox::StaticEntity orxonox::TeamColourable orxonox::OrxonoxClass orxonox::WorldEntity orxonox::OrxonoxClass orxonox::BaseObject orxonox::Synchronisable orxonox::OrxonoxClass orxonox::OrxonoxClass

List of all members.

Public Member Functions

 Backlight (BaseObject *creator)
virtual void changedScale ()
virtual void changedVisibility ()
 This function gets called if the visibility of the object changes.
float getLength () const
float getLifetime () const
size_t getMaxElements () const
const std::stringgetTrailMaterial () const
float getWidth () const
void registerVariables ()
void setLength (float length)
void setLifetime (float lifetime)
void setMaxElements (size_t maxelements)
void setTrailMaterial (const std::string &material)
void setWidth (float width)
virtual void tick (float dt)
 Gets called every frame.
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode)
 XML loading and saving.
virtual ~Backlight ()

Protected Member Functions

virtual void changedTimeFactor (float factor_new, float factor_old)

Private Member Functions

virtual void changedColour ()
virtual void poststopturnonoff ()
virtual void startturnonoff ()
virtual void stopturnonoff ()
void update_length ()
void update_lifetime ()
void update_maxelements ()
void update_trailmaterial ()
void update_width ()

Private Attributes

float length_
float lifetime_
size_t maxelements_
Ogre::RibbonTrail * ribbonTrail_
Ogre::SceneNode * ribbonTrailNode_
char tickcount_
std::string trailmaterial_
float width_


Constructor & Destructor Documentation

orxonox::Backlight::Backlight ( BaseObject creator  ) 

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


Member Function Documentation

void orxonox::Backlight::changedColour (  )  [private, virtual]

void orxonox::Backlight::changedScale (  )  [virtual]

Reimplemented from orxonox::WorldEntity.

References SUPER, update_length(), and update_width().

void orxonox::Backlight::changedTimeFactor ( float  factor_new,
float  factor_old 
) [protected, virtual]

Reimplemented from orxonox::TimeFactorListener.

References update_lifetime().

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

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

Reimplemented from orxonox::FadingBillboard.

References orxonox::BaseObject::isVisible(), ribbonTrail_, and SUPER.

float orxonox::Backlight::getLength (  )  const [inline]

Referenced by XMLPort().

float orxonox::Backlight::getLifetime (  )  const [inline]

Referenced by XMLPort().

size_t orxonox::Backlight::getMaxElements (  )  const [inline]

Referenced by XMLPort().

const std::string& orxonox::Backlight::getTrailMaterial (  )  const [inline]

Referenced by XMLPort().

float orxonox::Backlight::getWidth ( void   )  const [inline]

Referenced by XMLPort().

void orxonox::Backlight::poststopturnonoff (  )  [private, virtual]

void orxonox::Backlight::registerVariables (  ) 

void orxonox::Backlight::setLength ( float  length  )  [inline]

Referenced by XMLPort().

void orxonox::Backlight::setLifetime ( float  lifetime  )  [inline]

Referenced by XMLPort().

void orxonox::Backlight::setMaxElements ( size_t  maxelements  )  [inline]

Referenced by XMLPort().

void orxonox::Backlight::setTrailMaterial ( const std::string material  )  [inline]

Referenced by XMLPort().

void orxonox::Backlight::setWidth ( float  width  )  [inline]

Referenced by XMLPort().

void orxonox::Backlight::startturnonoff (  )  [private, virtual]

void orxonox::Backlight::stopturnonoff (  )  [private, virtual]

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

void orxonox::Backlight::update_length (  )  [private]

void orxonox::Backlight::update_lifetime (  )  [private]

void orxonox::Backlight::update_maxelements (  )  [private]

References maxelements_, ribbonTrail_, and tickcount_.

Referenced by registerVariables(), and tick().

void orxonox::Backlight::update_trailmaterial (  )  [private]

References ribbonTrail_, tickcount_, and trailmaterial_.

Referenced by registerVariables(), and tick().

void orxonox::Backlight::update_width (  )  [private]

void orxonox::Backlight::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::FadingBillboard.

References getLength(), getLifetime(), getMaxElements(), getTrailMaterial(), getWidth(), setLength(), setLifetime(), setMaxElements(), setTrailMaterial(), setWidth(), SUPER, and XMLPortParam.


Member Data Documentation

float orxonox::Backlight::length_ [private]

Ogre::RibbonTrail* orxonox::Backlight::ribbonTrail_ [private]

Ogre::SceneNode* orxonox::Backlight::ribbonTrailNode_ [private]

Referenced by Backlight(), and ~Backlight().

float orxonox::Backlight::width_ [private]


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

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