org.dishevelled.piccolo.physics

Class ParticleSystemActivity

java.lang.Object

org.piccolo2d.activities.PActivity

org.dishevelled.piccolo.physics.ParticleSystemActivity

public class ParticleSystemActivity
extends org.piccolo2d.activities.PActivity

Particle system activity.

Version:

$Revision$ $Date$

Author:

Michael Heuer

Nested Class Summary

Nested classes/interfaces inherited from class org.piccolo2d.activities.PActivity

org.piccolo2d.activities.PActivity.PActivityDelegate

Field Summary

Fields inherited from class org.piccolo2d.activities.PActivity

TERMINATE_AND_FINISH, TERMINATE_AND_FINISH_IF_STEPPING, TERMINATE_WITHOUT_FINISHING

Constructor Summary

Constructors

Constructor and Description
ParticleSystemActivity(long duration) Create a new particle system activity with the specified duration in milliseconds.
ParticleSystemActivity(long duration, long stepRate, long startTime) Create a new particle system activity with the specified duration, step rate, and start time in milliseconds.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activityFinished()
protected void	activityStep(long elapsedTime)
void	clamp(org.piccolo2d.PNode node) Clamp the velocity for the particle associated with the specified node to [0.0f, 0.0f].
void	createAttraction(org.piccolo2d.PNode source, org.piccolo2d.PNode target, float strength, float minimumDistance) Create a new attraction (or repulsion) force between the specified source and target nodes with the specified strength and minimum distance.
void	createParticle(org.piccolo2d.PNode node, float mass) Create a new particle for the specified node with the specified mass.
void	createSpring(org.piccolo2d.PNode source, org.piccolo2d.PNode target, float strength, float damping, float restLength) Create a new spring between the specified source and target nodes with the specified strength, damping factor, and rest length.
void	disableAttraction(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Disable the attraction between the specified source and target nodes.
void	disableSpring(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Disable the spring between the specified source and target nodes.
void	enableAttraction(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Enable the attraction between the specified source and target nodes.
void	enableSpring(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Enable the spring between the specified source and target nodes.
float	getAttractionMinimumDistance(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Return the minimum distance for the attraction between the specified source and target nodes.
float	getAttractionStrength(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Return the strength of the attraction between the specified source and target nodes.
float	getParticleMass(org.piccolo2d.PNode node) Return the mass of the particle associated with the specified node.
float	getSpringDamping(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Return the damping factor for the spring between the specified source and target nodes.
float	getSpringRestLength(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Return the rest length for the spring between the specified source and target nodes.
float	getSpringStrength(org.piccolo2d.PNode source, org.piccolo2d.PNode target) Return the strength of the spring between the specified source and target nodes.
Point2D	getVelocity(org.piccolo2d.PNode node) Return the velocity for particle associated with the specified node.
Point2D	getVelocity(org.piccolo2d.PNode node, Point2D velocity) Return the specified velocity, set to the velocity for particle associated with the specified node.
void	release(org.piccolo2d.PNode node) Release or unclamp the velocity for the particle associated with the specified node.
void	setAttractionMinimumDistance(org.piccolo2d.PNode source, org.piccolo2d.PNode target, float minimumDistance) Set the minimum distance for the attraction between the specified source and target nodes to minimumDistance.
void	setAttractionStrength(org.piccolo2d.PNode source, org.piccolo2d.PNode target, float strength) Set the strength of the attraction between the specified source and target nodes to strength.
void	setDrag(float drag) Set the drag force for the particle system to drag.
void	setGravity(float gravity) Set the strength of gravity for the particle system to gravity.
void	setParticleMass(org.piccolo2d.PNode node, float mass) Set the mass of the particle associated with the specified node to mass.
void	setSpringDamping(org.piccolo2d.PNode source, org.piccolo2d.PNode target, float damping) Set the damping factor for the spring between the specified source and target nodes to dampingFactor.
void	setSpringRestLength(org.piccolo2d.PNode source, org.piccolo2d.PNode target, float restLength) Set the rest length for the spring between the specified source and target nodes to restLength.
void	setSpringStrength(org.piccolo2d.PNode source, org.piccolo2d.PNode target, float strength) Set the strength of the spring between the specified source and target nodes to strength.
void	setVelocity(org.piccolo2d.PNode node, float x, float y) Set the velocity for the particle associated with the specified node to [x, y].
void	setVelocity(org.piccolo2d.PNode node, Point2D velocity) Set the velocity for the particle associated with the specified node to velocity.

Methods inherited from class org.piccolo2d.activities.PActivity

activityStarted, getActivityScheduler, getDelegate, getDuration, getNextStepTime, getStartTime, getStepRate, getStopTime, isAnimation, isStepping, processStep, setActivityScheduler, setDelegate, setDuration, setStartTime, setStepRate, startAfter, terminate, terminate

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleSystemActivity

public ParticleSystemActivity(long duration)

Create a new particle system activity with the specified duration in milliseconds.

Parameters:

duration - duration in milliseconds, or -1 ms for an infinite duration

ParticleSystemActivity

public ParticleSystemActivity(long duration,
                      long stepRate,
                      long startTime)

Create a new particle system activity with the specified duration, step rate, and start time in milliseconds.

Parameters:

duration - duration in milliseconds, or -1 ms for an infinite duration

stepRate - step rate in milliseconds

startTime - start time in milliseconds

Method Detail

setDrag

public void setDrag(float drag)

Set the drag force for the particle system to drag.

Parameters:

drag - drag force

setGravity

public void setGravity(float gravity)

Set the strength of gravity for the particle system to gravity.

Parameters:

gravity - strength of gravity

createParticle

public void createParticle(org.piccolo2d.PNode node,
                  float mass)

Create a new particle for the specified node with the specified mass.

Parameters:

node - node, must not be null

mass - particle mass

getVelocity

public Point2D getVelocity(org.piccolo2d.PNode node)

Return the velocity for particle associated with the specified node. A particle must have already been created for the specified node.

Parameters:

node - node, must not be null

Returns:

the velocity for particle associated with the specified node

getVelocity

public Point2D getVelocity(org.piccolo2d.PNode node,
                  Point2D velocity)

Return the specified velocity, set to the velocity for particle associated with the specified node. A particle must have already been created for the specified node.

Parameters:

node - node, must not be null

velocity - velocity, must not be null

Returns:

the specified velocity, set to the velocity for particle associated with the specified node

setVelocity

public void setVelocity(org.piccolo2d.PNode node,
               float x,
               float y)

Set the velocity for the particle associated with the specified node to [x, y]. A particle must have already been created for the specified node.

Parameters:

node - node, must not be null

x - velocity x

y - velocity y

setVelocity

public void setVelocity(org.piccolo2d.PNode node,
               Point2D velocity)

Set the velocity for the particle associated with the specified node to velocity. A particle must have already been created for the specified node.

Parameters:

node - node, must not be null

velocity - velocity, must not be null

getParticleMass

public float getParticleMass(org.piccolo2d.PNode node)

Return the mass of the particle associated with the specified node. A particle must have already been created for the specified node.

Parameters:

node - node, must not be null

Returns:

the mass of the particle associated with the specified node

setParticleMass

public void setParticleMass(org.piccolo2d.PNode node,
                   float mass)

Set the mass of the particle associated with the specified node to mass. A particle must have already been created for the specified node.

Parameters:

node - node, must not be null

mass - particle mass

clamp

public void clamp(org.piccolo2d.PNode node)

Clamp the velocity for the particle associated with the specified node to [0.0f, 0.0f]. A particle must have already been created for the specified node. A clamped particle will receive updated position data from the full bounds of the specified node.

Parameters:

node - node, must not be null

release

public void release(org.piccolo2d.PNode node)

Release or unclamp the velocity for the particle associated with the specified node. A particle must have already been created for the specified node.

Parameters:

node - node, must not be null

createSpring

public void createSpring(org.piccolo2d.PNode source,
                org.piccolo2d.PNode target,
                float strength,
                float damping,
                float restLength)

Create a new spring between the specified source and target nodes with the specified strength, damping factor, and rest length. A particle must have already been created for both the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

strength - spring strength

damping - damping factor

restLength - rest length

enableSpring

public void enableSpring(org.piccolo2d.PNode source,
                org.piccolo2d.PNode target)

Enable the spring between the specified source and target nodes. A spring must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

disableSpring

public void disableSpring(org.piccolo2d.PNode source,
                 org.piccolo2d.PNode target)

Disable the spring between the specified source and target nodes. A spring must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

getSpringRestLength

public float getSpringRestLength(org.piccolo2d.PNode source,
                        org.piccolo2d.PNode target)

Return the rest length for the spring between the specified source and target nodes. A spring must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

Returns:

the rest length for the spring between the specified source and target nodes

setSpringRestLength

public void setSpringRestLength(org.piccolo2d.PNode source,
                       org.piccolo2d.PNode target,
                       float restLength)

Set the rest length for the spring between the specified source and target nodes to restLength. A spring must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

restLength - rest length

getSpringStrength

public float getSpringStrength(org.piccolo2d.PNode source,
                      org.piccolo2d.PNode target)

Return the strength of the spring between the specified source and target nodes. A spring must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

Returns:

the strength of the spring between the specified source and target nodes

setSpringStrength

public void setSpringStrength(org.piccolo2d.PNode source,
                     org.piccolo2d.PNode target,
                     float strength)

Set the strength of the spring between the specified source and target nodes to strength. A spring must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

strength - spring strength

getSpringDamping

public float getSpringDamping(org.piccolo2d.PNode source,
                     org.piccolo2d.PNode target)

Return the damping factor for the spring between the specified source and target nodes. A spring must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

Returns:

the damping factor for the spring between the specified source and target nodes

setSpringDamping

public void setSpringDamping(org.piccolo2d.PNode source,
                    org.piccolo2d.PNode target,
                    float damping)

Set the damping factor for the spring between the specified source and target nodes to dampingFactor. A spring must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

damping - damping factor

createAttraction

public void createAttraction(org.piccolo2d.PNode source,
                    org.piccolo2d.PNode target,
                    float strength,
                    float minimumDistance)

Create a new attraction (or repulsion) force between the specified source and target nodes with the specified strength and minimum distance. A particle must have already been created for both the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

strength - attraction (or repulsion) force strength

minimumDistance - minimum distance

enableAttraction

public void enableAttraction(org.piccolo2d.PNode source,
                    org.piccolo2d.PNode target)

Enable the attraction between the specified source and target nodes. An attraction must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

disableAttraction

public void disableAttraction(org.piccolo2d.PNode source,
                     org.piccolo2d.PNode target)

Disable the attraction between the specified source and target nodes. An attraction must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

getAttractionStrength

public float getAttractionStrength(org.piccolo2d.PNode source,
                          org.piccolo2d.PNode target)

Return the strength of the attraction between the specified source and target nodes. An attraction must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

Returns:

the strength of the attraction between the specified source and target nodes

setAttractionStrength

public void setAttractionStrength(org.piccolo2d.PNode source,
                         org.piccolo2d.PNode target,
                         float strength)

Set the strength of the attraction between the specified source and target nodes to strength. An attraction must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

strength - attraction (or repulsion) force strength

getAttractionMinimumDistance

public float getAttractionMinimumDistance(org.piccolo2d.PNode source,
                                 org.piccolo2d.PNode target)

Return the minimum distance for the attraction between the specified source and target nodes. An attraction must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

Returns:

the minimum distance for the attraction between the specified source and target nodes

setAttractionMinimumDistance

public void setAttractionMinimumDistance(org.piccolo2d.PNode source,
                                org.piccolo2d.PNode target,
                                float minimumDistance)

Set the minimum distance for the attraction between the specified source and target nodes to minimumDistance. An attraction must have already been created for the specified source and target nodes.

Parameters:

source - source node, must not be null

target - target node, must not be null

minimumDistance - minimum distance

activityStep

protected void activityStep(long elapsedTime)

If subclasses override this method, they must call super.activityFinished().

Overrides:

activityStep in class org.piccolo2d.activities.PActivity

activityFinished

protected void activityFinished()

If subclasses override this method, they must call super.activityFinished().

Overrides:

activityFinished in class org.piccolo2d.activities.PActivity