Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Public Attributes | List of all members
OIS::Envelope Class Reference

An optional envelope to be applied to the start/end of an effect. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/external/ois/OISEffect.h>

Inheritance diagram for OIS::Envelope:
OIS::ForceEffect

Public Member Functions

 Envelope ()
 
bool isUsed () const
 
- Public Member Functions inherited from OIS::ForceEffect
virtual ~ForceEffect ()
 

Public Attributes

unsigned int attackLength
 
unsigned short attackLevel
 
unsigned int fadeLength
 
unsigned short fadeLevel
 

Detailed Description

An optional envelope to be applied to the start/end of an effect.

If any of these values are nonzero, then the envelope will be used in setting up the effect.

Constructor & Destructor Documentation

OIS::Envelope::Envelope ( )
inline

Member Function Documentation

bool OIS::Envelope::isUsed ( ) const
inline

Member Data Documentation

unsigned int OIS::Envelope::attackLength
unsigned short OIS::Envelope::attackLevel
unsigned int OIS::Envelope::fadeLength
unsigned short OIS::Envelope::fadeLevel

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