Spawns WaterParticles into the world (i.e. an unbounded WaterParticleSet). More...

Inheritance diagram for ParticleEmitterLogic:

Signals
void	colorChanged ()
	Emitted when color changes. More...

void	pauseDistanceChanged ()
	Emitted when pauseDistance changes. More...

void	layerChanged ()
	Emitted when layer changes. More...

Signals inherited from EmitterLogic
void	requestedMaxEntityCountChanged ()
	Emitted when requestedMaxEntityCount changes. More...

void	spawnRateChanged ()
	Emitted when spawnRate changes. More...

void	spawnVelocityChanged ()
	Emitted when spawnVelocity changes. More...

void	spawnSpreadChanged ()
	Emitted when spawnSpread changes. More...

void	spawnSprayChanged ()
	Emitted when spawnSpray changes. More...

void	spawnRandomChanged ()
	Emitted when spawnRandom changes. More...

void	timeOffChanged ()
	Emitted when timeOff changes. More...

void	timeOnChanged ()
	Emitted when timeOn changes. More...

void	transitionOnTimeChanged ()
	Emitted when transitionOnTime changes. More...

void	transitionOffTimeChanged ()
	Emitted when transitionOffTime changes. More...

void	decayTimeChanged ()
	Emitted when decayTime changes. More...

void	decayTimeRandomLengthChanged ()
	Emitted when decayTimeRandomLength changes. More...

void	pausedChanged ()
	Emitted when paused changes. More...

Signals inherited from Logic
void	activeChanged ()
	Emitted when active changes. More...

Public Member Functions
QColor	getColor () const
	Returns color. More...

void	setColor (const QColor &color)
	Sets color. More...

float	getPauseDistance () const
	Returns pauseDistance. More...

void	setPauseDistance (float value)
	Sets pauseDistance. More...

ParticleLayer *	getLayer () const
	Returns layer. More...

void	setLayer (ParticleLayer *value)
	Sets layer. More...

virtual int	getEntityCount () const override
	Returns entityCount. More...

virtual void	update () override
	Pauses the emitter if necessary and updates the internal WaterParticleSet into which particles are spawned. More...

Public Member Functions inherited from EmitterLogic
int	getRequestedMaxEntityCount () const
	Returns requestedMaxEntityCount. More...

void	setRequestedMaxEntityCount (int value)
	Sets requestedMaxEntityCount. More...

virtual int	getSupportedMaxEntityCount () const
	Returns supportedMaxEntityCount. More...

int	getMaxEntityCount () const
	Returns maxEntityCount. More...

float	getSpawnRate () const
	Returns spawnRate. More...

void	setSpawnRate (float value)
	Sets spawnRate. More...

float	getSpawnVelocity () const
	Returns spawnVelocity. More...

void	setSpawnVelocity (float value)
	Sets spawnVelocity. More...

float	getSpawnSpread () const
	Returns spawnSpread. More...

void	setSpawnSpread (float value)
	Sets spawnSpread. More...

float	getSpawnSpray () const
	Returns spawnSpray. More...

void	setSpawnSpray (float value)
	Sets spawnSpray. More...

bool	isSpawnRandom () const
	Returns spawnRandom. More...

void	setSpawnRandom (bool value)
	Sets spawnRandom. More...

float	getTimeOn () const
	Returns timeOn. More...

void	setTimeOn (float value)
	Sets timeOn. More...

float	getTimeOff () const
	Returns timeOff. More...

void	setTimeOff (float value)
	Sets timeOff. More...

float	getTransitionOnTime () const
	Returns transitionOnTime. More...

void	setTransitionOnTime (float value)
	Sets transitionOnTime. More...

float	getTransitionOffTime () const
	Returns transitionOffTime. More...

void	setTransitionOffTime (float value)
	Sets transitionOffTime. More...

float	getDecayTime () const
	Returns decayTime. More...

void	setDecayTime (float value)
	Sets decayTime. More...

float	getDecayTimeRandomLength () const
	Returns decayTimeRandomLength. More...

void	setDecayTimeRandomLength (float value)
	Sets decayTimeRandomLength. More...

bool	isPaused () const
	Returns paused. More...

void	setPaused (bool value)
	Sets paused. More...

virtual void	init () override
	Checks that the EmitterLogic has an actor. More...

Public Member Functions inherited from Logic
	Logic (QObject *parent=nullptr)
	Constructs a Logic. More...

Actor *	getActor () const
	Returns actor. More...

bool	isActive () const
	Returns active. More...

void	setActive (bool value)
	Sets active. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

virtual const QMetaObject *	metaObject () const

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const

bool	blockSignals (bool block)

QThread *	thread () const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectTree ()

void	dumpObjectInfo ()

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

bool	inherits (const char *className) const

void	deleteLater ()

Protected Member Functions
WaterParticleSet &	getWaterParticleSet ()
	Returns the backing WaterParticleSet. More...

virtual void	emitEntity (const SpawnParameters &parameters) override
	Spawns a new WaterParticle into an internal WaterParticleSet. More...

virtual void	onPausedChanged () override
	Empties the internal WaterParticleSet when the emitter is paused. More...

virtual QRectF	getEmitterWorldBounds ()
	Returns the bounding box of this emitter in world coordinates. More...

Protected Member Functions inherited from EmitterLogic
SpawnParameters	getNextRandomSpawnParameters () const
	Returns a randomized set of SpawnParameters according to EmitterLogic's parameters. More...

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Properties
QColor	color
	Color of spawned particles. More...

float	pauseDistance
	Distance units from viewport edge to automatically pause the emitter. More...

ParticleLayer	layer
	Layer to spawn particles on. More...

Properties inherited from EmitterLogic
int	requestedMaxEntityCount
	User-defined maximum number of entities to spawn. More...

int	supportedMaxEntityCount
	Class-defined maximum number of entities to spawn. More...

int	maxEntityCount
	Actual maximum number of entities to spawn, bounded by both requestedMaxEntityCount and supportedMaxEntityCount. More...

int	entityCount
	Number of spawned entities still in existence. More...

float	spawnRate
	Number of entities spawned per frame (i.e. each non-paused call to update()). More...

float	spawnVelocity
	Forward velocity for spawned entities. More...

float	spawnSpread
	Horizontal axis spread to apply to spawned entities. More...

float	spawnSpray
	Divergence factor affecting the amount entities will stray from the direction of the emitter. More...

bool	spawnRandom
	`true` if SpawnParameters are pseudo randomized, or patterned if `false`. More...

float	timeOn
	Number of seconds, in game time, the emitter will stay on in one cycle. More...

float	timeOff
	Number of seconds, in game time, the emitter will stay off in one cycle. More...

float	transitionOnTime
	Number of seconds, in game time, the emitter takes to turn on. More...

float	transitionOffTime
	Number of seconds, in game time, the emitter takes to turn off. More...

float	decayTime
	Number of seconds, in game time, before the entity is destroyed. More...

float	decayTimeRandomLength
	Maximum time delta an entity can randomly stay alive if spawnRandom is `true`. More...

bool	paused
	Whether or not this emitter should spawn entities. More...

Properties inherited from Logic
Actor	actor
	Parent actor that is affected by this Logic's behavior. More...

bool	active
	Whether or not Engine calls update() on this Logic during the Engine::LOGICS_PHASE. More...

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Detailed Description

Spawns WaterParticles into the world (i.e. an unbounded WaterParticleSet).

This class can be used to create geysers or streams of particles that interact with the world.

Member Function Documentation

void ParticleEmitterLogic::colorChanged ( )

signal

Emitted when color changes.

virtual void ParticleEmitterLogic::emitEntity ( const SpawnParameters & parameters )

overrideprotectedvirtual

Spawns a new WaterParticle into an internal WaterParticleSet.

Parameters

parameters Parameters to initialize the spawned WaterParticle with

Reimplemented from EmitterLogic.

QColor ParticleEmitterLogic::getColor ( ) const

inline

Returns color.

virtual QRectF ParticleEmitterLogic::getEmitterWorldBounds ( )

protectedvirtual

Returns the bounding box of this emitter in world coordinates.

Reimplemented in WaterBodyLogic.

virtual int ParticleEmitterLogic::getEntityCount ( ) const

inlineoverridevirtual

Returns entityCount.

Reimplemented from EmitterLogic.

ParticleLayer* ParticleEmitterLogic::getLayer ( ) const

inline

Returns layer.

float ParticleEmitterLogic::getPauseDistance ( ) const

inline

Returns pauseDistance.

WaterParticleSet& ParticleEmitterLogic::getWaterParticleSet ( )

inlineprotected

Returns the backing WaterParticleSet.

void ParticleEmitterLogic::layerChanged ( )

signal

Emitted when layer changes.

virtual void ParticleEmitterLogic::onPausedChanged ( )

overrideprotectedvirtual

Empties the internal WaterParticleSet when the emitter is paused.

Reimplemented from EmitterLogic.

Reimplemented in WaterBodyLogic.

void ParticleEmitterLogic::pauseDistanceChanged ( )

signal

Emitted when pauseDistance changes.

void ParticleEmitterLogic::setColor ( const QColor & color )

Sets color.

Parameters

color Color to set color to

void ParticleEmitterLogic::setLayer ( ParticleLayer * value )

Sets layer.

Parameters

value ParticleLayer to set layer to

void ParticleEmitterLogic::setPauseDistance ( float value )

Sets pauseDistance.

Parameters

value Float to set pauseDistance to

virtual void ParticleEmitterLogic::update ( )

overridevirtual

Pauses the emitter if necessary and updates the internal WaterParticleSet into which particles are spawned.

Reimplemented from EmitterLogic.

Reimplemented in WaterBodyLogic.

Property Documentation

QColor ParticleEmitterLogic::color

readwrite

Color of spawned particles.

ParticleLayer ParticleEmitterLogic::layer

readwrite

Layer to spawn particles on.

float ParticleEmitterLogic::pauseDistance

readwrite

Distance units from viewport edge to automatically pause the emitter.

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation