com.badlogic.gdx.scenes.scene2d.ui.ParticleEffectActor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gdx Show documentation
Android/Desktop/iOS/HTML5 game development framework
There is a newer version: 1.12.1

package com.badlogic.gdx.scenes.scene2d.ui;

import com.badlogic.gdx.files.FileHandle;
import com.badlogic.gdx.graphics.g2d.Batch;
import com.badlogic.gdx.graphics.g2d.ParticleEffect;
import com.badlogic.gdx.graphics.g2d.TextureAtlas;
import com.badlogic.gdx.scenes.scene2d.Actor;
import com.badlogic.gdx.utils.Disposable;

/** ParticleEffectActor holds an {@link ParticleEffect} to use in Scene2d applications. The particle effect is positioned at 0, 0
 * in the ParticleEffectActor. Its bounding box is not limited to the size of this actor. */
public class ParticleEffectActor extends Actor implements Disposable {
	private final ParticleEffect particleEffect;
	protected float lastDelta;
	protected boolean isRunning;
	protected boolean ownsEffect;
	private boolean resetOnStart;
	private boolean autoRemove;

	public ParticleEffectActor (ParticleEffect particleEffect, boolean resetOnStart) {
		super();
		this.particleEffect = particleEffect;
		this.resetOnStart = resetOnStart;
	}

	public ParticleEffectActor (FileHandle particleFile, TextureAtlas atlas) {
		super();
		particleEffect = new ParticleEffect();
		particleEffect.load(particleFile, atlas);
		ownsEffect = true;
	}

	public ParticleEffectActor (FileHandle particleFile, FileHandle imagesDir) {
		super();
		particleEffect = new ParticleEffect();
		particleEffect.load(particleFile, imagesDir);
		ownsEffect = true;
	}

	@Override
	public void draw (Batch batch, float parentAlpha) {
		particleEffect.setPosition(getX(), getY());
		if (lastDelta > 0) {
			particleEffect.update(lastDelta);
			lastDelta = 0;
		}
		if (isRunning) {
			particleEffect.draw(batch);
			isRunning = !particleEffect.isComplete();
		}
	}

	@Override
	public void act (float delta) {
		super.act(delta);
		// don't do particleEffect.update() here - the correct position is set just while we
		// are in draw() method. We save the delta here to update in draw()
		lastDelta += delta;

		if (autoRemove && particleEffect.isComplete()) {
			remove();
		}
	}

	public void start () {
		isRunning = true;
		if (resetOnStart) {
			particleEffect.reset(false);
		}
		particleEffect.start();
	}

	public boolean isResetOnStart () {
		return resetOnStart;
	}

	public ParticleEffectActor setResetOnStart (boolean resetOnStart) {
		this.resetOnStart = resetOnStart;
		return this;
	}

	public boolean isAutoRemove () {
		return autoRemove;
	}

	public ParticleEffectActor setAutoRemove (boolean autoRemove) {
		this.autoRemove = autoRemove;
		return this;
	}

	public boolean isRunning () {
		return isRunning;
	}

	public ParticleEffect getEffect () {
		return this.particleEffect;
	}

	@Override
	protected void scaleChanged () {
		super.scaleChanged();
		particleEffect.scaleEffect(getScaleX(), getScaleY(), getScaleY());
	}

	public void cancel () {
		isRunning = true;
	}

	public void allowCompletion () {
		particleEffect.allowCompletion();
	}

	@Override
	public void dispose () {
		if (ownsEffect) {
			particleEffect.dispose();
		}
	}

}