Distorted Android

///////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright 2016 Leszek Koltunski                                                               //

//                                                                                               //

// This file is part of Distorted.                                                               //

//                                                                                               //

// Distorted is free software: you can redistribute it and/or modify                             //

// it under the terms of the GNU General Public License as published by                          //

// the Free Software Foundation, either version 2 of the License, or                             //

// (at your option) any later version.                                                           //

//                                                                                               //

// Distorted is distributed in the hope that it will be useful,                                  //

// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //

// GNU General Public License for more details.                                                  //

//                                                                                               //

// You should have received a copy of the GNU General Public License                             //

// along with Distorted.  If not, see <http://www.gnu.org/licenses/>.                            //

///////////////////////////////////////////////////////////////////////////////////////////////////

package org.distorted.library;

import android.opengl.GLES20;

import org.distorted.library.message.EffectListener;

import org.distorted.library.type.Data1D;

import org.distorted.library.type.Data2D;

import org.distorted.library.type.Data3D;

import org.distorted.library.type.Data4D;

import org.distorted.library.type.Data5D;

import org.distorted.library.type.Static3D;

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Class containing {@link EffectTypes#LENGTH} queues, each a class derived from EffectQueue.

 * <p>

 * The queues hold actual effects to be applied to a given (DistortedTexture,GridObject) combo.

 */

public class DistortedEffectQueues

  {

  private static long mNextID =0;

  private long mID;

  private EffectQueueMatrix    mM;

  private EffectQueueFragment  mF;

  private EffectQueueVertex    mV;

  private boolean matrixCloned, vertexCloned, fragmentCloned;

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void initializeEffectLists(DistortedEffectQueues d, int flags)

    {

    if( (flags & Distorted.CLONE_MATRIX) != 0 )

      {

      mM = d.mM;

      matrixCloned = true;

      }

    else

      {

      mM = new EffectQueueMatrix(mID);

      matrixCloned = false;

      }

    if( (flags & Distorted.CLONE_VERTEX) != 0 )

      {

      mV = d.mV;

      vertexCloned = true;

      }

    else

      {

      mV = new EffectQueueVertex(mID);

      vertexCloned = false;

      }

    if( (flags & Distorted.CLONE_FRAGMENT) != 0 )

      {

      mF = d.mF;

      fragmentCloned = true;

      }

    else

      {

      mF = new EffectQueueFragment(mID);

      fragmentCloned = false;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void drawPriv(long currTime, DistortedTexture tex, GridObject grid, DistortedFramebuffer df)

    {

    DistortedFramebuffer.deleteAllMarked();

    GLES20.glViewport(0, 0, df.mWidth, df.mHeight);

    mM.compute(currTime);

    mM.send(df,tex.mHalfX,tex.mHalfY,tex.mHalfZ);

    mV.compute(currTime);

    mV.send(tex.mHalfX,tex.mHalfY,tex.mHalfZ);

    mF.compute(currTime);

    mF.send(tex.mHalfX,tex.mHalfY);

    grid.draw();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void drawNoEffectsPriv(DistortedTexture tex, GridObject grid, DistortedFramebuffer df)

    {

    GLES20.glViewport(0, 0, df.mWidth, df.mHeight);

    mM.sendZero(df,tex.mHalfX,tex.mHalfY,tex.mHalfZ);

    mV.sendZero();

    mF.sendZero();

    grid.draw();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void releasePriv()

    {

    if( !matrixCloned  ) mM.abortAll(false);

    if( !vertexCloned  ) mV.abortAll(false);

    if( !fragmentCloned) mF.abortAll(false);

    mM = null;

    mV = null;

    mF = null;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// PUBLIC API

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Create empty effect queue.

 */

  public DistortedEffectQueues()

    {

    mID = mNextID++;

    initializeEffectLists(this,0);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Copy constructor.

 * <p>

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

 * We only call this from the descendant's classes' constructors where we have to pay attention

 * to give it the appropriate type of a DistortedObject!

 *

 * @param dc    Source object to create our object from

 * @param flags A bitmask of values specifying what to copy.

 *              For example, CLONE_VERTEX | CLONE_MATRIX.

 */

  public DistortedEffectQueues(DistortedEffectQueues dc, int flags)

    {

    mID = mNextID++;

    initializeEffectLists(dc,flags);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Draw the DistortedObject to the location specified by current Matrix effects.    

 *     

 * @param currTime current time, in milliseconds.

 *        This gets passed on to Dynamics inside the Effects that are currently applied to the

 *        Object.

 */

  public void draw(long currTime, DistortedTexture tex, GridObject grid)

    {

    GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, 0);

    GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, tex.mTextureDataH[0]);

    drawPriv(currTime, tex, grid, Distorted.mFramebuffer);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Draw the DistortedObject to the Framebuffer passed.

 *

 * @param currTime Current time, in milliseconds.

 * @param df       Framebuffer to render this to.

 */

  public void draw(long currTime, DistortedTexture tex, GridObject grid, DistortedFramebuffer df)

    {

    df.setAsOutput();

    GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, tex.mTextureDataH[0]);

    drawPriv(currTime, tex, grid, df);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Releases all resources.

 */

  public synchronized void delete()

    {

    releasePriv();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Returns unique ID of this instance.

 *

 * @return ID of the object.

 */

  public long getID()

      {

      return mID;

      }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Adds the calling class to the list of Listeners that get notified each time some event happens 

 * to one of the Effects that are currently applied to the DistortedObject.

 * 

 * @param el A class implementing the EffectListener interface that wants to get notifications.

 */

  public void addEventListener(EffectListener el)

    {

    mV.addListener(el);

    mF.addListener(el);

    mM.addListener(el);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Removes the calling class from the list of Listeners.

 * 

 * @param el A class implementing the EffectListener interface that no longer wants to get notifications.

 */

  public void removeEventListener(EffectListener el)

    {

    mV.removeListener(el);

    mF.removeListener(el);

    mM.removeListener(el);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Aborts all Effects.

 * @return Number of effects aborted.

 */

  public int abortAllEffects()

      {

      return mM.abortAll(true) + mV.abortAll(true) + mF.abortAll(true);

      }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

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

 * 

 * @param type one of the constants defined in {@link EffectTypes}

 * @return Number of effects aborted.

 */

  public int abortEffects(EffectTypes type)

    {

    switch(type)

      {

      case MATRIX  : return mM.abortAll(true);

      case VERTEX  : return mV.abortAll(true);

      case FRAGMENT: return mF.abortAll(true);

      default      : return 0;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Aborts a single Effect.

 * 

 * @param id ID of the Effect we want to abort.

 * @return number of Effects aborted. Always either 0 or 1.

 */

  public int abortEffect(long id)

    {

    int type = (int)(id&EffectTypes.MASK);

    if( type==EffectTypes.MATRIX.type   ) return mM.removeByID(id>>EffectTypes.LENGTH);

    if( type==EffectTypes.VERTEX.type   ) return mV.removeByID(id>>EffectTypes.LENGTH);

    if( type==EffectTypes.FRAGMENT.type ) return mF.removeByID(id>>EffectTypes.LENGTH);

    return 0;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

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

 * 

 * @param name one of the constants defined in {@link EffectNames}

 * @return number of Effects aborted.

 */

  public int abortEffects(EffectNames name)

    {

    switch(name.getType())

      {

      case MATRIX  : return mM.removeByType(name);

      case VERTEX  : return mV.removeByType(name);

      case FRAGMENT: return mF.removeByType(name);

      default      : return 0;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Print some info about a given Effect to Android's standard out. Used for debugging only.

 * 

 * @param id Effect ID we want to print info about

 * @return <code>true</code> if a single Effect of type effectType has been found.

 */

  public boolean printEffect(long id)

    {

    int type = (int)(id&EffectTypes.MASK);

    if( type==EffectTypes.MATRIX.type   )  return mM.printByID(id>>EffectTypes.LENGTH);

    if( type==EffectTypes.VERTEX.type   )  return mV.printByID(id>>EffectTypes.LENGTH);

    if( type==EffectTypes.FRAGMENT.type )  return mF.printByID(id>>EffectTypes.LENGTH);

    return false;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////   

///////////////////////////////////////////////////////////////////////////////////////////////////

// Individual effect functions.

///////////////////////////////////////////////////////////////////////////////////////////////////

// Matrix-based effects

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Moves the Object by a (possibly changing in time) vector.

 * 

 * @param vector 3-dimensional Data which at any given time will return a Static3D

 *               representing the current coordinates of the vector we want to move the Object with.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long move(Data3D vector)

    {   

    return mM.add(EffectNames.MOVE,vector);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Scales the Object by (possibly changing in time) 3D scale factors.

 * 

 * @param scale 3-dimensional Data which at any given time returns a Static3D

 *              representing the current x- , y- and z- scale factors.

 * @return      ID of the effect added, or -1 if we failed to add one.

 */

  public long scale(Data3D scale)

    {   

    return mM.add(EffectNames.SCALE,scale);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Scales the Object by one uniform, constant factor in all 3 dimensions. Convenience function.

 *

 * @param scale The factor to scale all 3 dimensions with.

 * @return      ID of the effect added, or -1 if we failed to add one.

 */

  public long scale(float scale)

    {

    return mM.add(EffectNames.SCALE, new Static3D(scale,scale,scale));

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Rotates the Object by 'angle' degrees around the center.

 * Static axis of rotation is given by the last parameter.

 *

 * @param angle  Angle that we want to rotate the Object to. Unit: degrees

 * @param axis   Axis of rotation

 * @param center Coordinates of the Point we are rotating around.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long rotate(Data1D angle, Static3D axis, Data3D center )

    {   

    return mM.add(EffectNames.ROTATE, angle, axis, center);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Rotates the Object by 'angle' degrees around the center.

 * Here both angle and axis can dynamically change.

 *

 * @param angleaxis Combined 4-tuple representing the (angle,axisX,axisY,axisZ).

 * @param center    Coordinates of the Point we are rotating around.

 * @return          ID of the effect added, or -1 if we failed to add one.

 */

  public long rotate(Data4D angleaxis, Data3D center)

    {

    return mM.add(EffectNames.ROTATE, angleaxis, center);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Rotates the Object by quaternion.

 *

 * @param quaternion The quaternion describing the rotation.

 * @param center     Coordinates of the Point we are rotating around.

 * @return           ID of the effect added, or -1 if we failed to add one.

 */

  public long quaternion(Data4D quaternion, Data3D center )

    {

    return mM.add(EffectNames.QUATERNION,quaternion,center);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Shears the Object.

 *

 * @param shear   The 3-tuple of shear factors. The first controls level

 *                of shearing in the X-axis, second - Y-axis and the third -

 *                Z-axis. Each is the tangens of the shear angle, i.e 0 -

 *                no shear, 1 - shear by 45 degrees (tan(45deg)=1) etc.

 * @param center  Center of shearing, i.e. the point which stays unmoved.

 * @return        ID of the effect added, or -1 if we failed to add one.

 */

  public long shear(Data3D shear, Data3D center)

    {

    return mM.add(EffectNames.SHEAR, shear, center);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// Fragment-based effects  

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes a certain sub-region of the Object smoothly change all three of its RGB components.

 *        

 * @param blend  1-dimensional Data that returns the level of blend a given pixel will be

 *               mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color.

 *               Valid range: <0,1>

 * @param color  Color to mix. (1,0,0) is RED.

 * @param region Region this Effect is limited to.

 * @param smooth If true, the level of 'blend' will smoothly fade out towards the edges of the region.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long chroma(Data1D blend, Data3D color, Data4D region, boolean smooth)

    {

    return mF.add( smooth? EffectNames.SMOOTH_CHROMA:EffectNames.CHROMA, blend, color, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes the whole Object smoothly change all three of its RGB components.

 *

 * @param blend  1-dimensional Data that returns the level of blend a given pixel will be

 *               mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color.

 *               Valid range: <0,1>

 * @param color  Color to mix. (1,0,0) is RED.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long chroma(Data1D blend, Data3D color)

    {

    return mF.add(EffectNames.CHROMA, blend, color);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes a certain sub-region of the Object smoothly change its transparency level.

 *        

 * @param alpha  1-dimensional Data that returns the level of transparency we want to have at any given

 *               moment: pixel.a *= alpha.

 *               Valid range: <0,1>

 * @param region Region this Effect is limited to. 

 * @param smooth If true, the level of 'alpha' will smoothly fade out towards the edges of the region.

 * @return       ID of the effect added, or -1 if we failed to add one. 

 */

  public long alpha(Data1D alpha, Data4D region, boolean smooth)

    {

    return mF.add( smooth? EffectNames.SMOOTH_ALPHA:EffectNames.ALPHA, alpha, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes the whole Object smoothly change its transparency level.

 *

 * @param alpha  1-dimensional Data that returns the level of transparency we want to have at any

 *               given moment: pixel.a *= alpha.

 *               Valid range: <0,1>

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long alpha(Data1D alpha)

    {

    return mF.add(EffectNames.ALPHA, alpha);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes a certain sub-region of the Object smoothly change its brightness level.

 *        

 * @param brightness 1-dimensional Data that returns the level of brightness we want to have

 *                   at any given moment. Valid range: <0,infinity)

 * @param region     Region this Effect is limited to.

 * @param smooth     If true, the level of 'brightness' will smoothly fade out towards the edges of the region.

 * @return           ID of the effect added, or -1 if we failed to add one.

 */

  public long brightness(Data1D brightness, Data4D region, boolean smooth)

    {

    return mF.add( smooth ? EffectNames.SMOOTH_BRIGHTNESS: EffectNames.BRIGHTNESS, brightness, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes the whole Object smoothly change its brightness level.

 *

 * @param brightness 1-dimensional Data that returns the level of brightness we want to have

 *                   at any given moment. Valid range: <0,infinity)

 * @return           ID of the effect added, or -1 if we failed to add one.

 */

  public long brightness(Data1D brightness)

    {

    return mF.add(EffectNames.BRIGHTNESS, brightness);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes a certain sub-region of the Object smoothly change its contrast level.

 *        

 * @param contrast 1-dimensional Data that returns the level of contrast we want to have

 *                 at any given moment. Valid range: <0,infinity)

 * @param region   Region this Effect is limited to.

 * @param smooth   If true, the level of 'contrast' will smoothly fade out towards the edges of the region.

 * @return         ID of the effect added, or -1 if we failed to add one.

 */

  public long contrast(Data1D contrast, Data4D region, boolean smooth)

    {

    return mF.add( smooth ? EffectNames.SMOOTH_CONTRAST:EffectNames.CONTRAST, contrast, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes the whole Object smoothly change its contrast level.

 *

 * @param contrast 1-dimensional Data that returns the level of contrast we want to have

 *                 at any given moment. Valid range: <0,infinity)

 * @return         ID of the effect added, or -1 if we failed to add one.

 */

  public long contrast(Data1D contrast)

    {

    return mF.add(EffectNames.CONTRAST, contrast);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes a certain sub-region of the Object smoothly change its saturation level.

 *        

 * @param saturation 1-dimensional Data that returns the level of saturation we want to have

 *                   at any given moment. Valid range: <0,infinity)

 * @param region     Region this Effect is limited to.

 * @param smooth     If true, the level of 'saturation' will smoothly fade out towards the edges of the region.

 * @return           ID of the effect added, or -1 if we failed to add one.

 */

  public long saturation(Data1D saturation, Data4D region, boolean smooth)

    {

    return mF.add( smooth ? EffectNames.SMOOTH_SATURATION:EffectNames.SATURATION, saturation, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Makes the whole Object smoothly change its saturation level.

 *

 * @param saturation 1-dimensional Data that returns the level of saturation we want to have

 *                   at any given moment. Valid range: <0,infinity)

 * @return           ID of the effect added, or -1 if we failed to add one.

 */

  public long saturation(Data1D saturation)

    {

    return mF.add(EffectNames.SATURATION, saturation);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// Vertex-based effects  

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Distort a (possibly changing in time) part of the Object by a (possibly changing in time) vector of force.

 *

 * @param vector 3-dimensional Vector which represents the force the Center of the Effect is

 *               currently being dragged with.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @param region Region that masks the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long distort(Data3D vector, Data3D center, Data4D region)

    {  

    return mV.add(EffectNames.DISTORT, vector, center, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Distort the whole Object by a (possibly changing in time) vector of force.

 *

 * @param vector 3-dimensional Vector which represents the force the Center of the Effect is

 *               currently being dragged with.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long distort(Data3D vector, Data3D center)

    {

    return mV.add(EffectNames.DISTORT, vector, center, null);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to

 * a (possibly changing in time) point on the Object.

 *

 * @param vector Vector of force that deforms the shape of the whole Object.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @param region Region that masks the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long deform(Data3D vector, Data3D center, Data4D region)

    {

    return mV.add(EffectNames.DEFORM, vector, center, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to

 * a (possibly changing in time) point on the Object.

 *     

 * @param vector Vector of force that deforms the shape of the whole Object.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long deform(Data3D vector, Data3D center)

    {  

    return mV.add(EffectNames.DEFORM, vector, center, null);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////  

/**

 * Pull all points around the center of the Effect towards the center (if degree>=1) or push them

 * away from the center (degree<=1)

 *

 * @param sink   The current degree of the Effect.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @param region Region that masks the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long sink(Data1D sink, Data3D center, Data4D region)

    {

    return mV.add(EffectNames.SINK, sink, center, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Pull all points around the center of the Effect towards the center (if degree>=1) or push them

 * away from the center (degree<=1)

 *

 * @param sink   The current degree of the Effect.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long sink(Data1D sink, Data3D center)

    {

    return mV.add(EffectNames.SINK, sink, center);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Pull all points around the center of the Effect towards a line passing through the center

 * (that's if degree>=1) or push them away from the line (degree<=1)

 *

 * @param pinch  The current degree of the Effect + angle the line forms with X-axis

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @param region Region that masks the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long pinch(Data2D pinch, Data3D center, Data4D region)

    {

    return mV.add(EffectNames.PINCH, pinch, center, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Pull all points around the center of the Effect towards a line passing through the center

 * (that's if degree>=1) or push them away from the line (degree<=1)

 *

 * @param pinch  The current degree of the Effect + angle the line forms with X-axis

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long pinch(Data2D pinch, Data3D center)

    {

    return mV.add(EffectNames.PINCH, pinch, center);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////  

/**

 * Rotate part of the Object around the Center of the Effect by a certain angle.

 *

 * @param swirl  The angle of Swirl (in degrees). Positive values swirl clockwise.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @param region Region that masks the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long swirl(Data1D swirl, Data3D center, Data4D region)

    {    

    return mV.add(EffectNames.SWIRL, swirl, center, region);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Rotate the whole Object around the Center of the Effect by a certain angle.

 *

 * @param swirl  The angle of Swirl (in degrees). Positive values swirl clockwise.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long swirl(Data1D swirl, Data3D center)

    {

    return mV.add(EffectNames.SWIRL, swirl, center);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Directional, sinusoidal wave effect.

 *

 * @param wave   A 5-dimensional data structure describing the wave: first member is the amplitude,

 *               second is the wave length, third is the phase (i.e. when phase = PI/2, the sine

 *               wave at the center does not start from sin(0), but from sin(PI/2) ) and the next two

 *               describe the 'direction' of the wave.

 *               <p>

 *               Wave direction is defined to be a 3D vector of length 1. To define such vectors, we

 *               need 2 floats: thus the third member is the angle Alpha (in degrees) which the vector

 *               forms with the XY-plane, and the fourth is the angle Beta (again in degrees) which

 *               the projection of the vector to the XY-plane forms with the Y-axis (counterclockwise).

 *               <p>

 *               <p>

 *               Example1: if Alpha = 90, Beta = 90, (then V=(0,0,1) ) and the wave acts 'vertically'

 *               in the X-direction, i.e. cross-sections of the resulting surface with the XZ-plane

 *               will be sine shapes.

 *               <p>

 *               Example2: if Alpha = 90, Beta = 0, the again V=(0,0,1) and the wave is 'vertical',

 *               but this time it waves in the Y-direction, i.e. cross sections of the surface and the

 *               YZ-plane with be sine shapes.

 *               <p>

 *               Example3: if Alpha = 0 and Beta = 45, then V=(sqrt(2)/2, -sqrt(2)/2, 0) and the wave

 *               is entirely 'horizontal' and moves point (x,y,0) in direction V by whatever is the

 *               value if sin at this point.

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long wave(Data5D wave, Data3D center)

    {

    return mV.add(EffectNames.WAVE, wave, center, null);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Directional, sinusoidal wave effect.

 *

 * @param wave   see {@link DistortedObject#wave(Data5D,Data3D)}

 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.

 * @param region Region that masks the Effect.

 * @return       ID of the effect added, or -1 if we failed to add one.

 */

  public long wave(Data5D wave, Data3D center, Data4D region)

    {

    return mV.add(EffectNames.WAVE, wave, center, region);

    }

  }