de.gurkenlabs.litiengine.graphics.emitters.particles

Class Particle

java.lang.Object

de.gurkenlabs.litiengine.graphics.emitters.particles.Particle

All Implemented Interfaces:

ITimeToLive

Direct Known Subclasses:

ShapeParticle, SpriteParticle, TextParticle

public abstract class Particle
extends java.lang.Object
implements ITimeToLive

Constructor Summary

Constructors

Constructor and Description
Particle(float width, float height, java.awt.Color color, int ttl) Constructs a new particle.

Method Summary

Modifier and Type	Method and Description
java.awt.geom.Point2D	getAbsoluteLocation(java.awt.geom.Point2D effectLocation)
protected float	getAbsoluteX(java.awt.geom.Point2D emitterOrigin)
protected float	getAbsoluteY(java.awt.geom.Point2D emitterOrigin)
long	getAliveTime()
java.awt.geom.Rectangle2D	getBoundingBox(java.awt.geom.Point2D origin)
CollisionType	getCollisionType()
java.awt.Color	getColor()
int	getColorAlpha()
RenderType	getCustomRenderType()
float	getDeltaHeight()
float	getDeltaWidth()
float	getDx()
float	getDy()
float	getGravityX()
float	getGravityY()
float	getHeight()
protected float	getOpacity()
java.awt.geom.Point2D	getRenderLocation(java.awt.geom.Point2D effectLocation) Gets the location relative to the specified effect location.
int	getTimeToLive()
float	getWidth()
float	getX()
float	getY()
boolean	isContinuousCollisionEnabled()
boolean	isFading()
boolean	isFadingOnCollision()
abstract void	render(java.awt.Graphics2D g, java.awt.geom.Point2D emitterOrigin)
Particle	setCollisionType(CollisionType collisionType)
Particle	setColor(java.awt.Color color)
Particle	setColorAlpha(int colorAlpha) Sets the color alpha.
Particle	setContinuousCollision(boolean ccd) Enabling this check can be very performance hungry and should be used with caution and only for a small amount of particles.
Particle	setCustomRenderType(RenderType renderType)
Particle	setDeltaHeight(float deltaHeight)
Particle	setDeltaIncX(float gravityX)
Particle	setDeltaIncY(float gravityY)
Particle	setDeltaWidth(float deltaWidth)
Particle	setDeltaX(float dx)
Particle	setDeltaY(float dy)
Particle	setFade(boolean fade)
Particle	setFadeOnCollision(boolean fadeOnCollision)
Particle	setHeight(float height)
Particle	setWidth(float width)
Particle	setX(float x)
Particle	setY(float y)
boolean	timeToLiveReached()
void	update(java.awt.geom.Point2D emitterOrigin, float updateRatio) Updates the effect's position, change in xCurrent, change in yCurrent, remaining lifetime, and color.
boolean	usesCustomRenderType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Particle

public Particle(float width,
                float height,
                java.awt.Color color,
                int ttl)

Constructs a new particle.

Parameters:

width - the width

height - the height

ttl - The remaining time to live of the particle.

color - The color of the effect.

Method Detail

getAliveTime

public long getAliveTime()

Specified by:

getAliveTime in interface ITimeToLive

getBoundingBox

public java.awt.geom.Rectangle2D getBoundingBox(java.awt.geom.Point2D origin)

getCollisionType

public CollisionType getCollisionType()

getColor

public java.awt.Color getColor()

getColorAlpha

public int getColorAlpha()

getDeltaHeight

public float getDeltaHeight()

getDeltaWidth

public float getDeltaWidth()

getDx

public float getDx()

getDy

public float getDy()

getGravityX

public float getGravityX()

getGravityY

public float getGravityY()

getHeight

public float getHeight()

getRenderLocation

public java.awt.geom.Point2D getRenderLocation(java.awt.geom.Point2D effectLocation)

Gets the location relative to the specified effect location.

Parameters:

effectLocation - the effect position

Returns:

the location

getCustomRenderType

public RenderType getCustomRenderType()

getTimeToLive

public int getTimeToLive()

Specified by:

getTimeToLive in interface ITimeToLive

getWidth

public float getWidth()

getX

public float getX()

getY

public float getY()

isFading

public boolean isFading()

isFadingOnCollision

public boolean isFadingOnCollision()

isContinuousCollisionEnabled

public boolean isContinuousCollisionEnabled()

render

public abstract void render(java.awt.Graphics2D g,
                            java.awt.geom.Point2D emitterOrigin)

setCollisionType

public Particle setCollisionType(CollisionType collisionType)

setContinuousCollision

public Particle setContinuousCollision(boolean ccd)

Enabling this check can be very performance hungry and should be used with caution and only for a small amount of particles.

Parameters:

ccd - If set to true, the collision will be checked continuously by a ray-cast approximation.

Returns:

This particle instance.

setColor

public Particle setColor(java.awt.Color color)

setColorAlpha

public Particle setColorAlpha(int colorAlpha)

Sets the color alpha. A value between 0 and 100 is expected. Otherwise it won't be set.

Parameters:

colorAlpha - the new color alpha

Returns:

This Particle instance to chain further setter calls.

setDeltaHeight

public Particle setDeltaHeight(float deltaHeight)

setDeltaIncX

public Particle setDeltaIncX(float gravityX)

setDeltaIncY

public Particle setDeltaIncY(float gravityY)

setDeltaWidth

public Particle setDeltaWidth(float deltaWidth)

setDeltaX

public Particle setDeltaX(float dx)

setDeltaY

public Particle setDeltaY(float dy)

setFade

public Particle setFade(boolean fade)

setFadeOnCollision

public Particle setFadeOnCollision(boolean fadeOnCollision)

setHeight

public Particle setHeight(float height)

setCustomRenderType

public Particle setCustomRenderType(RenderType renderType)

setWidth

public Particle setWidth(float width)

setX

public Particle setX(float x)

setY

public Particle setY(float y)

timeToLiveReached

public boolean timeToLiveReached()

Specified by:

timeToLiveReached in interface ITimeToLive

update

public void update(java.awt.geom.Point2D emitterOrigin,
                   float updateRatio)

Updates the effect's position, change in xCurrent, change in yCurrent, remaining lifetime, and color.

Parameters:

emitterOrigin - The current Emitter origin

updateRatio - The update ratio for this particle.

getAbsoluteLocation

public java.awt.geom.Point2D getAbsoluteLocation(java.awt.geom.Point2D effectLocation)

getAbsoluteX

protected float getAbsoluteX(java.awt.geom.Point2D emitterOrigin)

getAbsoluteY

protected float getAbsoluteY(java.awt.geom.Point2D emitterOrigin)

getOpacity

protected float getOpacity()

usesCustomRenderType

public boolean usesCustomRenderType()