DigitalSpaces::DIOGREParticleEmitter Struct Reference
[Ogre]

#include <OGREInterfaces.h>


Public Member Functions
void	SetPosition (in_Vector3f *pos)
	Sets the position of this emitter relative to the particle system center.
void	GetPosition (out_Vector3f *pos)
	Returns the position of this emitter relative to thte center of the particle system.
void	SetDirection (in_Vector3f *direction)
	Sets the direction of the emitter.
void	GetDirection (out_Vector3f *)
	Returns the base direction of the emitter.
void	SetAngleRadian (float angle)
	Sets the maximum angle away from the emitter direction which particle will be emitted.
float	GetAngleRadian (void)
	Returns the maximum angle which the initial particle direction can deviate from the emitters base direction.
void	SetParticleVelocity (float speed)
	Sets the initial velocity of particles emitted.
void	SetParticleVelocity (float min, float max)
	Sets the initial velocity range of particles emitted.
void	SetMinParticleVelocity (float min)
	Returns the minimum particle velocity.
void	SetMaxParticleVelocity (float max)
	Returns the maximum particle velocity.
float	GetParticleVelocity (void)
	Returns the initial velocity of particles emitted.
float	GetMinParticleVelocity (void)
	Returns the minimum particle velocity.
float	GetMaxParticleVelocity (void)
	Returns the maximum particle velocity.
void	SetEmissionRate (float particlesPerSecond)
	Sets the emission rate for this emitter.
float	GetEmissionRate (void)
	Returns the emission rate set for this emitter.
void	SetTimeToLive (float ttl)
	Sets the lifetime of all particles emitted.
void	SetTimeToLive (float minTtl, float maxTtl)
	Sets the range of lifetime for particles emitted.
void	SetMinTimeToLive (float min)
	Sets the minimum time each particle will live for.
void	SetMaxTimeToLive (float max)
	Sets the maximum time each particle will live for.
float	GetTimeToLive (void)
	Gets the time each particle will live for.
float	GetMinTimeToLive (void)
	Gets the minimum time each particle will live for.
float	GetMaxTimeToLive (void)
	Gets the maximum time each particle will live for.
void	SetColour (in_Vector4f *colour)
	Sets the initial colour of particles emitted.
void	SetColour (in_Vector4f colourStart, in_Vector4f colourEnd)
	Sets the range of colours for emitted particles.
void	SetColourRangeStart (in_Vector4f *colour)
	Sets the minimum colour of particles to be emitted.
void	SetColourRangeEnd (in_Vector4f *colour)
	Sets the maximum colour of particles to be emitted.
void	GetColour (out_Vector4f *colour)
	Gets the colour of particles to be emitted.
void	GetColourRangeStart (out_Vector4f *colour)
	Gets the minimum colour of particles to be emitted.
void	GetColourRangeEnd (out_Vector4f *colour)
	Gets the maximum colour of particles to be emitted.
const char *	GetType (void)
	Returns the name of the type of emitter.
void	SetEnabled (bool enabled)
	Sets whether or not the emitter is enabled.
bool	GetEnabled (void)
	Gets the flag indicating if this emitter is enabled or not.
void	SetStartTime (float startTime)
	Sets the 'start time' of this emitter.
float	GetStartTime (void)
	Gets the start time of the emitter.
void	SetDuration (float duration)
	Sets the duration of the emitter.
float	GetDuration (void)
	Gets the duration of the emitter from when it is created or re-enabled.
void	SetDuration (float min, float max)
	Sets the range of random duration for this emitter.
void	SetMinDuration (float min)
	Sets the minimum duration of this emitter in seconds (see setDuration for more details).
void	SetMaxDuration (float max)
	Sets the maximum duration of this emitter in seconds (see setDuration for more details).
float	GetMinDuration (void)
	Gets the minimum duration of this emitter in seconds (see setDuration for more details).
float	GetMaxDuration (void)
	Gets the maximum duration of this emitter in seconds (see setDuration for more details).
void	SetRepeatDelay (float duration)
	Sets the time between repeats of the emitter.
float	GetRepeatDelay (void)
	Gets the duration of the emitter from when it is created or re-enabled.
void	SetRepeatDelay (float min, float max)
	Sets the range of random duration for this emitter.
void	SetMinRepeatDelay (float min)
	Sets the minimum duration of this emitter in seconds (see setRepeatDelay for more details).
void	SetMaxRepeatDelay (float max)
	Sets the maximum duration of this emitter in seconds (see setRepeatDelay for more details).
float	GetMinRepeatDelay (void)
	Gets the minimum duration of this emitter in seconds (see setRepeatDelay for more details).
float	GetMaxRepeatDelay (void)
	Gets the maximum duration of this emitter in seconds (see setRepeatDelay for more details).

Member Function Documentation

void DigitalSpaces::DIOGREParticleEmitter::SetPosition ( in_Vector3f * pos )

Sets the position of this emitter relative to the particle system center.

void DigitalSpaces::DIOGREParticleEmitter::GetPosition ( out_Vector3f * pos )

Returns the position of this emitter relative to thte center of the particle system.

void DigitalSpaces::DIOGREParticleEmitter::SetDirection ( in_Vector3f * direction )

Sets the direction of the emitter.

Remarks:: Most emitters will have a base direction in which they emit particles (those which emit in all directions will ignore this parameter). They may not emit exactly along this vector for every particle, many will introduce a random scatter around this vector using the angle property.

Parameters:

direction

The base direction for particles emitted.

void DigitalSpaces::DIOGREParticleEmitter::GetDirection ( out_Vector3f * )

Returns the base direction of the emitter.

void DigitalSpaces::DIOGREParticleEmitter::SetAngleRadian ( float angle )

Sets the maximum angle away from the emitter direction which particle will be emitted.

Remarks:: Whilst the direction property defines the general direction of emission for particles, this property defines how far the emission angle can deviate away from this base direction. This allows you to create a scatter effect - if set to 0, all particles will be emitted exactly along the emitters direction vector, wheras if you set it to 180 degrees or more, particles will be emitted in a sphere, i.e. in all directions.

Parameters:

degrees

Maximum angle which initial particle direction can deviate from the emitter base direction vector.

float DigitalSpaces::DIOGREParticleEmitter::GetAngleRadian ( void )

Returns the maximum angle which the initial particle direction can deviate from the emitters base direction.

void DigitalSpaces::DIOGREParticleEmitter::SetParticleVelocity ( float speed )

Sets the initial velocity of particles emitted.

Remarks:: This method sets a constant speed for emitted particles. See the alternate version of this method which takes 2 parameters if you want a variable speed.

Parameters:

speed

The initial speed in world units per second which every particle emitted starts with.

void DigitalSpaces::DIOGREParticleEmitter::SetParticleVelocity	(	float	min,
		float	max
	)

Sets the initial velocity range of particles emitted.

Remarks:: This method sets the range of starting speeds for emitted particles. See the alternate version of this method which takes 1 parameter if you want a constant speed. This emitter will randomly choose a speed between the minimum and maximum for each particle.

Parameters:

	max	The maximum speed in world units per second for the initial particle speed on emission.
	min	The minimum speed in world units per second for the initial particle speed on emission.

void DigitalSpaces::DIOGREParticleEmitter::SetMinParticleVelocity ( float min )

Returns the minimum particle velocity.

void DigitalSpaces::DIOGREParticleEmitter::SetMaxParticleVelocity ( float max )

Returns the maximum particle velocity.

float DigitalSpaces::DIOGREParticleEmitter::GetParticleVelocity ( void )

Returns the initial velocity of particles emitted.

float DigitalSpaces::DIOGREParticleEmitter::GetMinParticleVelocity ( void )

Returns the minimum particle velocity.

float DigitalSpaces::DIOGREParticleEmitter::GetMaxParticleVelocity ( void )

Returns the maximum particle velocity.

void DigitalSpaces::DIOGREParticleEmitter::SetEmissionRate ( float particlesPerSecond )

Sets the emission rate for this emitter.

Remarks:: This method tells the emitter how many particles per second should be emitted. The emitter subclass does not have to emit these in a continuous burst - this is a relative parameter and the emitter may choose to emit all of the second's worth of particles every half-second for example. This is controlled by the emitter's getEmissionCount method.

: Also, if the ParticleSystem's particle quota is exceeded, not all the particles requested may be actually emitted.

Parameters:

particlesPerSecond

The number of particles to be emitted every second.

float DigitalSpaces::DIOGREParticleEmitter::GetEmissionRate ( void )

Returns the emission rate set for this emitter.

void DigitalSpaces::DIOGREParticleEmitter::SetTimeToLive ( float ttl )

Sets the lifetime of all particles emitted.

Remarks:: The emitter initialises particles with a time-to-live (TTL), the number of seconds a particle will exist before being destroyed. This method sets a constant TTL for all particles emitted. Note that affectors are able to modify the TTL of particles later.

: Also see the alternate version of this method which takes a min and max TTL in order to have the TTL vary per particle.

Parameters:

ttl

The number of seconds each particle will live for.

void DigitalSpaces::DIOGREParticleEmitter::SetTimeToLive	(	float	minTtl,
		float	maxTtl
	)

Sets the range of lifetime for particles emitted.

Remarks:: The emitter initialises particles with a time-to-live (TTL), the number of seconds a particle will exist before being destroyed. This method sets a range for the TTL for all particles emitted; the ttl may be randomised between these 2 extremes or will vary some other way depending on the emitter. Note that affectors are able to modify the TTL of particles later.

: Also see the alternate version of this method which takes a single TTL in order to set a constant TTL for all particles.

Parameters:

	minTtl	The minimum number of seconds each particle will live for.
	maxTtl	The maximum number of seconds each particle will live for.

void DigitalSpaces::DIOGREParticleEmitter::SetMinTimeToLive ( float min )

Sets the minimum time each particle will live for.

void DigitalSpaces::DIOGREParticleEmitter::SetMaxTimeToLive ( float max )

Sets the maximum time each particle will live for.

float DigitalSpaces::DIOGREParticleEmitter::GetTimeToLive ( void )

Gets the time each particle will live for.

float DigitalSpaces::DIOGREParticleEmitter::GetMinTimeToLive ( void )

Gets the minimum time each particle will live for.

float DigitalSpaces::DIOGREParticleEmitter::GetMaxTimeToLive ( void )

Gets the maximum time each particle will live for.

void DigitalSpaces::DIOGREParticleEmitter::SetColour ( in_Vector4f * colour )

Sets the initial colour of particles emitted.

Remarks:: Particles have an initial colour on emission which the emitter sets. This method sets this colour. See the alternate version of this method which takes 2 colours in order to establish a range of colours to be assigned to particles.

Parameters:

colour

The colour which all particles will be given on emission.

void DigitalSpaces::DIOGREParticleEmitter::SetColour	(	in_Vector4f *	colourStart,
		in_Vector4f *	colourEnd
	)

Sets the range of colours for emitted particles.

Remarks:: Particles have an initial colour on emission which the emitter sets. This method sets the range of this colour. See the alternate version of this method which takes a single colour in order to set a constant colour for all particles. Emitters may choose to randomly assign a colour in this range, or may use some other method to vary the colour.

Parameters:

	colourStart	The start of the colour range
	colourEnd	The end of the colour range

void DigitalSpaces::DIOGREParticleEmitter::SetColourRangeStart ( in_Vector4f * colour )

Sets the minimum colour of particles to be emitted.

void DigitalSpaces::DIOGREParticleEmitter::SetColourRangeEnd ( in_Vector4f * colour )

Sets the maximum colour of particles to be emitted.

void DigitalSpaces::DIOGREParticleEmitter::GetColour ( out_Vector4f * colour )

Gets the colour of particles to be emitted.

void DigitalSpaces::DIOGREParticleEmitter::GetColourRangeStart ( out_Vector4f * colour )

Gets the minimum colour of particles to be emitted.

void DigitalSpaces::DIOGREParticleEmitter::GetColourRangeEnd ( out_Vector4f * colour )

Gets the maximum colour of particles to be emitted.

const char* DigitalSpaces::DIOGREParticleEmitter::GetType ( void )

Returns the name of the type of emitter.

Remarks:: This property is useful for determining the type of emitter procedurally so another can be created.

void DigitalSpaces::DIOGREParticleEmitter::SetEnabled ( bool enabled )

Sets whether or not the emitter is enabled.

Remarks:: You can turn an emitter off completely by setting this parameter to false.

bool DigitalSpaces::DIOGREParticleEmitter::GetEnabled ( void )

Gets the flag indicating if this emitter is enabled or not.

void DigitalSpaces::DIOGREParticleEmitter::SetStartTime ( float startTime )

Sets the 'start time' of this emitter.

Remarks:: By default an emitter starts straight away as soon as a ParticleSystem is first created, or also just after it is re-enabled. This parameter allows you to set a time delay so that the emitter does not 'kick in' until later.

Parameters:

startTime

The time in seconds from the creation or enabling of the emitter.

float DigitalSpaces::DIOGREParticleEmitter::GetStartTime ( void )

Gets the start time of the emitter.

void DigitalSpaces::DIOGREParticleEmitter::SetDuration ( float duration )

Sets the duration of the emitter.

Remarks:: By default emitters run indefinitely (unless you manually disable them). By setting this parameter, you can make an emitter turn off on it's own after a set number of seconds. It will then remain disabled until either setEnabled(true) is called, or if the 'repeatAfter' parameter has been set it will also repeat after a number of seconds.

: Also see the alternative version of this method which allows you to set a min and max duration for a random variable duration.

Parameters:

duration

The duration in seconds.

float DigitalSpaces::DIOGREParticleEmitter::GetDuration ( void )

Gets the duration of the emitter from when it is created or re-enabled.

void DigitalSpaces::DIOGREParticleEmitter::SetDuration	(	float	min,
		float	max
	)

Sets the range of random duration for this emitter.

Remarks:: By default emitters run indefinitely (unless you manually disable them). By setting this parameter, you can make an emitter turn off on it's own after a random number of seconds. It will then remain disabled until either setEnabled(true) is called, or if the 'repeatAfter' parameter has been set it will also repeat after a number of seconds.

: Also see the alternative version of this method which allows you to set a constant duration.

Parameters:

	min	The minimum duration in seconds.
	max	The minimum duration in seconds.

void DigitalSpaces::DIOGREParticleEmitter::SetMinDuration ( float min )

Sets the minimum duration of this emitter in seconds (see setDuration for more details).

void DigitalSpaces::DIOGREParticleEmitter::SetMaxDuration ( float max )

Sets the maximum duration of this emitter in seconds (see setDuration for more details).

float DigitalSpaces::DIOGREParticleEmitter::GetMinDuration ( void )

Gets the minimum duration of this emitter in seconds (see setDuration for more details).

float DigitalSpaces::DIOGREParticleEmitter::GetMaxDuration ( void )

Gets the maximum duration of this emitter in seconds (see setDuration for more details).

void DigitalSpaces::DIOGREParticleEmitter::SetRepeatDelay ( float duration )

Sets the time between repeats of the emitter.

Remarks:: By default emitters run indefinitely (unless you manually disable them). However, if you manually disable the emitter (by calling setEnabled(false), or it's duration runs out, it will cease to emit

: Also see the alternative version of this method which allows you to set a min and max duration for a random variable duration.

Parameters:

duration

The duration in seconds.

float DigitalSpaces::DIOGREParticleEmitter::GetRepeatDelay ( void )

Gets the duration of the emitter from when it is created or re-enabled.

void DigitalSpaces::DIOGREParticleEmitter::SetRepeatDelay	(	float	min,
		float	max
	)

Sets the range of random duration for this emitter.

Remarks:: By default emitters run indefinitely (unless you manually disable them). By setting this parameter, you can make an emitter turn off on it's own after a random number of seconds. It will then remain disabled until either setEnabled(true) is called, or if the 'repeatAfter' parameter has been set it will also repeat after a number of seconds.

: Also see the alternative version of this method which allows you to set a constant duration.

Parameters:

	min	The minimum duration in seconds.
	max	The minimum duration in seconds.

void DigitalSpaces::DIOGREParticleEmitter::SetMinRepeatDelay ( float min )

Sets the minimum duration of this emitter in seconds (see setRepeatDelay for more details).

void DigitalSpaces::DIOGREParticleEmitter::SetMaxRepeatDelay ( float max )

Sets the maximum duration of this emitter in seconds (see setRepeatDelay for more details).

float DigitalSpaces::DIOGREParticleEmitter::GetMinRepeatDelay ( void )

Gets the minimum duration of this emitter in seconds (see setRepeatDelay for more details).

float DigitalSpaces::DIOGREParticleEmitter::GetMaxRepeatDelay ( void )

Gets the maximum duration of this emitter in seconds (see setRepeatDelay for more details).

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

OGREInterfaces/OGREInterfaces.h

DigitalSpaces::DIOGREParticleEmitter Struct Reference [Ogre]

Public Member Functions

Member Function Documentation

DigitalSpaces::DIOGREParticleEmitter Struct Reference
[Ogre]