Particle emitter which emits particles randomly from points inside a box. More...

#include <OgreBoxEmitter2.h>

Inheritance diagram for Ogre::BoxEmitter2:

Public Member Functions
	BoxEmitter2 ()

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...

Public Member Functions inherited from Ogre::AreaEmitter2
void	_cloneFrom (const EmitterDefData *original) override

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 box.

Remarks: This basic particle emitter emits particles from a box 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

◆ BoxEmitter2()

Ogre::BoxEmitter2::BoxEmitter2 ( )

Member Function Documentation

◆ getType()

const String& Ogre::BoxEmitter2::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::BoxEmitter2::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.

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