Particle Universe  1.2
ParticleUniverse::CameraDependency Class Reference

#include <ParticleUniverseCameraDependency.h>

Inheritance diagram for ParticleUniverse::CameraDependency:

Public Member Functions

 CameraDependency (void)
 
 CameraDependency (Real threshold, bool inc)
 
virtual ~CameraDependency (void)
 
virtual bool affect (Real &baseValue, Real dependencyValue)
 
const Real getThreshold (void) const
 
void setThreshold (const Real threshold)
 
bool isIncrease (void) const
 
void setIncrease (bool increase)
 
virtual void copyAttributesTo (CameraDependency *cameraDependency)
 
- Public Member Functions inherited from ParticleUniverse::IDependency
 IDependency (void)
 
virtual ~IDependency (void)
 
- Public Member Functions inherited from ParticleUniverse::IElement
 IElement (void)
 
virtual ~IElement (void)
 

Static Public Attributes

static const Real DEFAULT_DISTANCE_THRESHOLD
 
static const bool DEFAULT_INCREASE
 

Protected Attributes

Real mThreshold
 
bool mIncrease
 

Detailed Description

The CameraDependency class is used to define a relation between an attribute (for example the emission rate of a ParticleEmitter) and the camera. The camera distance influences the value of the attribute.

Remarks
In case of the emission rate for example, it can be defined that that number of emitted particles decreases if the camera gets further away.

Constructor & Destructor Documentation

ParticleUniverse::CameraDependency::CameraDependency ( void  )
ParticleUniverse::CameraDependency::CameraDependency ( Real  threshold,
bool  inc 
)
virtual ParticleUniverse::CameraDependency::~CameraDependency ( void  )
inlinevirtual

Member Function Documentation

virtual bool ParticleUniverse::CameraDependency::affect ( Real baseValue,
Real  dependencyValue 
)
virtual

Todo

virtual void ParticleUniverse::CameraDependency::copyAttributesTo ( CameraDependency cameraDependency)
virtual

Copy attributes to another camera dependency.

const Real ParticleUniverse::CameraDependency::getThreshold ( void  ) const
inline

Todo

bool ParticleUniverse::CameraDependency::isIncrease ( void  ) const
inline

Todo

void ParticleUniverse::CameraDependency::setIncrease ( bool  increase)
inline
void ParticleUniverse::CameraDependency::setThreshold ( const Real  threshold)
inline

Member Data Documentation

const Real ParticleUniverse::CameraDependency::DEFAULT_DISTANCE_THRESHOLD
static
const bool ParticleUniverse::CameraDependency::DEFAULT_INCREASE
static
bool ParticleUniverse::CameraDependency::mIncrease
protected
Real ParticleUniverse::CameraDependency::mThreshold
protected

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