alchemist/it.unibo.alchemist.boundary.gui.effects/EffectStack

EffectStack

class EffectStack?> : 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.

Parameters

The position type

Constructors

EffectStack

open fun EffectStack()

Constructor that creates an empty stack of effects with default name.

EffectStack

open fun EffectStack(name: String)

Default constructor.

Functions

add

open fun add(e: EffectFX): Boolean

addAll

open fun addAll(c: Collection<out EffectFX>): Boolean

changePriority

open fun changePriority(effect: EffectFX, offset: Int)

Changes the specified offset priority of the specified offset.

clear

open fun clear()

computeDrawCommands

open fun <T> computeDrawCommands(environment: Environment<T, P>): Queue<DrawCommand>

Computes a queue of commands to Draw something.

contains

open fun contains(o: Any): Boolean

containsAll

open fun containsAll(c: Collection<out Any>): Boolean

element

open fun element(): EffectFX

equals

open fun equals(obj: Any): Boolean

forEach

open fun forEach(action: Consumer<out Any>)

getTypeAdapter

@Nonnull

open fun getTypeAdapter(): EffectGroupAdapter

Returns a com.google.gson.JsonSerializer and com.google.gson.JsonDeserializer combo class to be used as a TypeAdapter for this EffectStack.

getVisibilityOf

open fun getVisibilityOf(effect: EffectFX): Boolean

Returns the visibility of the specified effect.

hashCode

open fun hashCode(): Int

isEmpty

open fun isEmpty(): Boolean

isVisible

open fun isVisible(): Boolean

Gets the visibility of the effect.

iterator

open fun iterator(): Iterator<EffectFX>

abstract fun iterator(): Iterator<T>

offer

open fun offer(e: EffectFX): Boolean

parallelStream

open fun parallelStream(): Stream<E>

peek

open fun peek(): EffectFX

Returns the effect with maximum priority, without removing it.

poll

open fun poll(): EffectFX

pop

open fun pop(): EffectFX

Removes the effect with maximum priority and returns it.

push

open fun push(effect: EffectFX): EffectFX

Puts the effects in the group, giving it the maximum priority.

remove

open fun remove(): EffectFX

open fun remove(o: Any): Boolean

removeAll

open fun removeAll(c: Collection<out Any>): Boolean

removeIf

open fun removeIf(filter: Predicate<out Any>): Boolean

retainAll

open fun retainAll(c: Collection<out Any>): Boolean

open fun search(effect: EffectFX): Int

Checks if an effect is present in the group.

setName

abstract fun setName(name: String)

Sets the name of the effect.

setVisibility

abstract fun setVisibility(visibility: Boolean)

Sets the visibility of the effect.

setVisibilityOf

open fun setVisibilityOf(effect: EffectFX, visibility: Boolean)

Sets the visibility of the specified effect.

size

open fun size(): Int

spliterator

open fun spliterator(): Spliterator<T>

open fun spliterator(): Spliterator<E>

stream

open fun stream(): Stream<E>

toArray

@Nonnull

open fun toArray(): Array<Any>

@Nonnull

open fun <T> toArray(a: Array<T>): Array<T>

Properties

name

private open var name: String

visibility

private open var visibility: Boolean