Project

General

Profile

Download (43 KB) Statistics
| Branch: | Revision:

library / src / main / java / org / distorted / library / DistortedEffects.java @ 8426bd6a

1 d333eb6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
2
// Copyright 2016 Leszek Koltunski                                                               //
3
//                                                                                               //
4
// This file is part of Distorted.                                                               //
5
//                                                                                               //
6
// Distorted is free software: you can redistribute it and/or modify                             //
7
// it under the terms of the GNU General Public License as published by                          //
8
// the Free Software Foundation, either version 2 of the License, or                             //
9
// (at your option) any later version.                                                           //
10
//                                                                                               //
11
// Distorted is distributed in the hope that it will be useful,                                  //
12
// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //
13
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //
14
// GNU General Public License for more details.                                                  //
15
//                                                                                               //
16
// You should have received a copy of the GNU General Public License                             //
17
// along with Distorted.  If not, see <http://www.gnu.org/licenses/>.                            //
18
///////////////////////////////////////////////////////////////////////////////////////////////////
19
20 6a06a912 Leszek Koltunski
package org.distorted.library;
21
22 c90b9e01 Leszek Koltunski
import android.content.res.Resources;
23 194ab46f Leszek Koltunski
import android.opengl.GLES30;
24 8fa96e69 Leszek Koltunski
import android.opengl.Matrix;
25 6a06a912 Leszek Koltunski
26 e458a4ba Leszek Koltunski
import org.distorted.library.message.EffectListener;
27 55c14a19 Leszek Koltunski
import org.distorted.library.program.DistortedProgram;
28 c90b9e01 Leszek Koltunski
import org.distorted.library.program.FragmentCompilationException;
29
import org.distorted.library.program.FragmentUniformsException;
30
import org.distorted.library.program.LinkingException;
31
import org.distorted.library.program.VertexCompilationException;
32
import org.distorted.library.program.VertexUniformsException;
33 568b29d8 Leszek Koltunski
import org.distorted.library.type.Data1D;
34 f2fe7e28 Leszek Koltunski
import org.distorted.library.type.Data2D;
35 568b29d8 Leszek Koltunski
import org.distorted.library.type.Data3D;
36
import org.distorted.library.type.Data4D;
37 350cc2f5 Leszek Koltunski
import org.distorted.library.type.Data5D;
38 568b29d8 Leszek Koltunski
import org.distorted.library.type.Static3D;
39 a4835695 Leszek Koltunski
40 c90b9e01 Leszek Koltunski
import java.io.InputStream;
41 c638c1b0 Leszek Koltunski
import java.nio.ByteBuffer;
42
import java.nio.ByteOrder;
43
import java.nio.FloatBuffer;
44
45 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
46 b329f352 Leszek Koltunski
/**
47 13687207 leszek
 * Class containing Matrix,Vertex and Fragment effect queues. Postprocessing queue is held in a separate
48
 * class.
49 b73dcaa7 Leszek Koltunski
 * <p>
50 26df012c Leszek Koltunski
 * The queues hold actual effects to be applied to a given (DistortedTexture,MeshObject) combo.
51 b329f352 Leszek Koltunski
 */
52 421c2728 Leszek Koltunski
public class DistortedEffects
53 d425545a Leszek Koltunski
  {
54 8fa96e69 Leszek Koltunski
  private static final int POSITION_DATA_SIZE= 3; // Main Program: size of the position data in elements
55
  private static final int NORMAL_DATA_SIZE  = 3; // Main Program: size of the normal data in elements
56
  private static final int TEX_DATA_SIZE     = 2; // Main Program: size of the texture coordinate data in elements.
57 55c14a19 Leszek Koltunski
58 c1e24646 leszek
  /// MAIN PROGRAM ///
59
  private static DistortedProgram mMainProgram;
60
  private static int mMainTextureH;
61 03cb451d Leszek Koltunski
  private static boolean[] mEffectEnabled = new boolean[EffectNames.size()];
62
63
  static
64
    {
65
    int len = EffectNames.size();
66
67
    for(int i=0; i<len; i++)
68
      {
69
      mEffectEnabled[i] = false;
70
      }
71
    }
72 8fa96e69 Leszek Koltunski
73 c1e24646 leszek
  /// BLIT PROGRAM ///
74
  private static DistortedProgram mBlitProgram;
75
  private static int mBlitTextureH;
76 c2c08950 leszek
  private static int mBlitDepthH;
77 c90b9e01 Leszek Koltunski
  private static final FloatBuffer mQuadPositions;
78
79
  static
80
    {
81
    float[] positionData= { -0.5f, -0.5f,  -0.5f, 0.5f,  0.5f,-0.5f,  0.5f, 0.5f };
82
    mQuadPositions = ByteBuffer.allocateDirect(32).order(ByteOrder.nativeOrder()).asFloatBuffer();
83
    mQuadPositions.put(positionData).position(0);
84
    }
85
86 c1e24646 leszek
  /// DEBUG ONLY /////
87
  private static DistortedProgram mDebugProgram;
88
89
  private static int mDebugObjDH;
90
  private static int mDebugMVPMatrixH;
91 c90b9e01 Leszek Koltunski
  /// END DEBUG //////
92
93 8fa96e69 Leszek Koltunski
  private static float[] mMVPMatrix = new float[16];
94
  private static float[] mTmpMatrix = new float[16];
95 c638c1b0 Leszek Koltunski
96 8e34674e Leszek Koltunski
  private static long mNextID =0;
97 4e2382f3 Leszek Koltunski
  private long mID;
98 8e34674e Leszek Koltunski
99 d6e94c84 Leszek Koltunski
  private EffectQueueMatrix      mM;
100
  private EffectQueueFragment    mF;
101
  private EffectQueueVertex      mV;
102 3d590d8d Leszek Koltunski
103 13687207 leszek
  private boolean matrixCloned, vertexCloned, fragmentCloned;
104 985ea9c5 Leszek Koltunski
105 9361b337 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
106 55c14a19 Leszek Koltunski
107 c90b9e01 Leszek Koltunski
  static void createProgram(Resources resources)
108
  throws FragmentCompilationException,VertexCompilationException,VertexUniformsException,FragmentUniformsException,LinkingException
109 55c14a19 Leszek Koltunski
    {
110 03cb451d Leszek Koltunski
    final InputStream mainVertStream = resources.openRawResource(R.raw.main_vertex_shader);
111
    final InputStream mainFragStream = resources.openRawResource(R.raw.main_fragment_shader);
112
113 94f6d472 Leszek Koltunski
    String mainVertHeader= Distorted.GLSL_VERSION;
114
    String mainFragHeader= Distorted.GLSL_VERSION;
115 c90b9e01 Leszek Koltunski
116 03cb451d Leszek Koltunski
    EffectNames name;
117
    EffectTypes type;
118
    boolean foundF = false;
119
    boolean foundV = false;
120 c90b9e01 Leszek Koltunski
121 03cb451d Leszek Koltunski
    for(int i=0; i<mEffectEnabled.length; i++)
122 c90b9e01 Leszek Koltunski
      {
123 03cb451d Leszek Koltunski
      if( mEffectEnabled[i] )
124
        {
125
        name = EffectNames.getName(i);
126
        type = EffectNames.getType(i);
127
128
        if( type == EffectTypes.VERTEX )
129
          {
130
          mainVertHeader += ("#define "+name.name()+" "+name.ordinal()+"\n");
131
          foundV = true;
132
          }
133
        else if( type == EffectTypes.FRAGMENT )
134
          {
135
          mainFragHeader += ("#define "+name.name()+" "+name.ordinal()+"\n");
136
          foundF = true;
137
          }
138
        }
139 c90b9e01 Leszek Koltunski
      }
140
141 03cb451d Leszek Koltunski
    mainVertHeader += ("#define NUM_VERTEX "   + ( foundV ? getMaxVertex()   : 0 ) + "\n");
142
    mainFragHeader += ("#define NUM_FRAGMENT " + ( foundF ? getMaxFragment() : 0 ) + "\n");
143 c90b9e01 Leszek Koltunski
144 03cb451d Leszek Koltunski
    //android.util.Log.e("Effects", "vertHeader= "+mainVertHeader);
145
    //android.util.Log.e("Effects", "fragHeader= "+mainFragHeader);
146 c90b9e01 Leszek Koltunski
147 94f6d472 Leszek Koltunski
    mMainProgram = new DistortedProgram(mainVertStream,mainFragStream, mainVertHeader, mainFragHeader, Distorted.GLSL);
148 c90b9e01 Leszek Koltunski
149 c1e24646 leszek
    int mainProgramH = mMainProgram.getProgramHandle();
150 c90b9e01 Leszek Koltunski
    EffectQueueFragment.getUniforms(mainProgramH);
151
    EffectQueueVertex.getUniforms(mainProgramH);
152
    EffectQueueMatrix.getUniforms(mainProgramH);
153 c1e24646 leszek
    mMainTextureH= GLES30.glGetUniformLocation( mainProgramH, "u_Texture");
154
155
    // BLIT PROGRAM ////////////////////////////////////
156
    final InputStream blitVertStream = resources.openRawResource(R.raw.blit_vertex_shader);
157
    final InputStream blitFragStream = resources.openRawResource(R.raw.blit_fragment_shader);
158
159 94f6d472 Leszek Koltunski
    String blitVertHeader= (Distorted.GLSL_VERSION + "#define NUM_VERTEX 0\n"  );
160
    String blitFragHeader= (Distorted.GLSL_VERSION + "#define NUM_FRAGMENT 0\n");
161 c1e24646 leszek
162 f2367b75 Leszek Koltunski
    try
163
      {
164 94f6d472 Leszek Koltunski
      mBlitProgram = new DistortedProgram(blitVertStream,blitFragStream,blitVertHeader,blitFragHeader, Distorted.GLSL);
165 f2367b75 Leszek Koltunski
      }
166
    catch(Exception e)
167
      {
168
      android.util.Log.e("EFFECTS", "exception trying to compile BLIT program: "+e.getMessage());
169
      throw new RuntimeException(e.getMessage());
170
      }
171 c1e24646 leszek
172
    int blitProgramH = mBlitProgram.getProgramHandle();
173
    mBlitTextureH  = GLES30.glGetUniformLocation( blitProgramH, "u_Texture");
174 c2c08950 leszek
    mBlitDepthH    = GLES30.glGetUniformLocation( blitProgramH, "u_Depth");
175 c90b9e01 Leszek Koltunski
176
    // DEBUG ONLY //////////////////////////////////////
177
    final InputStream debugVertexStream   = resources.openRawResource(R.raw.test_vertex_shader);
178
    final InputStream debugFragmentStream = resources.openRawResource(R.raw.test_fragment_shader);
179
180 f2367b75 Leszek Koltunski
    try
181
      {
182 94f6d472 Leszek Koltunski
      mDebugProgram = new DistortedProgram(debugVertexStream,debugFragmentStream, Distorted.GLSL_VERSION, Distorted.GLSL_VERSION, Distorted.GLSL);
183 f2367b75 Leszek Koltunski
      }
184
    catch(Exception e)
185
      {
186
      android.util.Log.e("EFFECTS", "exception trying to compile DEBUG program: "+e.getMessage());
187
      throw new RuntimeException(e.getMessage());
188
      }
189 c90b9e01 Leszek Koltunski
190
    int debugProgramH = mDebugProgram.getProgramHandle();
191 c1e24646 leszek
    mDebugObjDH = GLES30.glGetUniformLocation( debugProgramH, "u_objD");
192
    mDebugMVPMatrixH = GLES30.glGetUniformLocation( debugProgramH, "u_MVPMatrix");
193 c90b9e01 Leszek Koltunski
    // END DEBUG  //////////////////////////////////////
194 55c14a19 Leszek Koltunski
    }
195
196
///////////////////////////////////////////////////////////////////////////////////////////////////
197
198 421c2728 Leszek Koltunski
  private void initializeEffectLists(DistortedEffects d, int flags)
199 d425545a Leszek Koltunski
    {
200 015642fb Leszek Koltunski
    if( (flags & Distorted.CLONE_MATRIX) != 0 )
201 6a06a912 Leszek Koltunski
      {
202 d425545a Leszek Koltunski
      mM = d.mM;
203
      matrixCloned = true;
204
      }
205
    else
206
      {
207 4e2382f3 Leszek Koltunski
      mM = new EffectQueueMatrix(mID);
208 d425545a Leszek Koltunski
      matrixCloned = false;
209
      }
210 6a06a912 Leszek Koltunski
    
211 d425545a Leszek Koltunski
    if( (flags & Distorted.CLONE_VERTEX) != 0 )
212
      {
213
      mV = d.mV;
214
      vertexCloned = true;
215
      }
216
    else
217
      {
218 4e2382f3 Leszek Koltunski
      mV = new EffectQueueVertex(mID);
219 d425545a Leszek Koltunski
      vertexCloned = false;
220
      }
221 6a06a912 Leszek Koltunski
    
222 d425545a Leszek Koltunski
    if( (flags & Distorted.CLONE_FRAGMENT) != 0 )
223
      {
224
      mF = d.mF;
225
      fragmentCloned = true;
226 6a06a912 Leszek Koltunski
      }
227 d425545a Leszek Koltunski
    else
228
      {
229 4e2382f3 Leszek Koltunski
      mF = new EffectQueueFragment(mID);
230 d425545a Leszek Koltunski
      fragmentCloned = false;
231
      }
232
    }
233 6a06a912 Leszek Koltunski
234
///////////////////////////////////////////////////////////////////////////////////////////////////
235 c90b9e01 Leszek Koltunski
// DEBUG ONLY
236
237 e8b2f311 Leszek Koltunski
  @SuppressWarnings("unused")
238 95c441a2 leszek
  private void displayBoundingRect(float halfX, float halfY, float halfZ, DistortedOutputSurface surface, float[] mvp, float[] vertices, long currTime)
239 c90b9e01 Leszek Koltunski
    {
240
    int len  = vertices.length/3;
241
    int minx = Integer.MAX_VALUE;
242
    int maxx = Integer.MIN_VALUE;
243
    int miny = Integer.MAX_VALUE;
244
    int maxy = Integer.MIN_VALUE;
245
    int wx,wy;
246
247
    float x,y,z, X,Y,W, ndcX,ndcY;
248
249
    for(int i=0; i<len; i++)
250
      {
251
      x = 2*halfX*vertices[3*i  ];
252
      y = 2*halfY*vertices[3*i+1];
253
      z = 2*halfZ*vertices[3*i+2];
254
255
      X = mvp[ 0]*x + mvp[ 4]*y + mvp[ 8]*z + mvp[12];
256
      Y = mvp[ 1]*x + mvp[ 5]*y + mvp[ 9]*z + mvp[13];
257
      W = mvp[ 3]*x + mvp[ 7]*y + mvp[11]*z + mvp[15];
258
259
      ndcX = X/W;
260
      ndcY = Y/W;
261
262 af4cc5db Leszek Koltunski
      wx = (int)(surface.mWidth *(ndcX+1)/2);
263
      wy = (int)(surface.mHeight*(ndcY+1)/2);
264 c90b9e01 Leszek Koltunski
265 e8b2f311 Leszek Koltunski
      if( wx<minx ) minx = wx;
266
      if( wx>maxx ) maxx = wx;
267
      if( wy<miny ) miny = wy;
268
      if( wy>maxy ) maxy = wy;
269 c90b9e01 Leszek Koltunski
      }
270
271
    mDebugProgram.useProgram();
272 95c441a2 leszek
    surface.setAsOutput(currTime);
273 c90b9e01 Leszek Koltunski
274 c318fb14 Leszek Koltunski
    Matrix.setIdentityM( mTmpMatrix, 0);
275 af4cc5db Leszek Koltunski
    Matrix.translateM  ( mTmpMatrix, 0, minx-surface.mWidth/2, maxy-surface.mHeight/2, -surface.mDistance);
276 c318fb14 Leszek Koltunski
    Matrix.scaleM      ( mTmpMatrix, 0, (float)(maxx-minx)/(2*halfX), (float)(maxy-miny)/(2*halfY), 1.0f);
277
    Matrix.translateM  ( mTmpMatrix, 0, halfX,-halfY, 0);
278 af4cc5db Leszek Koltunski
    Matrix.multiplyMM  ( mMVPMatrix, 0, surface.mProjectionMatrix, 0, mTmpMatrix, 0);
279 c90b9e01 Leszek Koltunski
280 c1e24646 leszek
    GLES30.glUniform2f(mDebugObjDH, 2*halfX, 2*halfY);
281
    GLES30.glUniformMatrix4fv(mDebugMVPMatrixH, 1, false, mMVPMatrix , 0);
282 c90b9e01 Leszek Koltunski
283 194ab46f Leszek Koltunski
    GLES30.glVertexAttribPointer(mDebugProgram.mAttribute[0], 2, GLES30.GL_FLOAT, false, 0, mQuadPositions);
284
    GLES30.glDrawArrays(GLES30.GL_TRIANGLE_STRIP, 0, 4);
285 c90b9e01 Leszek Koltunski
    }
286
287
///////////////////////////////////////////////////////////////////////////////////////////////////
288
289 c1e24646 leszek
  void drawPriv(float halfW, float halfH, MeshObject mesh, DistortedOutputSurface surface, long currTime)
290 d425545a Leszek Koltunski
    {
291
    mM.compute(currTime);
292
    mV.compute(currTime);
293
    mF.compute(currTime);
294 a56bc359 Leszek Koltunski
295 c1e24646 leszek
    float halfZ = halfW*mesh.zFactor;
296 638b5b5c leszek
297 8426bd6a Leszek Koltunski
    GLES30.glViewport(0, 0, surface.mWidth, surface.mHeight );
298 d6e94c84 Leszek Koltunski
299 b9798977 leszek
    mMainProgram.useProgram();
300
    GLES30.glUniform1i(mMainTextureH, 0);
301 95c441a2 leszek
    surface.setAsOutput(currTime);
302 b9798977 leszek
    mM.send(surface,halfW,halfH,halfZ);
303 638b5b5c leszek
    mM.send(surface,halfW,halfH,halfZ);
304 b9798977 leszek
    mV.send(halfW,halfH,halfZ);
305
    mF.send(halfW,halfH);
306
    GLES30.glVertexAttribPointer(mMainProgram.mAttribute[0], POSITION_DATA_SIZE, GLES30.GL_FLOAT, false, 0, mesh.mMeshPositions);
307
    GLES30.glVertexAttribPointer(mMainProgram.mAttribute[1], NORMAL_DATA_SIZE  , GLES30.GL_FLOAT, false, 0, mesh.mMeshNormals);
308
    GLES30.glVertexAttribPointer(mMainProgram.mAttribute[2], TEX_DATA_SIZE     , GLES30.GL_FLOAT, false, 0, mesh.mMeshTexture);
309
    GLES30.glDrawArrays(GLES30.GL_TRIANGLE_STRIP, 0, mesh.dataLength);
310 c90b9e01 Leszek Koltunski
311
    /// DEBUG ONLY //////
312 dbe8ea80 Leszek Koltunski
    // displayBoundingRect(halfInputW, halfInputH, halfZ, df, mM.getMVP(), mesh.getBoundingVertices() );
313 c90b9e01 Leszek Koltunski
    /// END DEBUG ///////
314 d425545a Leszek Koltunski
    }
315 6a06a912 Leszek Koltunski
316
///////////////////////////////////////////////////////////////////////////////////////////////////
317
   
318 8426bd6a Leszek Koltunski
  static void blitPriv(DistortedOutputSurface surface)
319 d425545a Leszek Koltunski
    {
320 c1e24646 leszek
    mBlitProgram.useProgram();
321
322 8426bd6a Leszek Koltunski
    GLES30.glViewport(0, 0, surface.mWidth, surface.mHeight );
323 c1e24646 leszek
    GLES30.glUniform1i(mBlitTextureH, 0);
324 8426bd6a Leszek Koltunski
    GLES30.glUniform1f( mBlitDepthH , 1.0f-surface.mNear);
325 c1e24646 leszek
    GLES30.glVertexAttribPointer(mBlitProgram.mAttribute[0], 2, GLES30.GL_FLOAT, false, 0, mQuadPositions);
326
    GLES30.glDrawArrays(GLES30.GL_TRIANGLE_STRIP, 0, 4);
327 d425545a Leszek Koltunski
    }
328 6a06a912 Leszek Koltunski
    
329
///////////////////////////////////////////////////////////////////////////////////////////////////
330
   
331 8e34674e Leszek Koltunski
  private void releasePriv()
332 d425545a Leszek Koltunski
    {
333 d6e94c84 Leszek Koltunski
    if( !matrixCloned     ) mM.abortAll(false);
334
    if( !vertexCloned     ) mV.abortAll(false);
335
    if( !fragmentCloned   ) mF.abortAll(false);
336 d425545a Leszek Koltunski
337 4e2382f3 Leszek Koltunski
    mM = null;
338
    mV = null;
339
    mF = null;
340 8e34674e Leszek Koltunski
    }
341
342 1942537e Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
343
344 7b8086eb Leszek Koltunski
  static void onDestroy()
345 1942537e Leszek Koltunski
    {
346
    mNextID = 0;
347 03cb451d Leszek Koltunski
348
    int len = EffectNames.size();
349
350
    for(int i=0; i<len; i++)
351
      {
352
      mEffectEnabled[i] = false;
353
      }
354 1942537e Leszek Koltunski
    }
355
356 8e34674e Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
357
// PUBLIC API
358 ada90d33 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
359 d425545a Leszek Koltunski
/**
360 4e2382f3 Leszek Koltunski
 * Create empty effect queue.
361 d425545a Leszek Koltunski
 */
362 421c2728 Leszek Koltunski
  public DistortedEffects()
363 d425545a Leszek Koltunski
    {
364 c7da4e65 leszek
    mID = ++mNextID;
365 4e2382f3 Leszek Koltunski
    initializeEffectLists(this,0);
366 d425545a Leszek Koltunski
    }
367 ada90d33 Leszek Koltunski
368
///////////////////////////////////////////////////////////////////////////////////////////////////
369 d425545a Leszek Koltunski
/**
370 4e2382f3 Leszek Koltunski
 * Copy constructor.
371 d425545a Leszek Koltunski
 * <p>
372
 * Whatever we do not clone gets created just like in the default constructor.
373
 *
374
 * @param dc    Source object to create our object from
375
 * @param flags A bitmask of values specifying what to copy.
376 e6ab30eb Leszek Koltunski
 *              For example, CLONE_VERTEX | CLONE_MATRIX.
377 d425545a Leszek Koltunski
 */
378 421c2728 Leszek Koltunski
  public DistortedEffects(DistortedEffects dc, int flags)
379 d425545a Leszek Koltunski
    {
380 c7da4e65 leszek
    mID = ++mNextID;
381 4e2382f3 Leszek Koltunski
    initializeEffectLists(dc,flags);
382 d425545a Leszek Koltunski
    }
383 ada90d33 Leszek Koltunski
384 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
385
/**
386 07305c87 Leszek Koltunski
 * Releases all resources. After this call, the queue should not be used anymore.
387 6a06a912 Leszek Koltunski
 */
388 13687207 leszek
  @SuppressWarnings("unused")
389 8e34674e Leszek Koltunski
  public synchronized void delete()
390 d425545a Leszek Koltunski
    {
391
    releasePriv();
392
    }
393 6a06a912 Leszek Koltunski
394
///////////////////////////////////////////////////////////////////////////////////////////////////
395
/**
396 4e2382f3 Leszek Koltunski
 * Returns unique ID of this instance.
397
 *
398
 * @return ID of the object.
399 6a06a912 Leszek Koltunski
 */
400 4e2382f3 Leszek Koltunski
  public long getID()
401 d425545a Leszek Koltunski
      {
402 4e2382f3 Leszek Koltunski
      return mID;
403 d425545a Leszek Koltunski
      }
404 4e2382f3 Leszek Koltunski
405 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
406
/**
407
 * Adds the calling class to the list of Listeners that get notified each time some event happens 
408 07305c87 Leszek Koltunski
 * to one of the Effects in those queues. Nothing will happen if 'el' is already in the list.
409 6a06a912 Leszek Koltunski
 * 
410
 * @param el A class implementing the EffectListener interface that wants to get notifications.
411
 */
412 13687207 leszek
  @SuppressWarnings("unused")
413 3fc994b2 Leszek Koltunski
  public void registerForMessages(EffectListener el)
414 d425545a Leszek Koltunski
    {
415 3fc994b2 Leszek Koltunski
    mV.registerForMessages(el);
416
    mF.registerForMessages(el);
417
    mM.registerForMessages(el);
418 d425545a Leszek Koltunski
    }
419 6a06a912 Leszek Koltunski
420
///////////////////////////////////////////////////////////////////////////////////////////////////
421
/**
422
 * Removes the calling class from the list of Listeners.
423
 * 
424
 * @param el A class implementing the EffectListener interface that no longer wants to get notifications.
425
 */
426 13687207 leszek
  @SuppressWarnings("unused")
427 3fc994b2 Leszek Koltunski
  public void deregisterForMessages(EffectListener el)
428 d425545a Leszek Koltunski
    {
429 3fc994b2 Leszek Koltunski
    mV.deregisterForMessages(el);
430
    mF.deregisterForMessages(el);
431
    mM.deregisterForMessages(el);
432 d425545a Leszek Koltunski
    }
433 6a06a912 Leszek Koltunski
434
///////////////////////////////////////////////////////////////////////////////////////////////////
435
/**
436 d07f2950 Leszek Koltunski
 * Aborts all Effects.
437
 * @return Number of effects aborted.
438 6a06a912 Leszek Koltunski
 */
439 d425545a Leszek Koltunski
  public int abortAllEffects()
440 13687207 leszek
    {
441
    return mM.abortAll(true) + mV.abortAll(true) + mF.abortAll(true);
442
    }
443 6a06a912 Leszek Koltunski
444
///////////////////////////////////////////////////////////////////////////////////////////////////
445
/**
446 d07f2950 Leszek Koltunski
 * Aborts all Effects of a given type, for example all MATRIX Effects.
447 6a06a912 Leszek Koltunski
 * 
448 d07f2950 Leszek Koltunski
 * @param type one of the constants defined in {@link EffectTypes}
449
 * @return Number of effects aborted.
450 6a06a912 Leszek Koltunski
 */
451 d425545a Leszek Koltunski
  public int abortEffects(EffectTypes type)
452
    {
453
    switch(type)
454 6a06a912 Leszek Koltunski
      {
455 d6e94c84 Leszek Koltunski
      case MATRIX     : return mM.abortAll(true);
456
      case VERTEX     : return mV.abortAll(true);
457
      case FRAGMENT   : return mF.abortAll(true);
458
      default         : return 0;
459 6a06a912 Leszek Koltunski
      }
460 d425545a Leszek Koltunski
    }
461 6a06a912 Leszek Koltunski
    
462
///////////////////////////////////////////////////////////////////////////////////////////////////
463
/**
464
 * Aborts a single Effect.
465
 * 
466
 * @param id ID of the Effect we want to abort.
467 476bbc81 Leszek Koltunski
 * @return number of Effects aborted. Always either 0 or 1.
468 6a06a912 Leszek Koltunski
 */
469 d425545a Leszek Koltunski
  public int abortEffect(long id)
470
    {
471
    int type = (int)(id&EffectTypes.MASK);
472 1e438fc7 Leszek Koltunski
473 d6e94c84 Leszek Koltunski
    if( type==EffectTypes.MATRIX.type      ) return mM.removeByID(id>>EffectTypes.LENGTH);
474
    if( type==EffectTypes.VERTEX.type      ) return mV.removeByID(id>>EffectTypes.LENGTH);
475
    if( type==EffectTypes.FRAGMENT.type    ) return mF.removeByID(id>>EffectTypes.LENGTH);
476 1e438fc7 Leszek Koltunski
477 d425545a Leszek Koltunski
    return 0;
478
    }
479 6a06a912 Leszek Koltunski
480
///////////////////////////////////////////////////////////////////////////////////////////////////
481
/**
482 e8c81a8e Leszek Koltunski
 * Abort all Effects of a given name, for example all rotations.
483 6a06a912 Leszek Koltunski
 * 
484 d07f2950 Leszek Koltunski
 * @param name one of the constants defined in {@link EffectNames}
485 476bbc81 Leszek Koltunski
 * @return number of Effects aborted.
486 6a06a912 Leszek Koltunski
 */
487 d425545a Leszek Koltunski
  public int abortEffects(EffectNames name)
488
    {
489
    switch(name.getType())
490 6a06a912 Leszek Koltunski
      {
491 d6e94c84 Leszek Koltunski
      case MATRIX     : return mM.removeByType(name);
492
      case VERTEX     : return mV.removeByType(name);
493
      case FRAGMENT   : return mF.removeByType(name);
494
      default         : return 0;
495 6a06a912 Leszek Koltunski
      }
496 d425545a Leszek Koltunski
    }
497 6a06a912 Leszek Koltunski
    
498
///////////////////////////////////////////////////////////////////////////////////////////////////
499
/**
500
 * Print some info about a given Effect to Android's standard out. Used for debugging only.
501
 * 
502
 * @param id Effect ID we want to print info about
503
 * @return <code>true</code> if a single Effect of type effectType has been found.
504
 */
505 13687207 leszek
  @SuppressWarnings("unused")
506 d425545a Leszek Koltunski
  public boolean printEffect(long id)
507
    {
508
    int type = (int)(id&EffectTypes.MASK);
509 1e438fc7 Leszek Koltunski
510 13687207 leszek
    if( type==EffectTypes.MATRIX.type  )  return mM.printByID(id>>EffectTypes.LENGTH);
511
    if( type==EffectTypes.VERTEX.type  )  return mV.printByID(id>>EffectTypes.LENGTH);
512
    if( type==EffectTypes.FRAGMENT.type)  return mF.printByID(id>>EffectTypes.LENGTH);
513 1e438fc7 Leszek Koltunski
514 d425545a Leszek Koltunski
    return false;
515
    }
516 432442f9 Leszek Koltunski
517 03cb451d Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
518
/**
519
 * Enables a given Effect.
520
 * <p>
521
 * By default, all effects are disabled. One has to explicitly enable each effect one intends to use.
522
 * This needs to be called BEFORE shaders get compiled, i.e. before the call to Distorted.onCreate().
523
 * The point: by enabling only the effects we need, we can optimize the shaders.
524
 *
525
 * @param name Name of the Effect to enable.
526
 */
527
  public static void enableEffect(EffectNames name)
528
    {
529
    mEffectEnabled[name.ordinal()] = true;
530
    }
531
532 432442f9 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
533
/**
534
 * Returns the maximum number of Matrix effects.
535
 *
536
 * @return The maximum number of Matrix effects
537
 */
538 13687207 leszek
  @SuppressWarnings("unused")
539 432442f9 Leszek Koltunski
  public static int getMaxMatrix()
540
    {
541
    return EffectQueue.getMax(EffectTypes.MATRIX.ordinal());
542
    }
543
544
///////////////////////////////////////////////////////////////////////////////////////////////////
545
/**
546
 * Returns the maximum number of Vertex effects.
547
 *
548
 * @return The maximum number of Vertex effects
549
 */
550 13687207 leszek
  @SuppressWarnings("unused")
551 432442f9 Leszek Koltunski
  public static int getMaxVertex()
552
    {
553
    return EffectQueue.getMax(EffectTypes.VERTEX.ordinal());
554
    }
555
556
///////////////////////////////////////////////////////////////////////////////////////////////////
557
/**
558
 * Returns the maximum number of Fragment effects.
559
 *
560
 * @return The maximum number of Fragment effects
561
 */
562 13687207 leszek
  @SuppressWarnings("unused")
563 432442f9 Leszek Koltunski
  public static int getMaxFragment()
564
    {
565
    return EffectQueue.getMax(EffectTypes.FRAGMENT.ordinal());
566
    }
567
568
///////////////////////////////////////////////////////////////////////////////////////////////////
569
/**
570
 * Sets the maximum number of Matrix effects that can be stored in a single EffectQueue at one time.
571
 * This can fail if:
572
 * <ul>
573
 * <li>the value of 'max' is outside permitted range (0 &le; max &le; Byte.MAX_VALUE)
574
 * <li>We try to increase the value of 'max' when it is too late to do so already. It needs to be called
575
 *     before the Vertex Shader gets compiled, i.e. before the call to {@link Distorted#onCreate}. After this
576
 *     time only decreasing the value of 'max' is permitted.
577
 * <li>Furthermore, this needs to be called before any instances of the DistortedEffects class get created.
578
 * </ul>
579
 *
580
 * @param max new maximum number of simultaneous Matrix Effects. Has to be a non-negative number not greater
581
 *            than Byte.MAX_VALUE
582
 * @return <code>true</code> if operation was successful, <code>false</code> otherwise.
583
 */
584 13687207 leszek
  @SuppressWarnings("unused")
585 432442f9 Leszek Koltunski
  public static boolean setMaxMatrix(int max)
586
    {
587
    return EffectQueue.setMax(EffectTypes.MATRIX.ordinal(),max);
588
    }
589
590
///////////////////////////////////////////////////////////////////////////////////////////////////
591
/**
592
 * Sets the maximum number of Vertex effects that can be stored in a single EffectQueue at one time.
593
 * This can fail if:
594
 * <ul>
595
 * <li>the value of 'max' is outside permitted range (0 &le; max &le; Byte.MAX_VALUE)
596
 * <li>We try to increase the value of 'max' when it is too late to do so already. It needs to be called
597
 *     before the Vertex Shader gets compiled, i.e. before the call to {@link Distorted#onCreate}. After this
598
 *     time only decreasing the value of 'max' is permitted.
599
* <li>Furthermore, this needs to be called before any instances of the DistortedEffects class get created.
600
 * </ul>
601
 *
602
 * @param max new maximum number of simultaneous Vertex Effects. Has to be a non-negative number not greater
603
 *            than Byte.MAX_VALUE
604
 * @return <code>true</code> if operation was successful, <code>false</code> otherwise.
605
 */
606 13687207 leszek
  @SuppressWarnings("unused")
607 432442f9 Leszek Koltunski
  public static boolean setMaxVertex(int max)
608
    {
609
    return EffectQueue.setMax(EffectTypes.VERTEX.ordinal(),max);
610
    }
611
612
///////////////////////////////////////////////////////////////////////////////////////////////////
613
/**
614
 * Sets the maximum number of Fragment effects that can be stored in a single EffectQueue at one time.
615
 * This can fail if:
616
 * <ul>
617
 * <li>the value of 'max' is outside permitted range (0 &le; max &le; Byte.MAX_VALUE)
618
 * <li>We try to increase the value of 'max' when it is too late to do so already. It needs to be called
619
 *     before the Fragment Shader gets compiled, i.e. before the call to {@link Distorted#onCreate}. After this
620
 *     time only decreasing the value of 'max' is permitted.
621
 * <li>Furthermore, this needs to be called before any instances of the DistortedEffects class get created.
622
 * </ul>
623
 *
624
 * @param max new maximum number of simultaneous Fragment Effects. Has to be a non-negative number not greater
625
 *            than Byte.MAX_VALUE
626
 * @return <code>true</code> if operation was successful, <code>false</code> otherwise.
627
 */
628 13687207 leszek
  @SuppressWarnings("unused")
629 432442f9 Leszek Koltunski
  public static boolean setMaxFragment(int max)
630
    {
631
    return EffectQueue.setMax(EffectTypes.FRAGMENT.ordinal(),max);
632
    }
633
634 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////   
635
///////////////////////////////////////////////////////////////////////////////////////////////////
636
// Individual effect functions.
637
///////////////////////////////////////////////////////////////////////////////////////////////////
638
// Matrix-based effects
639
///////////////////////////////////////////////////////////////////////////////////////////////////
640
/**
641 e8c81a8e Leszek Koltunski
 * Moves the Object by a (possibly changing in time) vector.
642 6a06a912 Leszek Koltunski
 * 
643 a2594090 leszek
 * @param vector 3-dimensional Data which at any given time will return a Static3D
644
 *               representing the current coordinates of the vector we want to move the Object with.
645 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
646 6a06a912 Leszek Koltunski
 */
647 568b29d8 Leszek Koltunski
  public long move(Data3D vector)
648 6a06a912 Leszek Koltunski
    {   
649 e0a16874 Leszek Koltunski
    return mM.add(EffectNames.MOVE,vector);
650 6a06a912 Leszek Koltunski
    }
651
652
///////////////////////////////////////////////////////////////////////////////////////////////////
653
/**
654 e8c81a8e Leszek Koltunski
 * Scales the Object by (possibly changing in time) 3D scale factors.
655 6a06a912 Leszek Koltunski
 * 
656 d1e740c5 Leszek Koltunski
 * @param scale 3-dimensional Data which at any given time returns a Static3D
657 e0a16874 Leszek Koltunski
 *              representing the current x- , y- and z- scale factors.
658
 * @return      ID of the effect added, or -1 if we failed to add one.
659 6a06a912 Leszek Koltunski
 */
660 568b29d8 Leszek Koltunski
  public long scale(Data3D scale)
661 6a06a912 Leszek Koltunski
    {   
662 e0a16874 Leszek Koltunski
    return mM.add(EffectNames.SCALE,scale);
663 6a06a912 Leszek Koltunski
    }
664
665 2fce34f4 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
666
/**
667 e8c81a8e Leszek Koltunski
 * Scales the Object by one uniform, constant factor in all 3 dimensions. Convenience function.
668 2fce34f4 Leszek Koltunski
 *
669
 * @param scale The factor to scale all 3 dimensions with.
670
 * @return      ID of the effect added, or -1 if we failed to add one.
671
 */
672 d425545a Leszek Koltunski
  public long scale(float scale)
673
    {
674
    return mM.add(EffectNames.SCALE, new Static3D(scale,scale,scale));
675
    }
676 2fce34f4 Leszek Koltunski
677 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
678
/**
679 568b29d8 Leszek Koltunski
 * Rotates the Object by 'angle' degrees around the center.
680 a2594090 leszek
 * Static axis of rotation is given by the last parameter.
681 568b29d8 Leszek Koltunski
 *
682 9351ad55 Leszek Koltunski
 * @param angle  Angle that we want to rotate the Object to. Unit: degrees
683 568b29d8 Leszek Koltunski
 * @param axis   Axis of rotation
684 0df17fad Leszek Koltunski
 * @param center Coordinates of the Point we are rotating around.
685 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
686
 */
687 0df17fad Leszek Koltunski
  public long rotate(Data1D angle, Static3D axis, Data3D center )
688 6a06a912 Leszek Koltunski
    {   
689 0df17fad Leszek Koltunski
    return mM.add(EffectNames.ROTATE, angle, axis, center);
690 6a06a912 Leszek Koltunski
    }
691
692
///////////////////////////////////////////////////////////////////////////////////////////////////
693
/**
694 568b29d8 Leszek Koltunski
 * Rotates the Object by 'angle' degrees around the center.
695 2fce34f4 Leszek Koltunski
 * Here both angle and axis can dynamically change.
696 568b29d8 Leszek Koltunski
 *
697
 * @param angleaxis Combined 4-tuple representing the (angle,axisX,axisY,axisZ).
698 0df17fad Leszek Koltunski
 * @param center    Coordinates of the Point we are rotating around.
699 568b29d8 Leszek Koltunski
 * @return          ID of the effect added, or -1 if we failed to add one.
700 e0a16874 Leszek Koltunski
 */
701 0df17fad Leszek Koltunski
  public long rotate(Data4D angleaxis, Data3D center)
702 568b29d8 Leszek Koltunski
    {
703 0df17fad Leszek Koltunski
    return mM.add(EffectNames.ROTATE, angleaxis, center);
704 6a06a912 Leszek Koltunski
    }
705
706
///////////////////////////////////////////////////////////////////////////////////////////////////
707
/**
708 568b29d8 Leszek Koltunski
 * Rotates the Object by quaternion.
709 0df17fad Leszek Koltunski
 *
710 568b29d8 Leszek Koltunski
 * @param quaternion The quaternion describing the rotation.
711 0df17fad Leszek Koltunski
 * @param center     Coordinates of the Point we are rotating around.
712 568b29d8 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
713 6a06a912 Leszek Koltunski
 */
714 0df17fad Leszek Koltunski
  public long quaternion(Data4D quaternion, Data3D center )
715 568b29d8 Leszek Koltunski
    {
716 0df17fad Leszek Koltunski
    return mM.add(EffectNames.QUATERNION,quaternion,center);
717 6a06a912 Leszek Koltunski
    }
718
719
///////////////////////////////////////////////////////////////////////////////////////////////////
720
/**
721 568b29d8 Leszek Koltunski
 * Shears the Object.
722 6a06a912 Leszek Koltunski
 *
723 8c3cdec5 Leszek Koltunski
 * @param shear   The 3-tuple of shear factors. The first controls level
724
 *                of shearing in the X-axis, second - Y-axis and the third -
725 a2594090 leszek
 *                Z-axis. Each is the tangens of the shear angle, i.e 0 -
726 8c3cdec5 Leszek Koltunski
 *                no shear, 1 - shear by 45 degrees (tan(45deg)=1) etc.
727 0df17fad Leszek Koltunski
 * @param center  Center of shearing, i.e. the point which stays unmoved.
728 e0a16874 Leszek Koltunski
 * @return        ID of the effect added, or -1 if we failed to add one.
729 6a06a912 Leszek Koltunski
 */
730 0df17fad Leszek Koltunski
  public long shear(Data3D shear, Data3D center)
731 6a06a912 Leszek Koltunski
    {
732 0df17fad Leszek Koltunski
    return mM.add(EffectNames.SHEAR, shear, center);
733 6a06a912 Leszek Koltunski
    }
734
735
///////////////////////////////////////////////////////////////////////////////////////////////////
736
// Fragment-based effects  
737
///////////////////////////////////////////////////////////////////////////////////////////////////
738
/**
739 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change all three of its RGB components.
740 6a06a912 Leszek Koltunski
 *        
741 2fce34f4 Leszek Koltunski
 * @param blend  1-dimensional Data that returns the level of blend a given pixel will be
742 e4878781 Leszek Koltunski
 *               mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color.
743
 *               Valid range: <0,1>
744 b1e91f2c Leszek Koltunski
 * @param color  Color to mix. (1,0,0) is RED.
745 2fce34f4 Leszek Koltunski
 * @param region Region this Effect is limited to.
746
 * @param smooth If true, the level of 'blend' will smoothly fade out towards the edges of the region.
747
 * @return       ID of the effect added, or -1 if we failed to add one.
748 6a06a912 Leszek Koltunski
 */
749 8c893ffc Leszek Koltunski
  public long chroma(Data1D blend, Data3D color, Data4D region, boolean smooth)
750 6a06a912 Leszek Koltunski
    {
751 2fce34f4 Leszek Koltunski
    return mF.add( smooth? EffectNames.SMOOTH_CHROMA:EffectNames.CHROMA, blend, color, region);
752 6a06a912 Leszek Koltunski
    }
753
754
///////////////////////////////////////////////////////////////////////////////////////////////////
755
/**
756 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change all three of its RGB components.
757
 *
758
 * @param blend  1-dimensional Data that returns the level of blend a given pixel will be
759 e4878781 Leszek Koltunski
 *               mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color.
760
 *               Valid range: <0,1>
761 b1e91f2c Leszek Koltunski
 * @param color  Color to mix. (1,0,0) is RED.
762 2fce34f4 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
763 6a06a912 Leszek Koltunski
 */
764 8c893ffc Leszek Koltunski
  public long chroma(Data1D blend, Data3D color)
765 6a06a912 Leszek Koltunski
    {
766 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.CHROMA, blend, color);
767 6a06a912 Leszek Koltunski
    }
768
769
///////////////////////////////////////////////////////////////////////////////////////////////////
770
/**
771 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its transparency level.
772 6a06a912 Leszek Koltunski
 *        
773 2fce34f4 Leszek Koltunski
 * @param alpha  1-dimensional Data that returns the level of transparency we want to have at any given
774 e4878781 Leszek Koltunski
 *               moment: pixel.a *= alpha.
775
 *               Valid range: <0,1>
776 d7bbef2f Leszek Koltunski
 * @param region Region this Effect is limited to. 
777 2fce34f4 Leszek Koltunski
 * @param smooth If true, the level of 'alpha' will smoothly fade out towards the edges of the region.
778 d7bbef2f Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one. 
779 6a06a912 Leszek Koltunski
 */
780 2fce34f4 Leszek Koltunski
  public long alpha(Data1D alpha, Data4D region, boolean smooth)
781 6a06a912 Leszek Koltunski
    {
782 2fce34f4 Leszek Koltunski
    return mF.add( smooth? EffectNames.SMOOTH_ALPHA:EffectNames.ALPHA, alpha, region);
783 6a06a912 Leszek Koltunski
    }
784
785
///////////////////////////////////////////////////////////////////////////////////////////////////
786
/**
787 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its transparency level.
788
 *
789
 * @param alpha  1-dimensional Data that returns the level of transparency we want to have at any
790 e4878781 Leszek Koltunski
 *               given moment: pixel.a *= alpha.
791
 *               Valid range: <0,1>
792 2fce34f4 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
793 6a06a912 Leszek Koltunski
 */
794 2fce34f4 Leszek Koltunski
  public long alpha(Data1D alpha)
795 6a06a912 Leszek Koltunski
    {
796 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.ALPHA, alpha);
797 6a06a912 Leszek Koltunski
    }
798
799
///////////////////////////////////////////////////////////////////////////////////////////////////
800
/**
801 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its brightness level.
802 6a06a912 Leszek Koltunski
 *        
803 2fce34f4 Leszek Koltunski
 * @param brightness 1-dimensional Data that returns the level of brightness we want to have
804 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
805 e0a16874 Leszek Koltunski
 * @param region     Region this Effect is limited to.
806 2fce34f4 Leszek Koltunski
 * @param smooth     If true, the level of 'brightness' will smoothly fade out towards the edges of the region.
807 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
808 6a06a912 Leszek Koltunski
 */
809 2fce34f4 Leszek Koltunski
  public long brightness(Data1D brightness, Data4D region, boolean smooth)
810 6a06a912 Leszek Koltunski
    {
811 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_BRIGHTNESS: EffectNames.BRIGHTNESS, brightness, region);
812 6a06a912 Leszek Koltunski
    }
813
814
///////////////////////////////////////////////////////////////////////////////////////////////////
815
/**
816 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its brightness level.
817
 *
818
 * @param brightness 1-dimensional Data that returns the level of brightness we want to have
819 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
820 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
821 6a06a912 Leszek Koltunski
 */
822 2fce34f4 Leszek Koltunski
  public long brightness(Data1D brightness)
823 6a06a912 Leszek Koltunski
    {
824 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.BRIGHTNESS, brightness);
825 6a06a912 Leszek Koltunski
    }
826
827
///////////////////////////////////////////////////////////////////////////////////////////////////
828
/**
829 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its contrast level.
830 6a06a912 Leszek Koltunski
 *        
831 2fce34f4 Leszek Koltunski
 * @param contrast 1-dimensional Data that returns the level of contrast we want to have
832 e4878781 Leszek Koltunski
 *                 at any given moment. Valid range: <0,infinity)
833 e0a16874 Leszek Koltunski
 * @param region   Region this Effect is limited to.
834 2fce34f4 Leszek Koltunski
 * @param smooth   If true, the level of 'contrast' will smoothly fade out towards the edges of the region.
835 e0a16874 Leszek Koltunski
 * @return         ID of the effect added, or -1 if we failed to add one.
836 6a06a912 Leszek Koltunski
 */
837 2fce34f4 Leszek Koltunski
  public long contrast(Data1D contrast, Data4D region, boolean smooth)
838 6a06a912 Leszek Koltunski
    {
839 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_CONTRAST:EffectNames.CONTRAST, contrast, region);
840 6a06a912 Leszek Koltunski
    }
841
842
///////////////////////////////////////////////////////////////////////////////////////////////////
843
/**
844 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its contrast level.
845
 *
846
 * @param contrast 1-dimensional Data that returns the level of contrast we want to have
847 e4878781 Leszek Koltunski
 *                 at any given moment. Valid range: <0,infinity)
848 e0a16874 Leszek Koltunski
 * @return         ID of the effect added, or -1 if we failed to add one.
849 6a06a912 Leszek Koltunski
 */
850 2fce34f4 Leszek Koltunski
  public long contrast(Data1D contrast)
851 6a06a912 Leszek Koltunski
    {
852 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.CONTRAST, contrast);
853 6a06a912 Leszek Koltunski
    }
854
855
///////////////////////////////////////////////////////////////////////////////////////////////////
856
/**
857 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its saturation level.
858 6a06a912 Leszek Koltunski
 *        
859 2fce34f4 Leszek Koltunski
 * @param saturation 1-dimensional Data that returns the level of saturation we want to have
860 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
861 e0a16874 Leszek Koltunski
 * @param region     Region this Effect is limited to.
862 2fce34f4 Leszek Koltunski
 * @param smooth     If true, the level of 'saturation' will smoothly fade out towards the edges of the region.
863 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
864 6a06a912 Leszek Koltunski
 */
865 2fce34f4 Leszek Koltunski
  public long saturation(Data1D saturation, Data4D region, boolean smooth)
866 6a06a912 Leszek Koltunski
    {
867 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_SATURATION:EffectNames.SATURATION, saturation, region);
868 6a06a912 Leszek Koltunski
    }
869
870
///////////////////////////////////////////////////////////////////////////////////////////////////
871
/**
872 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its saturation level.
873
 *
874
 * @param saturation 1-dimensional Data that returns the level of saturation we want to have
875 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
876 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
877 6a06a912 Leszek Koltunski
 */
878 2fce34f4 Leszek Koltunski
  public long saturation(Data1D saturation)
879 6a06a912 Leszek Koltunski
    {
880 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.SATURATION, saturation);
881 6a06a912 Leszek Koltunski
    }
882
883
///////////////////////////////////////////////////////////////////////////////////////////////////
884
// Vertex-based effects  
885
///////////////////////////////////////////////////////////////////////////////////////////////////
886
/**
887 e0a16874 Leszek Koltunski
 * Distort a (possibly changing in time) part of the Object by a (possibly changing in time) vector of force.
888 f2fe7e28 Leszek Koltunski
 *
889
 * @param vector 3-dimensional Vector which represents the force the Center of the Effect is
890
 *               currently being dragged with.
891 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
892 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
893
 * @return       ID of the effect added, or -1 if we failed to add one.
894 6a06a912 Leszek Koltunski
 */
895 fa6c352d Leszek Koltunski
  public long distort(Data3D vector, Data3D center, Data4D region)
896 6a06a912 Leszek Koltunski
    {  
897 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.DISTORT, vector, center, region);
898 6a06a912 Leszek Koltunski
    }
899
900
///////////////////////////////////////////////////////////////////////////////////////////////////
901
/**
902 e0a16874 Leszek Koltunski
 * Distort the whole Object by a (possibly changing in time) vector of force.
903 f2fe7e28 Leszek Koltunski
 *
904
 * @param vector 3-dimensional Vector which represents the force the Center of the Effect is
905
 *               currently being dragged with.
906 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
907 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
908 6a06a912 Leszek Koltunski
 */
909 fa6c352d Leszek Koltunski
  public long distort(Data3D vector, Data3D center)
910 d425545a Leszek Koltunski
    {
911 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.DISTORT, vector, center, null);
912 d425545a Leszek Koltunski
    }
913 6a06a912 Leszek Koltunski
914 6ebdbbf1 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
915
/**
916
 * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to
917
 * a (possibly changing in time) point on the Object.
918
 *
919
 * @param vector Vector of force that deforms the shape of the whole Object.
920
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
921
 * @param region Region that masks the Effect.
922
 * @return       ID of the effect added, or -1 if we failed to add one.
923
 */
924
  public long deform(Data3D vector, Data3D center, Data4D region)
925
    {
926
    return mV.add(EffectNames.DEFORM, vector, center, region);
927
    }
928
929 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
930
/**
931 e0a16874 Leszek Koltunski
 * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to
932 9351ad55 Leszek Koltunski
 * a (possibly changing in time) point on the Object.
933 6a06a912 Leszek Koltunski
 *     
934 f2fe7e28 Leszek Koltunski
 * @param vector Vector of force that deforms the shape of the whole Object.
935 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
936 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
937 6a06a912 Leszek Koltunski
 */
938 fa6c352d Leszek Koltunski
  public long deform(Data3D vector, Data3D center)
939 6a06a912 Leszek Koltunski
    {  
940 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.DEFORM, vector, center, null);
941 6a06a912 Leszek Koltunski
    }
942
943
///////////////////////////////////////////////////////////////////////////////////////////////////  
944
/**
945 f2fe7e28 Leszek Koltunski
 * Pull all points around the center of the Effect towards the center (if degree>=1) or push them
946 6a06a912 Leszek Koltunski
 * away from the center (degree<=1)
947 f2fe7e28 Leszek Koltunski
 *
948
 * @param sink   The current degree of the Effect.
949 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
950 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
951
 * @return       ID of the effect added, or -1 if we failed to add one.
952 6a06a912 Leszek Koltunski
 */
953 fa6c352d Leszek Koltunski
  public long sink(Data1D sink, Data3D center, Data4D region)
954 6a06a912 Leszek Koltunski
    {
955 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.SINK, sink, center, region);
956 6a06a912 Leszek Koltunski
    }
957
958
///////////////////////////////////////////////////////////////////////////////////////////////////
959
/**
960 f2fe7e28 Leszek Koltunski
 * Pull all points around the center of the Effect towards the center (if degree>=1) or push them
961
 * away from the center (degree<=1)
962
 *
963
 * @param sink   The current degree of the Effect.
964 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
965 f2fe7e28 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
966 6a06a912 Leszek Koltunski
 */
967 fa6c352d Leszek Koltunski
  public long sink(Data1D sink, Data3D center)
968 d425545a Leszek Koltunski
    {
969
    return mV.add(EffectNames.SINK, sink, center);
970
    }
971 6a06a912 Leszek Koltunski
972 82ee855a Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
973
/**
974
 * Pull all points around the center of the Effect towards a line passing through the center
975
 * (that's if degree>=1) or push them away from the line (degree<=1)
976
 *
977
 * @param pinch  The current degree of the Effect + angle the line forms with X-axis
978
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
979
 * @param region Region that masks the Effect.
980
 * @return       ID of the effect added, or -1 if we failed to add one.
981
 */
982
  public long pinch(Data2D pinch, Data3D center, Data4D region)
983
    {
984
    return mV.add(EffectNames.PINCH, pinch, center, region);
985
    }
986
987
///////////////////////////////////////////////////////////////////////////////////////////////////
988
/**
989
 * Pull all points around the center of the Effect towards a line passing through the center
990
 * (that's if degree>=1) or push them away from the line (degree<=1)
991
 *
992
 * @param pinch  The current degree of the Effect + angle the line forms with X-axis
993
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
994
 * @return       ID of the effect added, or -1 if we failed to add one.
995
 */
996
  public long pinch(Data2D pinch, Data3D center)
997
    {
998
    return mV.add(EffectNames.PINCH, pinch, center);
999
    }
1000
1001 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////  
1002
/**
1003 f2fe7e28 Leszek Koltunski
 * Rotate part of the Object around the Center of the Effect by a certain angle.
1004
 *
1005 4fde55a0 Leszek Koltunski
 * @param swirl  The angle of Swirl (in degrees). Positive values swirl clockwise.
1006 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
1007 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
1008
 * @return       ID of the effect added, or -1 if we failed to add one.
1009 6a06a912 Leszek Koltunski
 */
1010 fa6c352d Leszek Koltunski
  public long swirl(Data1D swirl, Data3D center, Data4D region)
1011 6a06a912 Leszek Koltunski
    {    
1012 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.SWIRL, swirl, center, region);
1013 6a06a912 Leszek Koltunski
    }
1014
1015
///////////////////////////////////////////////////////////////////////////////////////////////////
1016
/**
1017 f2fe7e28 Leszek Koltunski
 * Rotate the whole Object around the Center of the Effect by a certain angle.
1018
 *
1019 4fde55a0 Leszek Koltunski
 * @param swirl  The angle of Swirl (in degrees). Positive values swirl clockwise.
1020 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
1021 f2fe7e28 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
1022 6a06a912 Leszek Koltunski
 */
1023 fa6c352d Leszek Koltunski
  public long swirl(Data1D swirl, Data3D center)
1024 d425545a Leszek Koltunski
    {
1025
    return mV.add(EffectNames.SWIRL, swirl, center);
1026
    }
1027 4fde55a0 Leszek Koltunski
1028
///////////////////////////////////////////////////////////////////////////////////////////////////
1029
/**
1030
 * Directional, sinusoidal wave effect.
1031
 *
1032 350cc2f5 Leszek Koltunski
 * @param wave   A 5-dimensional data structure describing the wave: first member is the amplitude,
1033 ea16dc89 Leszek Koltunski
 *               second is the wave length, third is the phase (i.e. when phase = PI/2, the sine
1034 350cc2f5 Leszek Koltunski
 *               wave at the center does not start from sin(0), but from sin(PI/2) ) and the next two
1035
 *               describe the 'direction' of the wave.
1036 3695d6fa Leszek Koltunski
 *               <p>
1037 d0c902b8 Leszek Koltunski
 *               Wave direction is defined to be a 3D vector of length 1. To define such vectors, we
1038
 *               need 2 floats: thus the third member is the angle Alpha (in degrees) which the vector
1039
 *               forms with the XY-plane, and the fourth is the angle Beta (again in degrees) which
1040
 *               the projection of the vector to the XY-plane forms with the Y-axis (counterclockwise).
1041 3695d6fa Leszek Koltunski
 *               <p>
1042
 *               <p>
1043 d0c902b8 Leszek Koltunski
 *               Example1: if Alpha = 90, Beta = 90, (then V=(0,0,1) ) and the wave acts 'vertically'
1044
 *               in the X-direction, i.e. cross-sections of the resulting surface with the XZ-plane
1045
 *               will be sine shapes.
1046 3695d6fa Leszek Koltunski
 *               <p>
1047 d0c902b8 Leszek Koltunski
 *               Example2: if Alpha = 90, Beta = 0, the again V=(0,0,1) and the wave is 'vertical',
1048
 *               but this time it waves in the Y-direction, i.e. cross sections of the surface and the
1049
 *               YZ-plane with be sine shapes.
1050 3695d6fa Leszek Koltunski
 *               <p>
1051 d0c902b8 Leszek Koltunski
 *               Example3: if Alpha = 0 and Beta = 45, then V=(sqrt(2)/2, -sqrt(2)/2, 0) and the wave
1052 350cc2f5 Leszek Koltunski
 *               is entirely 'horizontal' and moves point (x,y,0) in direction V by whatever is the
1053
 *               value if sin at this point.
1054 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
1055 4fde55a0 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
1056
 */
1057 fa6c352d Leszek Koltunski
  public long wave(Data5D wave, Data3D center)
1058 4fde55a0 Leszek Koltunski
    {
1059 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.WAVE, wave, center, null);
1060 4fde55a0 Leszek Koltunski
    }
1061
1062
///////////////////////////////////////////////////////////////////////////////////////////////////
1063
/**
1064
 * Directional, sinusoidal wave effect.
1065
 *
1066 421c2728 Leszek Koltunski
 * @param wave   see {@link DistortedEffects#wave(Data5D,Data3D)}
1067 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
1068 4fde55a0 Leszek Koltunski
 * @param region Region that masks the Effect.
1069
 * @return       ID of the effect added, or -1 if we failed to add one.
1070
 */
1071 fa6c352d Leszek Koltunski
  public long wave(Data5D wave, Data3D center, Data4D region)
1072 4fde55a0 Leszek Koltunski
    {
1073
    return mV.add(EffectNames.WAVE, wave, center, region);
1074
    }
1075 f2fe7e28 Leszek Koltunski
  }