Ogre::RingEmitter2 Class Reference

Particle emitter which emits particles randomly from points inside a ring (e.g. More...

#include <OgreRingEmitter2.h>

Inheritance diagram for Ogre::RingEmitter2:

Public Member Functions
	RingEmitter2 ()
void	_cloneFrom (const EmitterDefData *original) override
Real	getInnerSizeX () const
	Gets the x component of the area inside the ellipsoid which doesn't emit particles. More...
Real	getInnerSizeY () const
	Gets the y component of the area inside the ellipsoid which doesn't emit particles. More...
const String &	getType () const override
	Returns the name of the type of emitter. More...
void	initEmittedParticles (ParticleCpuData cpuData, const EmittedParticle *newHandles, size_t numParticles) override
	Initializes particles Can be called by multiple threads. More...
void	setInnerSize (Real x, Real y)
	Sets the size of the clear space inside the area from where NO particles are emitted. More...
void	setInnerSizeX (Real x)
	Sets the x component of the area inside the ellipsoid which doesn't emit particles. More...
void	setInnerSizeY (Real y)
	Sets the y component of the area inside the ellipsoid which doesn't emit particles. More...
Public Member Functions inherited from Ogre::AreaEmitter2
Real	getDepth () const
	Gets the depth (local y size) of the emitter. More...
Real	getHeight () const
	Gets the height (local y size) of the emitter. More...
Real	getWidth () const
	Gets the width (local x size) of the emitter. More...
void	setDepth (Real Depth)
	Sets the depth (local y size) of the emitter. More...
void	setDirection (const Vector3 &direction) override
	Overloaded to update the trans. More...
void	setHeight (Real Height)
	Sets the height (local y size) of the emitter. More...
void	setSize (const Vector3 &size)
	Sets the size of the area from which particles are emitted. More...
void	setSize (Real x, Real y, Real z)
	Sets the size of the area from which particles are emitted. More...
void	setWidth (Real width)
	Sets the width (local x size) of the emitter. More...
Public Member Functions inherited from Ogre::EmitterDefData
	EmitterDefData ()
unsigned short	_getEmissionCount (Real timeElapsed) final
	Override so we don't use it accidentally (we use genEmissionCount() instead). More...
ParticleEmitter *	asParticleEmitter ()
	ParticleEmitter is a protected base class of EmitterDefData. More...
const ParticleEmitter *	asParticleEmitter () const
uint32	genEmissionCount (Real timeSinceLast, EmitterInstanceData &instanceData) const
	Must be called by 1 thread. More...
const Vector2 &	getInitialDimensions () const
void	setInitialDimensions (const Vector2 &dim)

Detailed Description

Particle emitter which emits particles randomly from points inside a ring (e.g.

a tube).

Remarks

This particle emitter emits particles from a ring-shaped area. The initial direction of these particles can either be a single direction (i.e. a line), a random scattering inside a cone, or a random scattering in all directions, depending the 'angle' parameter, which is the angle across which to scatter the particles either side of the base direction of the emitter.

Constructor & Destructor Documentation

RingEmitter2()

Ogre::RingEmitter2::RingEmitter2

(

)

Member Function Documentation

_cloneFrom()

void Ogre::RingEmitter2::_cloneFrom ( const EmitterDefData *  original )

overridevirtual

Reimplemented from Ogre::AreaEmitter2.

getInnerSizeX()

Real Ogre::RingEmitter2::getInnerSizeX

(

)

const

Gets the x component of the area inside the ellipsoid which doesn't emit particles.

getInnerSizeY()

Real Ogre::RingEmitter2::getInnerSizeY

(

)

const

Gets the y component of the area inside the ellipsoid which doesn't emit particles.

getType()

const String& Ogre::RingEmitter2::getType ( ) const

overridevirtual

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.

Implements Ogre::ParticleEmitter.

initEmittedParticles()

void Ogre::RingEmitter2::initEmittedParticles ( ParticleCpuData  cpuData, const EmittedParticle *  newHandles, size_t  numParticles  )

overridevirtual

Initializes particles Can be called by multiple threads.

Parameters

cpuData
newHandles
numParticles	Number of particles to initialize.

Implements Ogre::EmitterDefData.

setInnerSize()

void Ogre::RingEmitter2::setInnerSize	(	Real	x,
		Real	y
	)

Sets the size of the clear space inside the area from where NO particles are emitted.

Parameters

x,y	Parametric values describing the proportion of the shape which is hollow in each direction. E.g. 0 is solid, 0.5 is half-hollow etc

setInnerSizeX()

void Ogre::RingEmitter2::setInnerSizeX

(

Real

x

)

Sets the x component of the area inside the ellipsoid which doesn't emit particles.

Parameters

x	Parametric value describing the proportion of the shape which is hollow in this direction. E.g. 0 is solid, 0.5 is half-hollow etc

setInnerSizeY()

void Ogre::RingEmitter2::setInnerSizeY

(

Real

y

)

Sets the y component of the area inside the ellipsoid which doesn't emit particles.

Parameters

y	Parametric value describing the proportion of the shape which is hollow in this direction. E.g. 0 is solid, 0.5 is half-hollow etc

---

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

• OgreRingEmitter2.h