GF4J 0.9.4 Beta

gameframe.graphics
Class EffectGroup

java.lang.Object
  |
  +--gameframe.graphics.BitmapEffect
        |
        +--gameframe.graphics.EffectGroup

public class EffectGroup
extends BitmapEffect

Groups a number of bitmap effects that are then applied when this effect is used in the order they were added.

Since:
GameFrame for Java 0.9.3
Version:
GameFrame for Java 0.9.4

Field Summary
protected  java.util.Vector m_effects
          The currently added effects in this group.
 
Constructor Summary
EffectGroup()
           
 
Method Summary
 void add(BitmapEffect effect)
          Adds the given effect to this group of effects.
 BitmapData processData(BitmapData data)
          Processes the given bitmap data with all the effects in this group.
 void remove(BitmapEffect effect)
          Removes the given effect from this group of effects.
 void removeAll()
          Removes all the effects from this group (no effects are applied).
 void reset()
          Resets all the effects in this group.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

m_effects

protected java.util.Vector m_effects
The currently added effects in this group.
Constructor Detail

EffectGroup

public EffectGroup()
Method Detail

add

public void add(BitmapEffect effect)
Adds the given effect to this group of effects.
Parameters:
effect - The effect to be added.

remove

public void remove(BitmapEffect effect)
Removes the given effect from this group of effects.
Parameters:
effect - The effect to be removed.

removeAll

public void removeAll()
Removes all the effects from this group (no effects are applied).
Since:
GameFrame for Java 0.9.3

reset

public void reset()
Resets all the effects in this group.
Overrides:
reset in class BitmapEffect
Since:
GameFrame for Java 0.9.3

processData

public BitmapData processData(BitmapData data)
Processes the given bitmap data with all the effects in this group.
Overrides:
processData in class BitmapEffect
Parameters:
data - The raw bitmap data that is to be processed.
Returns:
The processed data.

GF4J 0.9.4 Beta