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.graphics.Bitmap;

import android.opengl.GLES20;

import android.opengl.GLUtils;

import org.distorted.library.message.EffectListener;

import org.distorted.library.type.Data1D;

import org.distorted.library.type.Data3D;

import org.distorted.library.type.Data4D;

import org.distorted.library.type.Dynamic;

import org.distorted.library.type.Dynamic1D;

import org.distorted.library.type.Dynamic2D;

import org.distorted.library.type.Dynamic3D;

import org.distorted.library.type.Dynamic4D;

import org.distorted.library.type.Static1D;

import org.distorted.library.type.Static2D;

import org.distorted.library.type.Static3D;

import org.distorted.library.type.Static4D;

import org.distorted.library.type.DynamicQuat;

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

/**

 * All Objects to which Distorted Graphics effects can be applied need to be extended from here.

 */

public abstract class DistortedObject 

{

    private static final Static2D mZero2D = new Static2D(0,0);

    private static final Static3D mZero3D = new Static3D(0,0,0);

    private static float[] mViewMatrix   = new float[16];

    protected EffectQueueMatrix    mM;

    protected EffectQueueFragment  mF;

    protected EffectQueueVertex    mV;

    protected boolean matrixCloned, vertexCloned, fragmentCloned;

    protected DistortedObjectGrid mGrid = null;

    protected long mID;

    protected int mSizeX, mSizeY, mSizeZ, mSize; // in screen space

    protected Bitmap[] mBmp= null; // 

    int[] mTextureDataH;           // have to be shared among all the cloned Objects

    boolean[] mBitmapSet;          // 

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

    protected abstract DistortedObject deepCopy(int flags);

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

    protected void initializeData(int size)

      {

      mID             = DistortedObjectList.add(this);

      mSize           = size;

      mTextureDataH   = new int[1];

      mTextureDataH[0]= 0;

      mBmp            = new Bitmap[1];

      mBmp[0]         = null;

      mBitmapSet      = new boolean[1];

      mBitmapSet[0]   = false;

      initializeEffectLists(this,0);

      if( Distorted.isInitialized() ) resetTexture();    

      }

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

    protected void initializeEffectLists(DistortedObject d, int flags)

      {

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

        {

        mM = d.mM;

        matrixCloned = true;

        } 

      else

        {

        mM = new EffectQueueMatrix(d);

        matrixCloned = false;  

        }

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

        {

        mV = d.mV;

        vertexCloned = true;

        } 

      else

        {

        mV = new EffectQueueVertex(d);

        vertexCloned = false;  

        }

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

        {

        mF = d.mF;

        fragmentCloned = true;

        } 

      else

        {

        mF = new EffectQueueFragment(d);

        fragmentCloned = false;   

        }

      }

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

// this will be called on startup and every time OpenGL context has been lost

// also call this from the constructor if the OpenGL context has been created already.

    void resetTexture()

      {

      if( mTextureDataH!=null ) 

        {

        if( mTextureDataH[0]==0 ) GLES20.glGenTextures(1, mTextureDataH, 0);

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

        GLES20.glTexParameteri ( GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_MIN_FILTER, GLES20.GL_LINEAR );

        GLES20.glTexParameteri ( GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_MAG_FILTER, GLES20.GL_LINEAR );

        GLES20.glTexParameteri ( GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_WRAP_S, GLES20.GL_CLAMP_TO_EDGE );

        GLES20.glTexParameteri ( GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_WRAP_T, GLES20.GL_CLAMP_TO_EDGE );

        if( mBmp!=null && mBmp[0]!=null)

          {

          GLUtils.texImage2D(GLES20.GL_TEXTURE_2D, 0, mBmp[0], 0);

          mBmp[0] = null;

          }

        }

      }

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

    void drawPriv(long currTime, DistortedProjection dp)

      {

      GLES20.glViewport(0, 0, dp.width, dp.height); 

      mM.compute(currTime);

      mM.send(mViewMatrix, dp);

      mV.compute(currTime);

      mV.postprocess();

      mV.send();

      mF.compute(currTime);

      mF.postprocess(mViewMatrix);

      mF.send();

      mGrid.draw();

      }

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

    void drawNoEffectsPriv(DistortedProjection dp)

      {

      GLES20.glViewport(0, 0, dp.width, dp.height);

      mM.sendNoEffects(dp);

      mV.sendZero();

      mF.sendZero();

      mGrid.draw();

      }

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

    void releasePriv()

      {

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

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

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

      mBmp          = null;

      mGrid         = null;

      mM            = null;

      mV            = null;

      mF            = null;

      mTextureDataH = null;

      }

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

    long getBitmapID()

      {

      return mBmp==null ? 0 : mBmp.hashCode();

      }

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

  /**

   * Default empty constructor so that derived classes can call it

   */

    public DistortedObject()

      {

      }

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

  /**

   * Copy constructor used to create a DistortedObject based on various parts of another object.

   * <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_BITMAP | CLONE_MATRIX.

   */

    public DistortedObject(DistortedObject dc, int flags)

      {

      initializeEffectLists(dc,flags);

      mID = DistortedObjectList.add(this);

      mSizeX = dc.mSizeX;

      mSizeY = dc.mSizeY;

      mSizeZ = dc.mSizeZ;

      mSize  = dc.mSize;

      mGrid  = dc.mGrid;

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

        {

        mTextureDataH = dc.mTextureDataH;

        mBmp          = dc.mBmp;

        mBitmapSet    = dc.mBitmapSet;

        }

      else

        {

        mTextureDataH   = new int[1];

        mTextureDataH[0]= 0;

        mBitmapSet      = new boolean[1];

        mBitmapSet[0]   = false;

        mBmp            = new Bitmap[1];

        mBmp[0]         = null;

        if( Distorted.isInitialized() ) resetTexture();

        }

      }

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

/**

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

 *     

 * @param currTime current time, in milliseconds, as returned by System.currentTimeMillis().

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

 *        Object.

 */

   public void draw(long currTime)

     {

     GLES20.glActiveTexture(GLES20.GL_TEXTURE0);

     GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, 0);

     GLES20.glUniform1i(Distorted.mTextureUniformH, 0);  

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

     drawPriv(currTime, Distorted.mProjection);

     }

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

/**

 * Releases all resources.

 */

   public synchronized void release()

     {

     releasePriv();  

     DistortedObjectList.remove(this);

     }

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

/**

 * Sets the underlying android.graphics.Bitmap object and uploads it to the GPU. 

 * <p>

 * You can only recycle() the passed Bitmap once the OpenGL context gets created (i.e. after call 

 * to onSurfaceCreated) because only after this point can the Library upload it to the GPU!

 * 

 * @param bmp The android.graphics.Bitmap object to apply effects to and display.

 */

   public void setBitmap(Bitmap bmp)

     {

     mBitmapSet[0] = true; 

     if( Distorted.isInitialized() )

       {

       GLES20.glActiveTexture(GLES20.GL_TEXTURE0);

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

       GLUtils.texImage2D(GLES20.GL_TEXTURE_2D, 0, bmp, 0);

       }

     else

       {

       mBmp[0] = bmp;  

       }

     }

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

/**

 * 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);

     }

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

/**

 * Returns the height of the DistortedObject.

 *    

 * @return height of the object, in pixels.

 */

   public int getWidth()

     {

     return mSizeX;   

     }

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

/**

 * Returns the width of the DistortedObject.

 * 

 * @return width of the Object, in pixels.

 */

    public int getHeight()

      {

      return mSizeY;  

      }

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

/**

 * Returns the depth of the DistortedObject.

 * 

 * @return depth of the Object, in pixels.

 */

    public int getDepth()

      {

      return mSizeZ;  

      }

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

/**

 * Returns unique ID of this instance.

 * 

 * @return ID of the object.

 */

    public long getID()

      {

      return mID;  

      }

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

/**

 * Aborts all Effects.

 * @return Number of effects aborted.

 */

    public int abortAllEffects()

      {

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

      }

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

/**

 * 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();

        case VERTEX  : return mV.abortAll();

        case FRAGMENT: return mF.abortAll();

        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 type, 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 vector that changes in time as interpolated by the Dynamic.

 * 

 * @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 factors that change in time as returned by the Dynamic.

 * 

 * @param scale 3-dimensional Dynamic 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 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 center Coordinates of the Point we are rotating around.

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

 * @param axis   Axis of rotation

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

 */

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

    {   

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

    }

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

/**

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

 * Here both angle and axis can dynamically change.

 *

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

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

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

 */

  public long rotate(Data3D center, Data4D angleaxis)

    {

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

    }

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

/**

 * Rotates the Object by quaternion.

 *   

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

 * @param quaternion The quaternion describing the rotation.

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

 */

  public long quaternion(Data3D center, Data4D quaternion)

    {

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

    }

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

/**

 * Shears the Object.

 *

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

 * @param shear   The 3-tuple of shear factors.

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

 */

  public long shear(Data3D center, Data3D shear)

    {

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

    }

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

// Fragment-based effects  

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

/**

 * Creates macroblocks at and around point defined by the Region.

 * 

 * @param size   1-dimensional Dynamic which, at any given time, returns the size of the macroblocks.

 * @param region Region this Effect is limited to.

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

 */

  public long macroblock(Data1D size, Data4D region)

    {

    return mF.add(EffectNames.MACROBLOCK, size, region);

    }

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

/**

 * Creates macroblocks on the whole Object.

 *

 * @param size   1-dimensional Data which, at any given time, returns the size of the macroblocks.

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

 */

  public long macroblock(Data1D size)

    {

    return mF.add(EffectNames.MACROBLOCK, size);

    }

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

/**

 * 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

 * @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, Static3D 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

 * @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, Static3D color)

    {

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

    }

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

/**

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

 *        

 * @param blendcolor  4-dimensional Data returning the 4-tuple (blend,R,G,B).

 *                    Level of blend a given pixel will be mixed with the next parameter 'color':

 *                    pixel = (1-t)*pixel + t*color

 * @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(Data4D blendcolor, Data4D region, boolean smooth )

    {

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

    }

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

/**

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

 *

 * @param blendcolor  4-dimensional Data returning the 4-tuple (blend,R,G,B).

 *                    Level of blend a given pixel will be mixed with the next parameter 'color':

 *                    pixel = (1-t)*pixel + t*color

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

 */

  public long chroma(Data4D blendcolor)

    {

    return mF.add(EffectNames.CHROMA, blendcolor);

    }

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

/**

 * 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.

 * @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.

 * @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.

 * @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.

 * @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.

 * @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.

 * @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.

 * @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.

 * @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

/**

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

 * 

 * @param vector 2- or 3-dimensional Dynamic that returns a 2- or 3-dimensional Point which

 *               represents the vector the Center of the Effect is currently being dragged with.

 * @param region Region that masks the effect of the Distortion.

 * @param center 2-dimensional Dynamic that, at any given time, returns a Point2D representing

 *               the Center of the Effect.

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

 */

  public long distort(Dynamic vector, Static4D region, Dynamic2D center)

    {  

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

    }

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

/**

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

 * <p>

 * Difference between this and the previous method is that here the center of the Effect stays constant.

 *   

 * @param vector 2- or 3-dimensional Dynamic that returns a 2- or 3-dimensional Point which

 *               represents the vector the Center of the Effect is currently being dragged with.

 * @param region Region that masks the effect of the Distortion.

 * @param center Center of the Effect.

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

 */

  public long distort(Dynamic vector, Static4D region, Static2D center)

    {  

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

    }

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

/**

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

 * 

 * @param vector 2- or 3-dimensional Dynamic that returns a 2- or 3-dimensional Point which

 *               represents the vector the Center of the Effect is currently being dragged with.

 * @param center Center of the Effect.

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

 */

  public long distort(Dynamic vector, Static2D center)

    {

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

    }

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

/**

 * Distort part of the Object by a vector of force that changes from (0,0,0) to v.

 * 

 * @param vector   Maximum vector of force. 

 * @param region   Region that masks the effect of the Distortion.

 * @param center   Center of the Effect.

 * @param duration Time, in milliseconds, it takes to do one full interpolation.

 * @param count    Controls how many interpolations we want to do. See {@link Dynamic#setCount(float)}

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

 */

  public long distort(Static3D vector, Static4D region, Static2D center, int duration, float count)

    {  

    Dynamic3D di = new Dynamic3D();

    di.setCount(count);

    di.setDuration(duration);

    di.add(new Static3D(0.0f,0.0f,0.0f));

    di.add(vector);                                                  

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

    }

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

/**

 * Distort the whole Object by a vector of force that changes from (0,0,0) to v.

 * 

 * @param vector   Maximum vector of force.

 * @param center   Center of the Effect.

 * @param duration Time, in milliseconds, it takes to do one full interpolation.

 * @param count    Controls how many interpolations we want to do. See {@link Dynamic#setCount(float)}

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

 */

  public long distort(Static3D vector, Static2D center, int duration, float count)

    {

    Dynamic3D di = new Dynamic3D();

    di.setCount(count);

    di.setDuration(duration);

    di.add(new Static3D(0.0f,0.0f,0.0f));

    di.add(vector);                                                 

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

    }

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

/**

 * Distort the whole Object by a vector of force that changes from (0,0,0) to v.

 * <p>

 * Difference between this and the previous method is that here the vector of force will get interpolated

 * to the maximum v and the effect will end. We are thus limited to count=0.5.

 * 

 * @param vector   Maximum, final vector of force.

 * @param center   Center of the Effect.

 * @param duration Time, in milliseconds, it takes to do one full interpolation.

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

 */

  public long distort(Static3D vector, Static2D center, int duration)

    {

    Dynamic3D di = new Dynamic3D();

    di.setCount(0.5f);

    di.setDuration(duration);

    di.add(new Static3D(0.0f,0.0f,0.0f));

    di.add(vector);                 

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

    }

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

/**

 * Distort the whole Object by a vector of force v.

 * <p>

 * Here we apply a constant vector of force.

 * 

 * @param vector Vector of force.

 * @param center Center of the Effect.

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

 */

  public long distort(Static3D vector, Static2D center )

    {

    Dynamic3D di = new Dynamic3D();

    di.setCount(0.5f);

    di.setDuration(0);

    di.add(new Static3D(0.0f,0.0f,0.0f));

    di.add(vector);           

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

    }

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

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

// DEFORM

/**

 * 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 Dynamic that, at any given time, returns a Static2D representing vector of

 *               force that deforms the shape of the whole Object.

 * @param center 2-dimensional Dynamic that, at any given time, returns a Point2D representing

 *               the Center of the Effect.

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

 */

  public long deform(Dynamic vector, Dynamic2D center)

    {  

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

    }

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

/**

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

 * a constant point on the Object.

 * 

 * @param vector Dynamic that, at any given time, returns a Static2D representing

 *               vector of force that deforms the shape of the whole Object.

 * @param center Center of the Effect.

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

 */

  public long deform(Dynamic vector, Static2D center)

    {

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

    }

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

/**

 * Deform the shape of the whole Object with a vector of force smoothly changing from (0,0,0) to v

 * applied to a constant point on the Object.

 * 

 * @param vector   Vector of force.

 * @param center   Center of the Effect.

 * @param duration Time, in milliseconds, it takes to do one full interpolation.

 * @param count    Controls how many interpolations we want to do. See {@link Dynamic#setCount(float)}

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

 */

  public long deform(Static3D vector, Static2D center, int duration, float count)

    {

    Dynamic3D di = new Dynamic3D();

    di.setCount(count);

    di.setDuration(duration);

    di.add(new Static3D(0.0f,0.0f,0.0f));

    di.add(vector);                

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

    }

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

/**

 * Deform the shape of the whole Object with a vector of force smoothly changing from (0,0,0) to v

 * applied to a constant point on the Object.

 * <p>

 * Identical to calling the previous method with count=0.5.

 * 

 * @param vector   Final vector of force.

 * @param center   Center of the Effect.

 * @param duration Time, in milliseconds, it takes to do one full interpolation.

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

 */

  public long deform(Static3D vector, Static2D center, int duration)

    {

    Dynamic3D di = new Dynamic3D();

    di.setCount(0.5f);

    di.setDuration(duration);

    di.add(new Static3D(0.0f,0.0f,0.0f));

    di.add(vector);             

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

    }

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

/**

 * Deform the shape of the whole Object with a constant vector of force applied to a constant

 * point on the Object.

 * 

 * @param vector Vector of force.

 * @param center Center of the Effect.

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

 */

  public long deform(Static3D vector, Static2D center )

    {

    Dynamic3D di = new Dynamic3D();