com.almasb.fxgl.physics.box2d.particle

Class ParticleGroupDef

java.lang.Object

com.almasb.fxgl.physics.box2d.particle.ParticleGroupDef

public class ParticleGroupDef
extends Object

A particle group definition holds all the data needed to construct a particle group. You can safely re-use these definitions.

Field Summary

Fields

Modifier and Type	Field and Description
float	angularVelocity The angular velocity of the group.

Constructor Summary

Constructors

Constructor and Description
ParticleGroupDef()

Method Summary

Modifier and Type	Method and Description
float	getAngle()
float	getAngularVelocity()
ParticleColor	getColor()
int	getGroupFlags()
Vec2	getLinearVelocity()
Vec2	getPosition()
Shape	getShape()
float	getStrength()
int	getTypeFlags()
Object	getUserData()
boolean	isDestroyAutomatically()
void	setAngle(float angle) The world angle of the group in radians.
void	setAngularVelocity(float angularVelocity)
void	setColor(ParticleColor color)
void	setDestroyAutomatically(boolean destroyAutomatically)
void	setGroupFlags(int groupFlags)
void	setPosition(float x, float y) Moves the group's shape a distance equal to the value of position.
void	setShape(Shape shape)
void	setStrength(float strength)
void	setTypes(Set<ParticleType> types) Set particle types.

Methods inherited from class java.lang.Object

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

Field Detail

angularVelocity

public float angularVelocity

The angular velocity of the group.

Constructor Detail

ParticleGroupDef

public ParticleGroupDef()

Method Detail

getTypeFlags

public int getTypeFlags()

Returns:

the particle-behavior flags from ParticleTypeInternal

setTypes

public void setTypes(Set<ParticleType> types)

Set particle types. E.g. EnumSet.of(ParticleType...).

Parameters:

types - particle types

getGroupFlags

public int getGroupFlags()

Returns:

the group-construction flags

setGroupFlags

public void setGroupFlags(int groupFlags)

getPosition

public Vec2 getPosition()

Returns:

the world position of the group.

setPosition

public void setPosition(float x,
                        float y)

Moves the group's shape a distance equal to the value of position.

Parameters:

x - x coord

y - y coord

getAngle

public float getAngle()

Returns:

The world angle of the group in radians. Rotates the shape by an angle equal to the value of angle

setAngle

public void setAngle(float angle)

The world angle of the group in radians. Rotates the shape by an angle equal to the value of angle.

Parameters:

angle - in radians

getLinearVelocity

public Vec2 getLinearVelocity()

getAngularVelocity

public float getAngularVelocity()

setAngularVelocity

public void setAngularVelocity(float angularVelocity)

getColor

public ParticleColor getColor()

setColor

public void setColor(ParticleColor color)

getStrength

public float getStrength()

setStrength

public void setStrength(float strength)

getShape

public Shape getShape()

Returns:

shape containing the particle group

setShape

public void setShape(Shape shape)

Parameters:

shape - the shape containing the particle group

isDestroyAutomatically

public boolean isDestroyAutomatically()

setDestroyAutomatically

public void setDestroyAutomatically(boolean destroyAutomatically)

getUserData

public Object getUserData()