org.distorted.library.main

Class DistortedEffects

java.lang.Object

org.distorted.library.main.DistortedEffects

public class DistortedEffects
extends java.lang.Object

Class containing Matrix, Vertex, Fragment and Postprocessing effect queues.

The queues hold actual effects to be applied to a given (InputSurface,MeshBase) combo.

Constructor Summary

Constructors

Constructor and Description
DistortedEffects() Create empty effect queue.
DistortedEffects(DistortedEffects dc, int flags) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	abortAllEffects() Aborts all Effects.
int	abortById(long id) Aborts an Effect by its ID.
int	abortByName(EffectName name) Abort all Effects of a given name, for example all rotations.
int	abortByType(EffectType type) Aborts all Effects of a given type, for example all MATRIX Effects.
int	abortEffect(Effect effect) Aborts a single Effect.
boolean	apply(Effect effect) Add a new Effect to the tail of our queue.
boolean	apply(Effect effect, int position) Add a new Effect to our queue at a specified position.
boolean	exists(long id) Return if this queue contains effect with a given ID.
long	getID() Returns unique ID of this instance.
int	getNumEffects(EffectType type) Return number of effects of the given type currently in the Queue.
void	markForDeletion() Mark the underlying OpenGL object for deletion.

Methods inherited from class java.lang.Object

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

Constructor Detail

DistortedEffects

public DistortedEffects()

Create empty effect queue.

DistortedEffects

public DistortedEffects(DistortedEffects dc,
                int flags)

Copy constructor.

Whatever we do not clone gets created just like in the default constructor.

Parameters:

dc - Source object to create our object from

flags - A bitmask of values specifying what to copy. For example, CLONE_VERTEX | CLONE_MATRIX.

Method Detail

getID

public long getID()

Returns unique ID of this instance.

Returns:

ID of the object.

exists

public boolean exists(long id)

Return if this queue contains effect with a given ID.

abortAllEffects

public int abortAllEffects()

Aborts all Effects.

Returns:

Number of effects aborted.

abortByType

public int abortByType(EffectType type)

Aborts all Effects of a given type, for example all MATRIX Effects.

Parameters:

type - one of the constants defined in EffectType

Returns:

Number of effects aborted.

abortById

public int abortById(long id)

Aborts an Effect by its ID.

Parameters:

id - the Id of the Effect to be removed, as returned by getID().

Returns:

Number of effects aborted.

abortEffect

public int abortEffect(Effect effect)

Aborts a single Effect.

Parameters:

effect - the Effect we want to abort.

Returns:

number of Effects aborted. Always either 0 or 1.

abortByName

public int abortByName(EffectName name)

Abort all Effects of a given name, for example all rotations.

Parameters:

name - one of the constants defined in EffectName

Returns:

number of Effects aborted.

apply

public boolean apply(Effect effect)

Add a new Effect to the tail of our queue.

Parameters:

effect - The Effect to add.

Returns:

true if operation was successful, false otherwise.

apply

public boolean apply(Effect effect,
            int position)

Add a new Effect to our queue at a specified position.

Parameters:

effect - The Effect to add.

position - the place in the effects queue where to add the new effect.

Returns:

true if operation was successful, false otherwise.

markForDeletion

public void markForDeletion()

Mark the underlying OpenGL object for deletion. Actual deletion will take place on the next render.

getNumEffects

public int getNumEffects(EffectType type)

Return number of effects of the given type currently in the Queue.

Parameters:

type - The EffectType.

Returns:

Number of effects of the given type currently in the Queue.