org.distorted.library.effect

Class Effect

java.lang.Object

org.distorted.library.effect.Effect

Direct Known Subclasses:

FragmentEffect, MatrixEffect, PostprocessEffect, VertexEffect

public abstract class Effect
extends java.lang.Object

Abstract Effect of any type.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addQueue(org.distorted.library.effectqueue.EffectQueue queue)
static void	enableEffects(EffectType type) Enable all effects of a given type.
int	getCenterDimension() Return the dimension of the Center supported by this effect (0- no center supported at all).
int	getEffectDimension() Return the number of Uniforms needed to describe this effect.
long	getID() Return the unique ID of this Effect.
EffectName	getName() Return the EffectName enum corresponding to this Effect.
int	getRegionDimension() Return the dimension of the Region supported by this effect (0- no region supported at all).
java.lang.String	getString() Return a printable name of this Effect.
EffectType	getType() Return the EffectType enum corresponding to this Effect.
boolean	isUnity(float[] buffer, int index) Do the set of Uniforms written in buffer[index], buffer[index+1], etc represent a Unity, i.e a null Effect?
void	notifyWhenFinished(EffectListener el) Adds the calling class to the list of Listeners that get notified when this Effect gets 'finished' i.e.
abstract void	remQueue(org.distorted.library.effectqueue.EffectQueue queue)

Methods inherited from class java.lang.Object

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

Method Detail

addQueue

public abstract void addQueue(org.distorted.library.effectqueue.EffectQueue queue)

remQueue

public abstract void remQueue(org.distorted.library.effectqueue.EffectQueue queue)

isUnity

public boolean isUnity(float[] buffer,
              int index)

Do the set of Uniforms written in buffer[index], buffer[index+1], etc represent a Unity, i.e a null Effect?

enableEffects

public static void enableEffects(EffectType type)

Enable all effects of a given type.

Parameters:

type - EffectType to enable.

getType

public EffectType getType()

Return the EffectType enum corresponding to this Effect.

See Also:

EffectType

getName

public EffectName getName()

Return the EffectName enum corresponding to this Effect.

See Also:

EffectName

getID

public long getID()

Return the unique ID of this Effect.

getString

public java.lang.String getString()

Return a printable name of this Effect.

getCenterDimension

public int getCenterDimension()

Return the dimension of the Center supported by this effect (0- no center supported at all).

getRegionDimension

public int getRegionDimension()

Return the dimension of the Region supported by this effect (0- no region supported at all).

getEffectDimension

public int getEffectDimension()

Return the number of Uniforms needed to describe this effect.

notifyWhenFinished

public void notifyWhenFinished(EffectListener el)

Adds the calling class to the list of Listeners that get notified when this Effect gets 'finished' i.e. when the Dynamic inside this Effect reaches its final point and stops moving. This will be sent only once, on the first time the Dynamic reaches its final point. If there's no Dynamic, ths message will never be sent.

Parameters:

el - A class implementing the EffectListener interface that wants to get notifications.