Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow an emitter to automatically update via the PIXI shared ticker #38

Merged
merged 3 commits into from
Jan 13, 2017
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion src/Emitter.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@

var ParticleUtils = PIXI.particles.ParticleUtils,
Particle = PIXI.particles.Particle,
ParticleContainer = PIXI.particles.ParticleContainer || PIXI.ParticleContainer;
ParticleContainer = PIXI.particles.ParticleContainer || PIXI.ParticleContainer,
ticker = PIXI.ticker.shared;

/**
* A particle emitter.
Expand All @@ -22,6 +23,8 @@
* @param {Object} [config] A configuration object containing settings for the emitter.
* @param {Boolean} [config.emit=true] If config.emit is explicitly passed as false, the Emitter
* will start disabled.
* @param {Boolean} [config.autoUpdate=false] If config.emit is explicitly passed as true, the Emitter
* will automatically call update via the PIXI shared ticker.
*/
var Emitter = function(particleParent, particleImages, config)
{
Expand Down Expand Up @@ -363,6 +366,13 @@
* @private
*/
this._origArt = null;
/**
* If the update function is called automatically from the shared ticker.
* Setting this to false requires calling the update function manually.
* @property {Boolean} _autoUpdate
* @private
*/
this._autoUpdate = false;

//set the initial parent
this.parent = particleParent;
Expand Down Expand Up @@ -638,6 +648,7 @@
//start emitting
this._spawnTimer = 0;
this.emit = config.emit === undefined ? true : !!config.emit;
this.autoUpdate = config.autoUpdate === undefined ? false : !!config.autoUpdate;
};

/**
Expand Down Expand Up @@ -744,13 +755,40 @@
}
});

/**
* If particles should be emitted during update() calls. Setting this to false
* stops new particles from being created, but allows existing ones to die out.
* @property {Boolean} emit
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This appears to be the docs for emit.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also change "emit" to "autoUpdate" here.

*/
Object.defineProperty(p, "autoUpdate",
{
get: function() { return this._autoUpdate; },
set: function(value)
{
if (this._autoUpdate && value === false)
{
ticker.remove(this.update, this);
}
else if (!this._autoUpdate && value === true)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that you are converting to a boolean value when setting _autoUpdate at the bottom of this, it seems odd to use strict equality rather than just using value as falsy and truthy.

{
ticker.add(this.update, this);
}
this._autoUpdate = !!value;
}
});

/**
* Updates all particles spawned by this emitter and emits new ones.
* @method update
* @param {Number} delta Time elapsed since the previous frame, in __seconds__.
*/
p.update = function(delta)
{
if (this._autoUpdate)
{
delta *= 0.01;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In pixi-animate I set up some code to convert from ticker delta (which is not hundredths of a second) to actual elapsed seconds. Would that be worth reusing here?

}

//if we don't have a parent to add particles to, then don't do anything.
//this also works as a isDestroyed check
if (!this._parent) return;
Expand Down