ParticleUniverse::IAlias Class Reference

#include <ParticleUniverseIAlias.h>

Inheritance diagram for ParticleUniverse::IAlias:

Public Types
enum	AliasType {   AT_UNDEFINED, AT_TECHNIQUE, AT_RENDERER, AT_EMITTER,   AT_AFFECTOR, AT_OBSERVER, AT_EXTERN, AT_HANDLER,   AT_BEHAVIOUR }

Public Member Functions
	IAlias (void)
virtual	~IAlias (void)
const String &	getAliasName (void) const
void	setAliasName (String aliasName)
const AliasType	getAliasType (void) const
void	setAliasType (AliasType aliasType)

Protected Attributes
String	mAliasName
AliasType	mAliasType

Detailed Description

Abstract (pure virtual) alias class

Remarks

The IAlias class acts as an interface and is used to represent all other classes that are a child of the IAlias class. This typically concerns entities that are used in the Particle Universe scripts and for which it is possible to define an alias (i.e. ParticleTechnique, ParticleEmitter and ParticleAffector).

Member Enumeration Documentation

enum ParticleUniverse::IAlias::AliasType

Enumerator
AT_UNDEFINED
AT_TECHNIQUE
AT_RENDERER
AT_EMITTER
AT_AFFECTOR
AT_OBSERVER
AT_EXTERN
AT_HANDLER
AT_BEHAVIOUR

Constructor & Destructor Documentation

ParticleUniverse::IAlias::IAlias ( void  )

inline

virtual ParticleUniverse::IAlias::~IAlias ( void  )

inlinevirtual

Member Function Documentation

const String& ParticleUniverse::IAlias::getAliasName ( void  ) const

inline

const AliasType ParticleUniverse::IAlias::getAliasType ( void  ) const

inline

void ParticleUniverse::IAlias::setAliasName ( String  aliasName )

inline

void ParticleUniverse::IAlias::setAliasType ( AliasType  aliasType )

inline

Member Data Documentation

String ParticleUniverse::IAlias::mAliasName

protected

AliasType ParticleUniverse::IAlias::mAliasType

protected

---

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

• ParticleUniverseIAlias.h