All Implemented Interfaces:

it.unibo.alchemist.boundary.gui.effects.EffectFX , it.unibo.alchemist.boundary.gui.effects.EffectGroup , java.io.Serializable , java.lang.Iterable , java.util.Collection , java.util.Queue
```
public final class EffectStack>
 implements EffectGroup
 
```
The class models a group of effects, stored as a stack. It can manage priority of visualization and visibility of each effect inside it.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`name`
`private boolean`	`visibility`

Constructor Summary

Constructors
Constructor	Description
`EffectStack()`	Constructor that creates an empty stack of effects with default name.
`EffectStack(String name)`	Default constructor.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getName()`	Gets the name of the effect.
`void`	`setName(String name)`	Sets the name of the effect.
`void`	`setVisibility(boolean visibility)`	Sets the visibility of the effect.
`<T> Queue<DrawCommand<P>>`	`computeDrawCommands(Environment<T, P> environment)`	Computes a queue of commands to Draw something.
`EffectFX<P>`	`push(EffectFX<P> effect)`	Puts the effects in the group, giving it the maximum priority.
`EffectFX<P>`	`pop()`	Removes the effect with maximum priority and returns it.
`int`	`search(EffectFX<P> effect)`	Checks if an effect is present in the group.
`boolean`	`getVisibilityOf(EffectFX<P> effect)`	Returns the visibility of the specified effect.
`void`	`setVisibilityOf(EffectFX<P> effect, boolean visibility)`	Sets the visibility of the specified effect.
`void`	`changePriority(EffectFX<P> effect, int offset)`	Changes the specified offset priority of the specified offset.
`boolean`	`isVisible()`	Gets the visibility of the effect.
`Iterator<EffectFX<P>>`	`iterator()`
`int`	`size()`
`boolean`	`contains(Object o)`
`Array<Object>`	`toArray()`
`<T> Array<T>`	`toArray(Array<T> a)`
`boolean`	`add(EffectFX<P> e)`
`boolean`	`remove(Object o)`
`EffectFX<P>`	`remove()`
`boolean`	`containsAll(Collection<out Object> c)`
`boolean`	`addAll(Collection<out EffectFX<P>> c)`
`boolean`	`removeAll(Collection<out Object> c)`
`boolean`	`retainAll(Collection<out Object> c)`
`void`	`clear()`
`boolean`	`offer(EffectFX<P> e)`
`EffectFX<P>`	`poll()`
`EffectFX<P>`	`peek()`	Returns the effect with maximum priority, without removing it.
`EffectFX<P>`	`element()`
`boolean`	`isEmpty()`
`int`	`hashCode()`
`boolean`	`equals(Object obj)`
`static EffectGroupAdapter`	`getTypeAdapter()`	Returns a com.google.gson.JsonSerializer and com.google.gson.JsonDeserializer combo class to be used as a `TypeAdapter` for this `EffectStack`.

Methods inherited from class java.util.Collection
parallelStream, removeIf, spliterator, stream
Methods inherited from class java.lang.Iterable
forEach, iterator, spliterator
Methods inherited from class it.unibo.alchemist.boundary.gui.effects.EffectFX
setName, setVisibility
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - EffectStack
```
EffectStack()
```
 Constructor that creates an empty stack of effects with default name.
 - EffectStack
```
EffectStack(String name)
```
 Default constructor.
 
 Parameters:
 
 name - the name of the group
- Method Detail
 - getName
```
 String getName()
```
 Gets the name of the effect.
 - setName
```
 void setName(String name)
```
 Sets the name of the effect.
 
 Parameters:
 
 name - the name of the effect to set
 - setVisibility
```
 void setVisibility(boolean visibility)
```
 Sets the visibility of the effect.
 
 Parameters:
 
 visibility - the visibility of the effect to set
 - computeDrawCommands
```
 <T> Queue<DrawCommand> computeDrawCommands(Environment<T, P> environment)
```
 Computes a queue of commands to Draw something.
 
 Parameters:
 
 environment - the environment to gather data from
 - push
```
 EffectFX push(EffectFX effect)
```
 Puts the effects in the group, giving it the maximum priority.
 Acts nearly the same than using add or offer.
 
 Parameters:
 
 effect - the effect
 - pop
```
 EffectFX pop()
```
 Removes the effect with maximum priority and returns it.
 Acts nearly the same than using remove or poll.
 - search
```
 int search(EffectFX effect)
```
 Checks if an effect is present in the group.
 
 Parameters:
 
 effect - the effect to search
 - getVisibilityOf
```
 boolean getVisibilityOf(EffectFX effect)
```
 Returns the visibility of the specified effect.
 
 Parameters:
 
 effect - the effect
 - setVisibilityOf
```
 void setVisibilityOf(EffectFX effect, boolean visibility)
```
 Sets the visibility of the specified effect.
 
 Parameters:
 
 effect - the effect
 
 visibility - the visibility to set
 - changePriority
```
 void changePriority(EffectFX effect, int offset)
```
 Changes the specified offset priority of the specified offset.
 
 Parameters:
 
 effect - the effect
 
 offset - the offset; it can be positive or negative
 - isVisible
```
 boolean isVisible()
```
 Gets the visibility of the effect.
 - iterator
```
 Iterator<EffectFX> iterator()
```
 - size
```
 int size()
```
 - contains
```
 boolean contains(Object o)
```
 - toArray
```
@Nonnull() Array<Object> toArray()
```
 - toArray
```
@Nonnull() <T> Array<T> toArray(Array<T> a)
```
 - add
```
 boolean add(EffectFX e)
```
 - remove
```
 boolean remove(Object o)
```
 - remove
```
 EffectFX remove()
```
 - containsAll
```
 boolean containsAll(Collection<out Object> c)
```
 - addAll
```
 boolean addAll(Collection<out EffectFX> c)
```
 - removeAll
```
 boolean removeAll(Collection<out Object> c)
```
 - retainAll
```
 boolean retainAll(Collection<out Object> c)
```
 - clear
```
 void clear()
```
 - offer
```
 boolean offer(EffectFX e)
```
 - poll
```
 EffectFX poll()
```
 - peek
```
 EffectFX peek()
```
 Returns the effect with maximum priority, without removing it.
 See peek.
 - element
```
 EffectFX element()
```
 - isEmpty
```
 boolean isEmpty()
```
 - hashCode
```
 int hashCode()
```
 - equals
```
 boolean equals(Object obj)
```
 - getTypeAdapter
```
@Nonnull() static EffectGroupAdapter getTypeAdapter()
```
 Returns a com.google.gson.JsonSerializer and com.google.gson.JsonDeserializer combo class to be used as a TypeAdapter for this EffectStack.

Class EffectStack

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.util.Collection

Methods inherited from class java.lang.Iterable

Methods inherited from class it.unibo.alchemist.boundary.gui.effects.EffectFX

Methods inherited from class java.lang.Object

Constructor Detail

EffectStack

EffectStack

Method Detail

getName

setName

setVisibility

computeDrawCommands

push

pop

search

getVisibilityOf

setVisibilityOf

changePriority

isVisible

iterator

size

contains

toArray

toArray

add

remove

remove

containsAll

addAll

removeAll

retainAll

clear

offer

poll

peek

element

isEmpty

hashCode

equals

getTypeAdapter