ParticleUniverse::CircleEmitter Class Reference

#include <ParticleUniverseCircleEmitter.h>

Inheritance diagram for ParticleUniverse::CircleEmitter:

Public Member Functions
	CircleEmitter (void)
virtual	~CircleEmitter (void)
const Real	getRadius (void) const
void	setRadius (const Real radius)
const Real	getCircleAngle (void) const
void	setCircleAngle (const Real circleAngle)
const Real	getStep (void) const
void	setStep (const Real step)
const bool	isRandom (void) const
void	setRandom (const bool random)
const Quaternion &	getOrientation (void) const
const Vector3 &	getNormal (void) const
void	setNormal (const Vector3 &normal)
void	_notifyStart (void)
virtual void	_initParticlePosition (Particle *particle)
virtual void	_initParticleDirection (Particle *particle)
virtual void	copyAttributesTo (ParticleEmitter *emitter)
Public Member Functions inherited from ParticleUniverse::ParticleEmitter
	ParticleEmitter (void)
virtual	~ParticleEmitter (void)
ParticleTechnique *	getParentTechnique (void) const
void	setParentTechnique (ParticleTechnique *parentTechnique)
const String &	getEmitterType (void) const
void	setEmitterType (const String &emitterType)
const String &	getName (void) const
void	setName (const String &name)
DynamicAttribute *	getDynAngle (void) const
void	setDynAngle (DynamicAttribute *dynAngle)
DynamicAttribute *	getDynEmissionRate (void) const
void	setDynEmissionRate (DynamicAttribute *dynEmissionRate)
DynamicAttribute *	getDynTotalTimeToLive (void) const
void	setDynTotalTimeToLive (DynamicAttribute *dynTotalTimeToLive)
DynamicAttribute *	getDynParticleMass (void) const
void	setDynParticleMass (DynamicAttribute *dynParticleMass)
DynamicAttribute *	getDynVelocity (void) const
void	setDynVelocity (DynamicAttribute *dynVelocity)
DynamicAttribute *	getDynDuration (void) const
void	setDynDuration (DynamicAttribute *dynDuration)
void	setDynDurationSet (bool durationSet)
DynamicAttribute *	getDynRepeatDelay (void) const
void	setDynRepeatDelay (DynamicAttribute *dynRepeatDelay)
void	setDynRepeatDelaySet (bool repeatDelaySet)
DynamicAttribute *	getDynParticleAllDimensions (void) const
void	setDynParticleAllDimensions (DynamicAttribute *dynParticleAllDimensions)
void	setDynParticleAllDimensionsSet (bool particleAllDimensionsSet)
DynamicAttribute *	getDynParticleWidth (void) const
void	setDynParticleWidth (DynamicAttribute *dynParticleWidth)
void	setDynParticleWidthSet (bool particleWidthSet)
DynamicAttribute *	getDynParticleHeight (void) const
void	setDynParticleHeight (DynamicAttribute *dynParticleHeight)
void	setDynParticleHeightSet (bool particleHeightSet)
DynamicAttribute *	getDynParticleDepth (void) const
void	setDynParticleDepth (DynamicAttribute *dynParticleDepth)
void	setDynParticleDepthSet (bool particleDepthSet)
ParticleType	getEmitsType (void) const
void	setEmitsType (ParticleType emitsType)
const String &	getEmitsName (void) const
void	setEmitsName (const String &emitsName)
void	setEmissionRateCameraDependency (CameraDependency *cameraDependency)
void	setEmissionRateCameraDependency (Real squareDistance, bool inc=false)
CameraDependency *	getEmissionRateCameraDependency (void) const
virtual const Vector3 &	getParticleDirection (void)
const Vector3 &	getOriginalParticleDirection (void) const
const Quaternion &	getParticleOrientation (void) const
void	setParticleOrientation (const Quaternion &orientation)
const Quaternion &	getParticleOrientationRangeStart (void) const
void	setParticleOrientationRangeStart (const Quaternion &orientationRangeStart)
const Quaternion &	getParticleOrientationRangeEnd (void) const
void	setParticleOrientationRangeEnd (const Quaternion &orientationRangeEnd)
virtual void	setEnabled (bool enabled)
virtual void	setParticleDirection (const Vector3 &direction)
bool	isAutoDirection (void) const
void	setAutoDirection (bool autoDirection)
bool	isForceEmission (void) const
void	setForceEmission (bool forceEmission)
virtual void	_prepare (ParticleTechnique *particleTechnique)
virtual void	_unprepare (ParticleTechnique *particleTechnique)
virtual void	_preProcessParticles (ParticleTechnique *technique, Real timeElapsed)
virtual void	_postProcessParticles (ParticleTechnique *technique, Real timeElapsed)
virtual void	_initForEmission (void)
virtual void	_initForExpiration (ParticleTechnique *technique, Real timeElapsed)
virtual void	_initParticleForEmission (Particle *particle)
virtual void	_initParticleOrientation (Particle *particle)
void	_generateAngle (Radian &angle)
virtual void	_initParticleVelocity (Particle *particle)
virtual void	_initParticleMass (Particle *particle)
virtual void	_initParticleColour (Particle *particle)
virtual void	_initParticleTextureCoords (Particle *particle)
Real	_initParticleTimeToLive (void)
virtual unsigned short	_calculateRequestedParticles (Real timeElapsed)
void	_initParticleDimensions (Particle *particle)
void	_initTimeBased (void)
const Vector3 &	getDerivedPosition (void)
virtual void	_notifyStop (void)
virtual void	_notifyPause (void)
virtual void	_notifyResume (void)
virtual void	_notifyRescaled (const Vector3 &scale)
virtual void	copyParentAttributesTo (ParticleEmitter *emitter)
const ColourValue &	getParticleColour (void) const
void	setParticleColour (const ColourValue &particleColour)
const ColourValue &	getParticleColourRangeStart (void) const
void	setParticleColourRangeStart (const ColourValue &particleColourRangeStart)
const ColourValue &	getParticleColourRangeEnd (void) const
void	setParticleColourRangeEnd (const ColourValue &particleColourRangeEnd)
const uint16 &	getParticleTextureCoords (void) const
void	setParticleTextureCoords (const uint16 &particleTextureCoords)
const uint16 &	getParticleTextureCoordsRangeStart (void) const
void	setParticleTextureCoordsRangeStart (const uint16 &particleTextureCoordsRangeStart)
const uint16 &	getParticleTextureCoordsRangeEnd (void) const
void	setParticleTextureCoordsRangeEnd (const uint16 &particleTextureCoordsRangeEnd)
bool	isKeepLocal (void) const
void	setKeepLocal (bool keepLocal)
bool	makeParticleLocal (Particle *particle)
void	pushEvent (ParticleUniverseEvent &particleUniverseEvent)
Public Member Functions inherited from ParticleUniverse::Particle
	Particle (void)
virtual	~Particle (void)
bool	_isMarkedForEmission (void) const
void	_setMarkedForEmission (bool markedForEmission)
virtual bool	isEnabled (void) const
void	_setOriginalEnabled (bool originalEnabled)
bool	_getOriginalEnabled (void) const
bool	isFreezed (void) const
void	setFreezed (bool freezed)
void	setEventFlags (uint32 flags)
void	addEventFlags (uint32 flags)
void	removeEventFlags (uint32 flags)
uint32	getEventFlags (void) const
bool	hasEventFlags (uint32 flags) const
void	copyBehaviours (ParticleBehaviourList &behaviours)
virtual void	_process (ParticleTechnique *technique, Real timeElapsed)
ParticleBehaviour *	getBehaviour (const String &behaviourType)
Real	calculateVelocity (void) const
virtual void	copyAttributesTo (Particle *particle)
Public Member Functions inherited from ParticleUniverse::IAlias
	IAlias (void)
virtual	~IAlias (void)
const String &	getAliasName (void) const
void	setAliasName (String aliasName)
const AliasType	getAliasType (void) const
void	setAliasType (AliasType aliasType)
Public Member Functions inherited from ParticleUniverse::IElement
	IElement (void)
virtual	~IElement (void)

Static Public Attributes
static const Real	DEFAULT_RADIUS
static const Real	DEFAULT_STEP
static const Real	DEFAULT_ANGLE
static const bool	DEFAULT_RANDOM
static const Vector3	DEFAULT_NORMAL
Static Public Attributes inherited from ParticleUniverse::ParticleEmitter
static const bool	DEFAULT_ENABLED
static const Vector3	DEFAULT_POSITION
static const bool	DEFAULT_KEEP_LOCAL
static const Vector3	DEFAULT_DIRECTION
static const Quaternion	DEFAULT_ORIENTATION
static const Quaternion	DEFAULT_ORIENTATION_RANGE_START
static const Quaternion	DEFAULT_ORIENTATION_RANGE_END
static const Particle::ParticleType	DEFAULT_EMITS
static const uint16	DEFAULT_START_TEXTURE_COORDS
static const uint16	DEFAULT_END_TEXTURE_COORDS
static const uint16	DEFAULT_TEXTURE_COORDS
static const ColourValue	DEFAULT_START_COLOUR_RANGE
static const ColourValue	DEFAULT_END_COLOUR_RANGE
static const ColourValue	DEFAULT_COLOUR
static const bool	DEFAULT_AUTO_DIRECTION
static const bool	DEFAULT_FORCE_EMISSION
static const Real	DEFAULT_EMISSION_RATE
static const Real	DEFAULT_TIME_TO_LIVE
static const Real	DEFAULT_MASS
static const Real	DEFAULT_VELOCITY
static const Real	DEFAULT_DURATION
static const Real	DEFAULT_REPEAT_DELAY
static const Real	DEFAULT_ANGLE
static const Real	DEFAULT_DIMENSIONS
static const Real	DEFAULT_WIDTH
static const Real	DEFAULT_HEIGHT
static const Real	DEFAULT_DEPTH
Static Public Attributes inherited from ParticleUniverse::Particle
static Real	DEFAULT_TTL
static Real	DEFAULT_MASS

Protected Attributes
Real	mRadius
Real	mCircleAngle
Real	mOriginalCircleAngle
Real	mStep
Real	mX
Real	mZ
bool	mRandom
Quaternion	mOrientation
Vector3	mNormal
Protected Attributes inherited from ParticleUniverse::ParticleEmitter
ParticleTechnique *	mParentTechnique
Vector3	_mEmitterScale
String	mEmitterType
String	mName
Vector3	mParticleDirection
Vector3	mOriginalParticleDirection
Quaternion	mParticleOrientation
Quaternion	mParticleOrientationRangeStart
Quaternion	mParticleOrientationRangeEnd
bool	mParticleOrientationRangeSet
DynamicAttribute *	mDynAngle
DynamicAttribute *	mDynEmissionRate
ParticleType	mEmitsType
String	mEmitsName
DynamicAttribute *	mDynTotalTimeToLive
DynamicAttribute *	mDynParticleMass
DynamicAttribute *	mDynVelocity
DynamicAttribute *	mDynDuration
DynamicAttribute *	mDynRepeatDelay
DynamicAttribute *	mDynParticleAllDimensions
bool	mDynParticleAllDimensionsSet
DynamicAttribute *	mDynParticleWidth
bool	mDynParticleWidthSet
DynamicAttribute *	mDynParticleHeight
bool	mDynParticleHeightSet
DynamicAttribute *	mDynParticleDepth
bool	mDynParticleDepthSet
Vector3	mUpVector
Real	mRemainder
DynamicAttributeFactory	mDynamicAttributeFactory
DynamicAttributeHelper	mDynamicAttributeHelper
Real	mDurationRemain
bool	mDynDurationSet
Real	mRepeatDelayRemain
bool	mDynRepeatDelaySet
CameraDependency *	mEmissionRateCameraDependency
CameraDependencyFactory	mCameraDependencyFactory
bool	mAutoDirection
bool	mForceEmission
bool	mOriginalForceEmission
bool	mForceEmissionExecuted
bool	mOriginalForceEmissionExecuted
ColourValue	mParticleColour
ColourValue	mParticleColourRangeStart
ColourValue	mParticleColourRangeEnd
bool	mParticleColourRangeSet
bool	mKeepLocal
uint16	mParticleTextureCoords
uint16	mParticleTextureCoordsRangeStart
uint16	mParticleTextureCoordsRangeEnd
bool	mParticleTextureCoordsRangeSet
Protected Attributes inherited from ParticleUniverse::Particle
uint32	mEventFlags
bool	mMarkedForEmission
bool	mEnabled
bool	mFreezed
bool	mOriginalEnabled
bool	mOriginalEnabledSet
Vector3	mDerivedPosition
ParticleBehaviourList	mBehaviours
Protected Attributes inherited from ParticleUniverse::IAlias
String	mAliasName
AliasType	mAliasType

Additional Inherited Members
Public Types inherited from ParticleUniverse::Particle
enum	ParticleType {   PT_VISUAL, PT_TECHNIQUE, PT_EMITTER, PT_AFFECTOR,   PT_SYSTEM }
enum	ReservedParticleEventFlags { PEF_EXPIRED = 1<<0, PEF_EMITTED = 1<<1, PEF_COLLIDED = 1<<2 }
typedef vector< ParticleBehaviour * >	ParticleBehaviourList
typedef ParticleBehaviourList::const_iterator	ParticleBehaviourIterator
Public Types inherited from ParticleUniverse::IAlias
enum	AliasType {   AT_UNDEFINED, AT_TECHNIQUE, AT_RENDERER, AT_EMITTER,   AT_AFFECTOR, AT_OBSERVER, AT_EXTERN, AT_HANDLER,   AT_BEHAVIOUR }
Public Attributes inherited from ParticleUniverse::Particle
ParticleEmitter *	parentEmitter
Vector3	position
Vector3	direction
Real	mass
Real	timeToLive
Real	totalTimeToLive
Real	timeFraction
ParticleType	particleType
Any	mUserDefinedObject
PhysicsActor *	physicsActor
IVisualData *	visualData
Vector3	originalPosition
Vector3	originalDirection
Real	originalVelocity
Real	originalDirectionLength
Real	originalScaledDirectionLength
Vector3	latestPosition
Protected Member Functions inherited from ParticleUniverse::ParticleEmitter
void	_pushEmitterEvent (EventType eventType)

Detailed Description

The CircleEmitter is a ParticleEmitter that emits particles on a circle shape. Particle can be emitted random on the circle, but it can also follow the circles' contours.

Constructor & Destructor Documentation

ParticleUniverse::CircleEmitter::CircleEmitter

(

void

)

virtual ParticleUniverse::CircleEmitter::~CircleEmitter ( void  )

inlinevirtual

Member Function Documentation

virtual void ParticleUniverse::CircleEmitter::_initParticleDirection ( Particle *  particle )

virtual

Determine the particle direction.

Reimplemented from ParticleUniverse::ParticleEmitter.

virtual void ParticleUniverse::CircleEmitter::_initParticlePosition ( Particle *  particle )

virtual

Determine a particle position on the circle.

Reimplemented from ParticleUniverse::ParticleEmitter.

void ParticleUniverse::CircleEmitter::_notifyStart ( void  )

virtual

See ParticleEmiter

Reimplemented from ParticleUniverse::ParticleEmitter.

virtual void ParticleUniverse::CircleEmitter::copyAttributesTo ( ParticleEmitter *  emitter )

virtual

Copy attributes to another emitter.

Reimplemented from ParticleUniverse::ParticleEmitter.

const Real ParticleUniverse::CircleEmitter::getCircleAngle

(

void

)

const

const Vector3& ParticleUniverse::CircleEmitter::getNormal

(

void

)

const

const Quaternion& ParticleUniverse::CircleEmitter::getOrientation

(

void

)

const

const Real ParticleUniverse::CircleEmitter::getRadius

(

void

)

const

const Real ParticleUniverse::CircleEmitter::getStep

(

void

)

const

const bool ParticleUniverse::CircleEmitter::isRandom

(

void

)

const

void ParticleUniverse::CircleEmitter::setCircleAngle

(

const Real

circleAngle

)

void ParticleUniverse::CircleEmitter::setNormal

(

const Vector3 &

normal

)

void ParticleUniverse::CircleEmitter::setRadius

(

const Real

radius

)

void ParticleUniverse::CircleEmitter::setRandom

(

const bool

random

)

void ParticleUniverse::CircleEmitter::setStep

(

const Real

step

)

Member Data Documentation

const Real ParticleUniverse::CircleEmitter::DEFAULT_ANGLE

static

const Vector3 ParticleUniverse::CircleEmitter::DEFAULT_NORMAL

static

const Real ParticleUniverse::CircleEmitter::DEFAULT_RADIUS

static

const bool ParticleUniverse::CircleEmitter::DEFAULT_RANDOM

static

const Real ParticleUniverse::CircleEmitter::DEFAULT_STEP

static

Real ParticleUniverse::CircleEmitter::mCircleAngle

protected

Vector3 ParticleUniverse::CircleEmitter::mNormal

protected

Quaternion ParticleUniverse::CircleEmitter::mOrientation

protected

Real ParticleUniverse::CircleEmitter::mOriginalCircleAngle

protected

Real ParticleUniverse::CircleEmitter::mRadius

protected

bool ParticleUniverse::CircleEmitter::mRandom

protected

Real ParticleUniverse::CircleEmitter::mStep

protected

Real ParticleUniverse::CircleEmitter::mX

protected

Real ParticleUniverse::CircleEmitter::mZ

protected

---

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

• ParticleEmitters/ParticleUniverseCircleEmitter.h