Project

General

Profile

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

library / src / main / java / org / distorted / library / DistortedEffectQueues.java @ 1942537e

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
import android.opengl.GLES20;
23
24 e458a4ba Leszek Koltunski
import org.distorted.library.message.EffectListener;
25 568b29d8 Leszek Koltunski
import org.distorted.library.type.Data1D;
26 f2fe7e28 Leszek Koltunski
import org.distorted.library.type.Data2D;
27 568b29d8 Leszek Koltunski
import org.distorted.library.type.Data3D;
28
import org.distorted.library.type.Data4D;
29 350cc2f5 Leszek Koltunski
import org.distorted.library.type.Data5D;
30 568b29d8 Leszek Koltunski
import org.distorted.library.type.Static3D;
31 a4835695 Leszek Koltunski
32 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
33 b329f352 Leszek Koltunski
/**
34 4e2382f3 Leszek Koltunski
 * Class containing {@link EffectTypes#LENGTH} queues, each a class derived from EffectQueue.
35 b73dcaa7 Leszek Koltunski
 * <p>
36 4e2382f3 Leszek Koltunski
 * The queues hold actual effects to be applied to a given (DistortedTexture,GridObject) combo.
37 b329f352 Leszek Koltunski
 */
38 4e2382f3 Leszek Koltunski
public class DistortedEffectQueues
39 d425545a Leszek Koltunski
  {
40 8e34674e Leszek Koltunski
  private static long mNextID =0;
41 4e2382f3 Leszek Koltunski
  private long mID;
42 8e34674e Leszek Koltunski
43 3d590d8d Leszek Koltunski
  private EffectQueueMatrix    mM;
44
  private EffectQueueFragment  mF;
45
  private EffectQueueVertex    mV;
46
47
  private boolean matrixCloned, vertexCloned, fragmentCloned;
48 985ea9c5 Leszek Koltunski
49 9361b337 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
50 6a06a912 Leszek Koltunski
    
51 4e2382f3 Leszek Koltunski
  private void initializeEffectLists(DistortedEffectQueues d, int flags)
52 d425545a Leszek Koltunski
    {
53 015642fb Leszek Koltunski
    if( (flags & Distorted.CLONE_MATRIX) != 0 )
54 6a06a912 Leszek Koltunski
      {
55 d425545a Leszek Koltunski
      mM = d.mM;
56
      matrixCloned = true;
57
      }
58
    else
59
      {
60 4e2382f3 Leszek Koltunski
      mM = new EffectQueueMatrix(mID);
61 d425545a Leszek Koltunski
      matrixCloned = false;
62
      }
63 6a06a912 Leszek Koltunski
    
64 d425545a Leszek Koltunski
    if( (flags & Distorted.CLONE_VERTEX) != 0 )
65
      {
66
      mV = d.mV;
67
      vertexCloned = true;
68
      }
69
    else
70
      {
71 4e2382f3 Leszek Koltunski
      mV = new EffectQueueVertex(mID);
72 d425545a Leszek Koltunski
      vertexCloned = false;
73
      }
74 6a06a912 Leszek Koltunski
    
75 d425545a Leszek Koltunski
    if( (flags & Distorted.CLONE_FRAGMENT) != 0 )
76
      {
77
      mF = d.mF;
78
      fragmentCloned = true;
79 6a06a912 Leszek Koltunski
      }
80 d425545a Leszek Koltunski
    else
81
      {
82 4e2382f3 Leszek Koltunski
      mF = new EffectQueueFragment(mID);
83 d425545a Leszek Koltunski
      fragmentCloned = false;
84
      }
85
    }
86 6a06a912 Leszek Koltunski
87
///////////////////////////////////////////////////////////////////////////////////////////////////
88
   
89 4e2382f3 Leszek Koltunski
  void drawPriv(long currTime, DistortedTexture tex, GridObject grid, DistortedFramebuffer df)
90 d425545a Leszek Koltunski
    {
91 ed13a5de Leszek Koltunski
    GLES20.glViewport(0, 0, df.mWidth, df.mHeight);
92 0a046359 Leszek Koltunski
93 3ef3364d Leszek Koltunski
    float halfZ = tex.mHalfX*grid.zFactor;
94
95 d425545a Leszek Koltunski
    mM.compute(currTime);
96 3ef3364d Leszek Koltunski
    mM.send(df,tex.mHalfX,tex.mHalfY,halfZ);
97 6a06a912 Leszek Koltunski
      
98 d425545a Leszek Koltunski
    mV.compute(currTime);
99 3ef3364d Leszek Koltunski
    mV.send(tex.mHalfX,tex.mHalfY,halfZ);
100 6a06a912 Leszek Koltunski
        
101 d425545a Leszek Koltunski
    mF.compute(currTime);
102 4e2382f3 Leszek Koltunski
    mF.send(tex.mHalfX,tex.mHalfY);
103 a56bc359 Leszek Koltunski
104
    grid.draw();
105 d425545a Leszek Koltunski
    }
106 6a06a912 Leszek Koltunski
107
///////////////////////////////////////////////////////////////////////////////////////////////////
108
   
109 4e2382f3 Leszek Koltunski
  void drawNoEffectsPriv(DistortedTexture tex, GridObject grid, DistortedFramebuffer df)
110 d425545a Leszek Koltunski
    {
111 ed13a5de Leszek Koltunski
    GLES20.glViewport(0, 0, df.mWidth, df.mHeight);
112 0a046359 Leszek Koltunski
113 3ef3364d Leszek Koltunski
    mM.sendZero(df,tex.mHalfX,tex.mHalfY,tex.mHalfX*grid.zFactor);
114 d425545a Leszek Koltunski
    mV.sendZero();
115
    mF.sendZero();
116 a56bc359 Leszek Koltunski
117
    grid.draw();
118 d425545a Leszek Koltunski
    }
119 6a06a912 Leszek Koltunski
    
120
///////////////////////////////////////////////////////////////////////////////////////////////////
121
   
122 8e34674e Leszek Koltunski
  private void releasePriv()
123 d425545a Leszek Koltunski
    {
124 8e34674e Leszek Koltunski
    if( !matrixCloned  ) mM.abortAll(false);
125
    if( !vertexCloned  ) mV.abortAll(false);
126
    if( !fragmentCloned) mF.abortAll(false);
127 d425545a Leszek Koltunski
128 4e2382f3 Leszek Koltunski
    mM = null;
129
    mV = null;
130
    mF = null;
131 8e34674e Leszek Koltunski
    }
132
133 1942537e Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
134
135
  static void release()
136
    {
137
    mNextID = 0;
138
    }
139
140 8e34674e Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
141
// PUBLIC API
142 ada90d33 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
143 d425545a Leszek Koltunski
/**
144 4e2382f3 Leszek Koltunski
 * Create empty effect queue.
145 d425545a Leszek Koltunski
 */
146 4e2382f3 Leszek Koltunski
  public DistortedEffectQueues()
147 d425545a Leszek Koltunski
    {
148 4e2382f3 Leszek Koltunski
    mID = mNextID++;
149
    initializeEffectLists(this,0);
150 d425545a Leszek Koltunski
    }
151 ada90d33 Leszek Koltunski
152
///////////////////////////////////////////////////////////////////////////////////////////////////
153 d425545a Leszek Koltunski
/**
154 4e2382f3 Leszek Koltunski
 * Copy constructor.
155 d425545a Leszek Koltunski
 * <p>
156
 * Whatever we do not clone gets created just like in the default constructor.
157
 * We only call this from the descendant's classes' constructors where we have to pay attention
158
 * to give it the appropriate type of a DistortedObject!
159
 *
160
 * @param dc    Source object to create our object from
161
 * @param flags A bitmask of values specifying what to copy.
162 e6ab30eb Leszek Koltunski
 *              For example, CLONE_VERTEX | CLONE_MATRIX.
163 d425545a Leszek Koltunski
 */
164 4e2382f3 Leszek Koltunski
  public DistortedEffectQueues(DistortedEffectQueues dc, int flags)
165 d425545a Leszek Koltunski
    {
166 8e34674e Leszek Koltunski
    mID = mNextID++;
167 4e2382f3 Leszek Koltunski
    initializeEffectLists(dc,flags);
168 d425545a Leszek Koltunski
    }
169 ada90d33 Leszek Koltunski
170 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
171
/**
172
 * Draw the DistortedObject to the location specified by current Matrix effects.    
173
 *     
174 d1e740c5 Leszek Koltunski
 * @param currTime current time, in milliseconds.
175 5d923c17 Leszek Koltunski
 *        This gets passed on to Dynamics inside the Effects that are currently applied to the
176 6a06a912 Leszek Koltunski
 *        Object.
177
 */
178 4e2382f3 Leszek Koltunski
  public void draw(long currTime, DistortedTexture tex, GridObject grid)
179 d425545a Leszek Koltunski
    {
180 1942537e Leszek Koltunski
    tex.createTexture();
181 d425545a Leszek Koltunski
    GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, 0);
182 4e2382f3 Leszek Koltunski
    GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, tex.mTextureDataH[0]);
183
    drawPriv(currTime, tex, grid, Distorted.mFramebuffer);
184 1942537e Leszek Koltunski
    DistortedFramebuffer.deleteAllMarked();
185
    DistortedTexture.deleteAllMarked();
186 d425545a Leszek Koltunski
    }
187 d1e740c5 Leszek Koltunski
188
///////////////////////////////////////////////////////////////////////////////////////////////////
189
/**
190
 * Draw the DistortedObject to the Framebuffer passed.
191
 *
192
 * @param currTime Current time, in milliseconds.
193
 * @param df       Framebuffer to render this to.
194
 */
195 4e2382f3 Leszek Koltunski
  public void draw(long currTime, DistortedTexture tex, GridObject grid, DistortedFramebuffer df)
196 d1e740c5 Leszek Koltunski
    {
197 1942537e Leszek Koltunski
    tex.createTexture();
198 d1e740c5 Leszek Koltunski
    df.setAsOutput();
199 4e2382f3 Leszek Koltunski
    GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, tex.mTextureDataH[0]);
200
    drawPriv(currTime, tex, grid, df);
201 1942537e Leszek Koltunski
    DistortedFramebuffer.deleteAllMarked();
202
    DistortedTexture.deleteAllMarked();
203 d1e740c5 Leszek Koltunski
    }
204
205 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
206
/**
207
 * Releases all resources.
208
 */
209 8e34674e Leszek Koltunski
  public synchronized void delete()
210 d425545a Leszek Koltunski
    {
211
    releasePriv();
212
    }
213 6a06a912 Leszek Koltunski
214
///////////////////////////////////////////////////////////////////////////////////////////////////
215
/**
216 4e2382f3 Leszek Koltunski
 * Returns unique ID of this instance.
217
 *
218
 * @return ID of the object.
219 6a06a912 Leszek Koltunski
 */
220 4e2382f3 Leszek Koltunski
  public long getID()
221 d425545a Leszek Koltunski
      {
222 4e2382f3 Leszek Koltunski
      return mID;
223 d425545a Leszek Koltunski
      }
224 4e2382f3 Leszek Koltunski
225 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
226
/**
227
 * Adds the calling class to the list of Listeners that get notified each time some event happens 
228 9351ad55 Leszek Koltunski
 * to one of the Effects that are currently applied to the DistortedObject.
229 6a06a912 Leszek Koltunski
 * 
230
 * @param el A class implementing the EffectListener interface that wants to get notifications.
231
 */
232 d425545a Leszek Koltunski
  public void addEventListener(EffectListener el)
233
    {
234
    mV.addListener(el);
235
    mF.addListener(el);
236
    mM.addListener(el);
237
    }
238 6a06a912 Leszek Koltunski
239
///////////////////////////////////////////////////////////////////////////////////////////////////
240
/**
241
 * Removes the calling class from the list of Listeners.
242
 * 
243
 * @param el A class implementing the EffectListener interface that no longer wants to get notifications.
244
 */
245 d425545a Leszek Koltunski
  public void removeEventListener(EffectListener el)
246
    {
247
    mV.removeListener(el);
248
    mF.removeListener(el);
249
    mM.removeListener(el);
250
    }
251 6a06a912 Leszek Koltunski
252
///////////////////////////////////////////////////////////////////////////////////////////////////
253
/**
254 d07f2950 Leszek Koltunski
 * Aborts all Effects.
255
 * @return Number of effects aborted.
256 6a06a912 Leszek Koltunski
 */
257 d425545a Leszek Koltunski
  public int abortAllEffects()
258 6a06a912 Leszek Koltunski
      {
259 0df17fad Leszek Koltunski
      return mM.abortAll(true) + mV.abortAll(true) + mF.abortAll(true);
260 6a06a912 Leszek Koltunski
      }
261
262
///////////////////////////////////////////////////////////////////////////////////////////////////
263
/**
264 d07f2950 Leszek Koltunski
 * Aborts all Effects of a given type, for example all MATRIX Effects.
265 6a06a912 Leszek Koltunski
 * 
266 d07f2950 Leszek Koltunski
 * @param type one of the constants defined in {@link EffectTypes}
267
 * @return Number of effects aborted.
268 6a06a912 Leszek Koltunski
 */
269 d425545a Leszek Koltunski
  public int abortEffects(EffectTypes type)
270
    {
271
    switch(type)
272 6a06a912 Leszek Koltunski
      {
273 0df17fad Leszek Koltunski
      case MATRIX  : return mM.abortAll(true);
274
      case VERTEX  : return mV.abortAll(true);
275
      case FRAGMENT: return mF.abortAll(true);
276 d425545a Leszek Koltunski
      default      : return 0;
277 6a06a912 Leszek Koltunski
      }
278 d425545a Leszek Koltunski
    }
279 6a06a912 Leszek Koltunski
    
280
///////////////////////////////////////////////////////////////////////////////////////////////////
281
/**
282
 * Aborts a single Effect.
283
 * 
284
 * @param id ID of the Effect we want to abort.
285 476bbc81 Leszek Koltunski
 * @return number of Effects aborted. Always either 0 or 1.
286 6a06a912 Leszek Koltunski
 */
287 d425545a Leszek Koltunski
  public int abortEffect(long id)
288
    {
289
    int type = (int)(id&EffectTypes.MASK);
290 1e438fc7 Leszek Koltunski
291 d425545a Leszek Koltunski
    if( type==EffectTypes.MATRIX.type   ) return mM.removeByID(id>>EffectTypes.LENGTH);
292
    if( type==EffectTypes.VERTEX.type   ) return mV.removeByID(id>>EffectTypes.LENGTH);
293
    if( type==EffectTypes.FRAGMENT.type ) return mF.removeByID(id>>EffectTypes.LENGTH);
294 1e438fc7 Leszek Koltunski
295 d425545a Leszek Koltunski
    return 0;
296
    }
297 6a06a912 Leszek Koltunski
298
///////////////////////////////////////////////////////////////////////////////////////////////////
299
/**
300 e8c81a8e Leszek Koltunski
 * Abort all Effects of a given name, for example all rotations.
301 6a06a912 Leszek Koltunski
 * 
302 d07f2950 Leszek Koltunski
 * @param name one of the constants defined in {@link EffectNames}
303 476bbc81 Leszek Koltunski
 * @return number of Effects aborted.
304 6a06a912 Leszek Koltunski
 */
305 d425545a Leszek Koltunski
  public int abortEffects(EffectNames name)
306
    {
307
    switch(name.getType())
308 6a06a912 Leszek Koltunski
      {
309 d425545a Leszek Koltunski
      case MATRIX  : return mM.removeByType(name);
310
      case VERTEX  : return mV.removeByType(name);
311
      case FRAGMENT: return mF.removeByType(name);
312
      default      : return 0;
313 6a06a912 Leszek Koltunski
      }
314 d425545a Leszek Koltunski
    }
315 6a06a912 Leszek Koltunski
    
316
///////////////////////////////////////////////////////////////////////////////////////////////////
317
/**
318
 * Print some info about a given Effect to Android's standard out. Used for debugging only.
319
 * 
320
 * @param id Effect ID we want to print info about
321
 * @return <code>true</code> if a single Effect of type effectType has been found.
322
 */
323
    
324 d425545a Leszek Koltunski
  public boolean printEffect(long id)
325
    {
326
    int type = (int)(id&EffectTypes.MASK);
327 1e438fc7 Leszek Koltunski
328 d425545a Leszek Koltunski
    if( type==EffectTypes.MATRIX.type   )  return mM.printByID(id>>EffectTypes.LENGTH);
329
    if( type==EffectTypes.VERTEX.type   )  return mV.printByID(id>>EffectTypes.LENGTH);
330
    if( type==EffectTypes.FRAGMENT.type )  return mF.printByID(id>>EffectTypes.LENGTH);
331 1e438fc7 Leszek Koltunski
332 d425545a Leszek Koltunski
    return false;
333
    }
334 6a06a912 Leszek Koltunski
   
335
///////////////////////////////////////////////////////////////////////////////////////////////////   
336
///////////////////////////////////////////////////////////////////////////////////////////////////
337
// Individual effect functions.
338
///////////////////////////////////////////////////////////////////////////////////////////////////
339
// Matrix-based effects
340
///////////////////////////////////////////////////////////////////////////////////////////////////
341
/**
342 e8c81a8e Leszek Koltunski
 * Moves the Object by a (possibly changing in time) vector.
343 6a06a912 Leszek Koltunski
 * 
344 568b29d8 Leszek Koltunski
 * @param vector 3-dimensional Data which at any given time will return a Static3D
345 e0a16874 Leszek Koltunski
 *               representing the current coordinates of the vector we want to move the Object with.
346
 * @return       ID of the effect added, or -1 if we failed to add one.
347 6a06a912 Leszek Koltunski
 */
348 568b29d8 Leszek Koltunski
  public long move(Data3D vector)
349 6a06a912 Leszek Koltunski
    {   
350 e0a16874 Leszek Koltunski
    return mM.add(EffectNames.MOVE,vector);
351 6a06a912 Leszek Koltunski
    }
352
353
///////////////////////////////////////////////////////////////////////////////////////////////////
354
/**
355 e8c81a8e Leszek Koltunski
 * Scales the Object by (possibly changing in time) 3D scale factors.
356 6a06a912 Leszek Koltunski
 * 
357 d1e740c5 Leszek Koltunski
 * @param scale 3-dimensional Data which at any given time returns a Static3D
358 e0a16874 Leszek Koltunski
 *              representing the current x- , y- and z- scale factors.
359
 * @return      ID of the effect added, or -1 if we failed to add one.
360 6a06a912 Leszek Koltunski
 */
361 568b29d8 Leszek Koltunski
  public long scale(Data3D scale)
362 6a06a912 Leszek Koltunski
    {   
363 e0a16874 Leszek Koltunski
    return mM.add(EffectNames.SCALE,scale);
364 6a06a912 Leszek Koltunski
    }
365
366 2fce34f4 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
367
/**
368 e8c81a8e Leszek Koltunski
 * Scales the Object by one uniform, constant factor in all 3 dimensions. Convenience function.
369 2fce34f4 Leszek Koltunski
 *
370
 * @param scale The factor to scale all 3 dimensions with.
371
 * @return      ID of the effect added, or -1 if we failed to add one.
372
 */
373 d425545a Leszek Koltunski
  public long scale(float scale)
374
    {
375
    return mM.add(EffectNames.SCALE, new Static3D(scale,scale,scale));
376
    }
377 2fce34f4 Leszek Koltunski
378 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
379
/**
380 568b29d8 Leszek Koltunski
 * Rotates the Object by 'angle' degrees around the center.
381
 * Static axis of rotation is given by the last parameter.
382
 *
383 9351ad55 Leszek Koltunski
 * @param angle  Angle that we want to rotate the Object to. Unit: degrees
384 568b29d8 Leszek Koltunski
 * @param axis   Axis of rotation
385 0df17fad Leszek Koltunski
 * @param center Coordinates of the Point we are rotating around.
386 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
387
 */
388 0df17fad Leszek Koltunski
  public long rotate(Data1D angle, Static3D axis, Data3D center )
389 6a06a912 Leszek Koltunski
    {   
390 0df17fad Leszek Koltunski
    return mM.add(EffectNames.ROTATE, angle, axis, center);
391 6a06a912 Leszek Koltunski
    }
392
393
///////////////////////////////////////////////////////////////////////////////////////////////////
394
/**
395 568b29d8 Leszek Koltunski
 * Rotates the Object by 'angle' degrees around the center.
396 2fce34f4 Leszek Koltunski
 * Here both angle and axis can dynamically change.
397 568b29d8 Leszek Koltunski
 *
398
 * @param angleaxis Combined 4-tuple representing the (angle,axisX,axisY,axisZ).
399 0df17fad Leszek Koltunski
 * @param center    Coordinates of the Point we are rotating around.
400 568b29d8 Leszek Koltunski
 * @return          ID of the effect added, or -1 if we failed to add one.
401 e0a16874 Leszek Koltunski
 */
402 0df17fad Leszek Koltunski
  public long rotate(Data4D angleaxis, Data3D center)
403 568b29d8 Leszek Koltunski
    {
404 0df17fad Leszek Koltunski
    return mM.add(EffectNames.ROTATE, angleaxis, center);
405 6a06a912 Leszek Koltunski
    }
406
407
///////////////////////////////////////////////////////////////////////////////////////////////////
408
/**
409 568b29d8 Leszek Koltunski
 * Rotates the Object by quaternion.
410 0df17fad Leszek Koltunski
 *
411 568b29d8 Leszek Koltunski
 * @param quaternion The quaternion describing the rotation.
412 0df17fad Leszek Koltunski
 * @param center     Coordinates of the Point we are rotating around.
413 568b29d8 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
414 6a06a912 Leszek Koltunski
 */
415 0df17fad Leszek Koltunski
  public long quaternion(Data4D quaternion, Data3D center )
416 568b29d8 Leszek Koltunski
    {
417 0df17fad Leszek Koltunski
    return mM.add(EffectNames.QUATERNION,quaternion,center);
418 6a06a912 Leszek Koltunski
    }
419
420
///////////////////////////////////////////////////////////////////////////////////////////////////
421
/**
422 568b29d8 Leszek Koltunski
 * Shears the Object.
423 6a06a912 Leszek Koltunski
 *
424 8c3cdec5 Leszek Koltunski
 * @param shear   The 3-tuple of shear factors. The first controls level
425
 *                of shearing in the X-axis, second - Y-axis and the third -
426
 *                Z-axis. Each is the tangens of the shear angle, i.e 0 -
427
 *                no shear, 1 - shear by 45 degrees (tan(45deg)=1) etc.
428 0df17fad Leszek Koltunski
 * @param center  Center of shearing, i.e. the point which stays unmoved.
429 e0a16874 Leszek Koltunski
 * @return        ID of the effect added, or -1 if we failed to add one.
430 6a06a912 Leszek Koltunski
 */
431 0df17fad Leszek Koltunski
  public long shear(Data3D shear, Data3D center)
432 6a06a912 Leszek Koltunski
    {
433 0df17fad Leszek Koltunski
    return mM.add(EffectNames.SHEAR, shear, center);
434 6a06a912 Leszek Koltunski
    }
435
436
///////////////////////////////////////////////////////////////////////////////////////////////////
437
// Fragment-based effects  
438
///////////////////////////////////////////////////////////////////////////////////////////////////
439
/**
440 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change all three of its RGB components.
441 6a06a912 Leszek Koltunski
 *        
442 2fce34f4 Leszek Koltunski
 * @param blend  1-dimensional Data that returns the level of blend a given pixel will be
443 e4878781 Leszek Koltunski
 *               mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color.
444
 *               Valid range: <0,1>
445 b1e91f2c Leszek Koltunski
 * @param color  Color to mix. (1,0,0) is RED.
446 2fce34f4 Leszek Koltunski
 * @param region Region this Effect is limited to.
447
 * @param smooth If true, the level of 'blend' will smoothly fade out towards the edges of the region.
448
 * @return       ID of the effect added, or -1 if we failed to add one.
449 6a06a912 Leszek Koltunski
 */
450 8c893ffc Leszek Koltunski
  public long chroma(Data1D blend, Data3D color, Data4D region, boolean smooth)
451 6a06a912 Leszek Koltunski
    {
452 2fce34f4 Leszek Koltunski
    return mF.add( smooth? EffectNames.SMOOTH_CHROMA:EffectNames.CHROMA, blend, color, region);
453 6a06a912 Leszek Koltunski
    }
454
455
///////////////////////////////////////////////////////////////////////////////////////////////////
456
/**
457 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change all three of its RGB components.
458
 *
459
 * @param blend  1-dimensional Data that returns the level of blend a given pixel will be
460 e4878781 Leszek Koltunski
 *               mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color.
461
 *               Valid range: <0,1>
462 b1e91f2c Leszek Koltunski
 * @param color  Color to mix. (1,0,0) is RED.
463 2fce34f4 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
464 6a06a912 Leszek Koltunski
 */
465 8c893ffc Leszek Koltunski
  public long chroma(Data1D blend, Data3D color)
466 6a06a912 Leszek Koltunski
    {
467 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.CHROMA, blend, color);
468 6a06a912 Leszek Koltunski
    }
469
470
///////////////////////////////////////////////////////////////////////////////////////////////////
471
/**
472 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its transparency level.
473 6a06a912 Leszek Koltunski
 *        
474 2fce34f4 Leszek Koltunski
 * @param alpha  1-dimensional Data that returns the level of transparency we want to have at any given
475 e4878781 Leszek Koltunski
 *               moment: pixel.a *= alpha.
476
 *               Valid range: <0,1>
477 d7bbef2f Leszek Koltunski
 * @param region Region this Effect is limited to. 
478 2fce34f4 Leszek Koltunski
 * @param smooth If true, the level of 'alpha' will smoothly fade out towards the edges of the region.
479 d7bbef2f Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one. 
480 6a06a912 Leszek Koltunski
 */
481 2fce34f4 Leszek Koltunski
  public long alpha(Data1D alpha, Data4D region, boolean smooth)
482 6a06a912 Leszek Koltunski
    {
483 2fce34f4 Leszek Koltunski
    return mF.add( smooth? EffectNames.SMOOTH_ALPHA:EffectNames.ALPHA, alpha, region);
484 6a06a912 Leszek Koltunski
    }
485
486
///////////////////////////////////////////////////////////////////////////////////////////////////
487
/**
488 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its transparency level.
489
 *
490
 * @param alpha  1-dimensional Data that returns the level of transparency we want to have at any
491 e4878781 Leszek Koltunski
 *               given moment: pixel.a *= alpha.
492
 *               Valid range: <0,1>
493 2fce34f4 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
494 6a06a912 Leszek Koltunski
 */
495 2fce34f4 Leszek Koltunski
  public long alpha(Data1D alpha)
496 6a06a912 Leszek Koltunski
    {
497 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.ALPHA, alpha);
498 6a06a912 Leszek Koltunski
    }
499
500
///////////////////////////////////////////////////////////////////////////////////////////////////
501
/**
502 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its brightness level.
503 6a06a912 Leszek Koltunski
 *        
504 2fce34f4 Leszek Koltunski
 * @param brightness 1-dimensional Data that returns the level of brightness we want to have
505 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
506 e0a16874 Leszek Koltunski
 * @param region     Region this Effect is limited to.
507 2fce34f4 Leszek Koltunski
 * @param smooth     If true, the level of 'brightness' will smoothly fade out towards the edges of the region.
508 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
509 6a06a912 Leszek Koltunski
 */
510 2fce34f4 Leszek Koltunski
  public long brightness(Data1D brightness, Data4D region, boolean smooth)
511 6a06a912 Leszek Koltunski
    {
512 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_BRIGHTNESS: EffectNames.BRIGHTNESS, brightness, region);
513 6a06a912 Leszek Koltunski
    }
514
515
///////////////////////////////////////////////////////////////////////////////////////////////////
516
/**
517 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its brightness level.
518
 *
519
 * @param brightness 1-dimensional Data that returns the level of brightness we want to have
520 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
521 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
522 6a06a912 Leszek Koltunski
 */
523 2fce34f4 Leszek Koltunski
  public long brightness(Data1D brightness)
524 6a06a912 Leszek Koltunski
    {
525 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.BRIGHTNESS, brightness);
526 6a06a912 Leszek Koltunski
    }
527
528
///////////////////////////////////////////////////////////////////////////////////////////////////
529
/**
530 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its contrast level.
531 6a06a912 Leszek Koltunski
 *        
532 2fce34f4 Leszek Koltunski
 * @param contrast 1-dimensional Data that returns the level of contrast we want to have
533 e4878781 Leszek Koltunski
 *                 at any given moment. Valid range: <0,infinity)
534 e0a16874 Leszek Koltunski
 * @param region   Region this Effect is limited to.
535 2fce34f4 Leszek Koltunski
 * @param smooth   If true, the level of 'contrast' will smoothly fade out towards the edges of the region.
536 e0a16874 Leszek Koltunski
 * @return         ID of the effect added, or -1 if we failed to add one.
537 6a06a912 Leszek Koltunski
 */
538 2fce34f4 Leszek Koltunski
  public long contrast(Data1D contrast, Data4D region, boolean smooth)
539 6a06a912 Leszek Koltunski
    {
540 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_CONTRAST:EffectNames.CONTRAST, contrast, region);
541 6a06a912 Leszek Koltunski
    }
542
543
///////////////////////////////////////////////////////////////////////////////////////////////////
544
/**
545 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its contrast level.
546
 *
547
 * @param contrast 1-dimensional Data that returns the level of contrast we want to have
548 e4878781 Leszek Koltunski
 *                 at any given moment. Valid range: <0,infinity)
549 e0a16874 Leszek Koltunski
 * @return         ID of the effect added, or -1 if we failed to add one.
550 6a06a912 Leszek Koltunski
 */
551 2fce34f4 Leszek Koltunski
  public long contrast(Data1D contrast)
552 6a06a912 Leszek Koltunski
    {
553 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.CONTRAST, contrast);
554 6a06a912 Leszek Koltunski
    }
555
556
///////////////////////////////////////////////////////////////////////////////////////////////////
557
/**
558 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its saturation level.
559 6a06a912 Leszek Koltunski
 *        
560 2fce34f4 Leszek Koltunski
 * @param saturation 1-dimensional Data that returns the level of saturation we want to have
561 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
562 e0a16874 Leszek Koltunski
 * @param region     Region this Effect is limited to.
563 2fce34f4 Leszek Koltunski
 * @param smooth     If true, the level of 'saturation' will smoothly fade out towards the edges of the region.
564 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
565 6a06a912 Leszek Koltunski
 */
566 2fce34f4 Leszek Koltunski
  public long saturation(Data1D saturation, Data4D region, boolean smooth)
567 6a06a912 Leszek Koltunski
    {
568 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_SATURATION:EffectNames.SATURATION, saturation, region);
569 6a06a912 Leszek Koltunski
    }
570
571
///////////////////////////////////////////////////////////////////////////////////////////////////
572
/**
573 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its saturation level.
574
 *
575
 * @param saturation 1-dimensional Data that returns the level of saturation we want to have
576 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
577 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
578 6a06a912 Leszek Koltunski
 */
579 2fce34f4 Leszek Koltunski
  public long saturation(Data1D saturation)
580 6a06a912 Leszek Koltunski
    {
581 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.SATURATION, saturation);
582 6a06a912 Leszek Koltunski
    }
583
584
///////////////////////////////////////////////////////////////////////////////////////////////////
585
// Vertex-based effects  
586
///////////////////////////////////////////////////////////////////////////////////////////////////
587
/**
588 e0a16874 Leszek Koltunski
 * Distort a (possibly changing in time) part of the Object by a (possibly changing in time) vector of force.
589 f2fe7e28 Leszek Koltunski
 *
590
 * @param vector 3-dimensional Vector which represents the force the Center of the Effect is
591
 *               currently being dragged with.
592 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
593 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
594
 * @return       ID of the effect added, or -1 if we failed to add one.
595 6a06a912 Leszek Koltunski
 */
596 fa6c352d Leszek Koltunski
  public long distort(Data3D vector, Data3D center, Data4D region)
597 6a06a912 Leszek Koltunski
    {  
598 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.DISTORT, vector, center, region);
599 6a06a912 Leszek Koltunski
    }
600
601
///////////////////////////////////////////////////////////////////////////////////////////////////
602
/**
603 e0a16874 Leszek Koltunski
 * Distort the whole Object by a (possibly changing in time) vector of force.
604 f2fe7e28 Leszek Koltunski
 *
605
 * @param vector 3-dimensional Vector which represents the force the Center of the Effect is
606
 *               currently being dragged with.
607 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
608 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
609 6a06a912 Leszek Koltunski
 */
610 fa6c352d Leszek Koltunski
  public long distort(Data3D vector, Data3D center)
611 d425545a Leszek Koltunski
    {
612 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.DISTORT, vector, center, null);
613 d425545a Leszek Koltunski
    }
614 6a06a912 Leszek Koltunski
615 6ebdbbf1 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
616
/**
617
 * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to
618
 * a (possibly changing in time) point on the Object.
619
 *
620
 * @param vector Vector of force that deforms the shape of the whole Object.
621
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
622
 * @param region Region that masks the Effect.
623
 * @return       ID of the effect added, or -1 if we failed to add one.
624
 */
625
  public long deform(Data3D vector, Data3D center, Data4D region)
626
    {
627
    return mV.add(EffectNames.DEFORM, vector, center, region);
628
    }
629
630 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
631
/**
632 e0a16874 Leszek Koltunski
 * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to
633 9351ad55 Leszek Koltunski
 * a (possibly changing in time) point on the Object.
634 6a06a912 Leszek Koltunski
 *     
635 f2fe7e28 Leszek Koltunski
 * @param vector Vector of force that deforms the shape of the whole Object.
636 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
637 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
638 6a06a912 Leszek Koltunski
 */
639 fa6c352d Leszek Koltunski
  public long deform(Data3D vector, Data3D center)
640 6a06a912 Leszek Koltunski
    {  
641 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.DEFORM, vector, center, null);
642 6a06a912 Leszek Koltunski
    }
643
644
///////////////////////////////////////////////////////////////////////////////////////////////////  
645
/**
646 f2fe7e28 Leszek Koltunski
 * Pull all points around the center of the Effect towards the center (if degree>=1) or push them
647 6a06a912 Leszek Koltunski
 * away from the center (degree<=1)
648 f2fe7e28 Leszek Koltunski
 *
649
 * @param sink   The current degree of the Effect.
650 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
651 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
652
 * @return       ID of the effect added, or -1 if we failed to add one.
653 6a06a912 Leszek Koltunski
 */
654 fa6c352d Leszek Koltunski
  public long sink(Data1D sink, Data3D center, Data4D region)
655 6a06a912 Leszek Koltunski
    {
656 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.SINK, sink, center, region);
657 6a06a912 Leszek Koltunski
    }
658
659
///////////////////////////////////////////////////////////////////////////////////////////////////
660
/**
661 f2fe7e28 Leszek Koltunski
 * Pull all points around the center of the Effect towards the center (if degree>=1) or push them
662
 * away from the center (degree<=1)
663
 *
664
 * @param sink   The current degree of the Effect.
665 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
666 f2fe7e28 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
667 6a06a912 Leszek Koltunski
 */
668 fa6c352d Leszek Koltunski
  public long sink(Data1D sink, Data3D center)
669 d425545a Leszek Koltunski
    {
670
    return mV.add(EffectNames.SINK, sink, center);
671
    }
672 6a06a912 Leszek Koltunski
673 82ee855a Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
674
/**
675
 * Pull all points around the center of the Effect towards a line passing through the center
676
 * (that's if degree>=1) or push them away from the line (degree<=1)
677
 *
678
 * @param pinch  The current degree of the Effect + angle the line forms with X-axis
679
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
680
 * @param region Region that masks the Effect.
681
 * @return       ID of the effect added, or -1 if we failed to add one.
682
 */
683
  public long pinch(Data2D pinch, Data3D center, Data4D region)
684
    {
685
    return mV.add(EffectNames.PINCH, pinch, center, region);
686
    }
687
688
///////////////////////////////////////////////////////////////////////////////////////////////////
689
/**
690
 * Pull all points around the center of the Effect towards a line passing through the center
691
 * (that's if degree>=1) or push them away from the line (degree<=1)
692
 *
693
 * @param pinch  The current degree of the Effect + angle the line forms with X-axis
694
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
695
 * @return       ID of the effect added, or -1 if we failed to add one.
696
 */
697
  public long pinch(Data2D pinch, Data3D center)
698
    {
699
    return mV.add(EffectNames.PINCH, pinch, center);
700
    }
701
702 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////  
703
/**
704 f2fe7e28 Leszek Koltunski
 * Rotate part of the Object around the Center of the Effect by a certain angle.
705
 *
706 4fde55a0 Leszek Koltunski
 * @param swirl  The angle of Swirl (in degrees). Positive values swirl clockwise.
707 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
708 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
709
 * @return       ID of the effect added, or -1 if we failed to add one.
710 6a06a912 Leszek Koltunski
 */
711 fa6c352d Leszek Koltunski
  public long swirl(Data1D swirl, Data3D center, Data4D region)
712 6a06a912 Leszek Koltunski
    {    
713 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.SWIRL, swirl, center, region);
714 6a06a912 Leszek Koltunski
    }
715
716
///////////////////////////////////////////////////////////////////////////////////////////////////
717
/**
718 f2fe7e28 Leszek Koltunski
 * Rotate the whole Object around the Center of the Effect by a certain angle.
719
 *
720 4fde55a0 Leszek Koltunski
 * @param swirl  The angle of Swirl (in degrees). Positive values swirl clockwise.
721 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
722 f2fe7e28 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
723 6a06a912 Leszek Koltunski
 */
724 fa6c352d Leszek Koltunski
  public long swirl(Data1D swirl, Data3D center)
725 d425545a Leszek Koltunski
    {
726
    return mV.add(EffectNames.SWIRL, swirl, center);
727
    }
728 4fde55a0 Leszek Koltunski
729
///////////////////////////////////////////////////////////////////////////////////////////////////
730
/**
731
 * Directional, sinusoidal wave effect.
732
 *
733 350cc2f5 Leszek Koltunski
 * @param wave   A 5-dimensional data structure describing the wave: first member is the amplitude,
734 ea16dc89 Leszek Koltunski
 *               second is the wave length, third is the phase (i.e. when phase = PI/2, the sine
735 350cc2f5 Leszek Koltunski
 *               wave at the center does not start from sin(0), but from sin(PI/2) ) and the next two
736
 *               describe the 'direction' of the wave.
737 3695d6fa Leszek Koltunski
 *               <p>
738 d0c902b8 Leszek Koltunski
 *               Wave direction is defined to be a 3D vector of length 1. To define such vectors, we
739
 *               need 2 floats: thus the third member is the angle Alpha (in degrees) which the vector
740
 *               forms with the XY-plane, and the fourth is the angle Beta (again in degrees) which
741
 *               the projection of the vector to the XY-plane forms with the Y-axis (counterclockwise).
742 3695d6fa Leszek Koltunski
 *               <p>
743
 *               <p>
744 d0c902b8 Leszek Koltunski
 *               Example1: if Alpha = 90, Beta = 90, (then V=(0,0,1) ) and the wave acts 'vertically'
745
 *               in the X-direction, i.e. cross-sections of the resulting surface with the XZ-plane
746
 *               will be sine shapes.
747 3695d6fa Leszek Koltunski
 *               <p>
748 d0c902b8 Leszek Koltunski
 *               Example2: if Alpha = 90, Beta = 0, the again V=(0,0,1) and the wave is 'vertical',
749
 *               but this time it waves in the Y-direction, i.e. cross sections of the surface and the
750
 *               YZ-plane with be sine shapes.
751 3695d6fa Leszek Koltunski
 *               <p>
752 d0c902b8 Leszek Koltunski
 *               Example3: if Alpha = 0 and Beta = 45, then V=(sqrt(2)/2, -sqrt(2)/2, 0) and the wave
753 350cc2f5 Leszek Koltunski
 *               is entirely 'horizontal' and moves point (x,y,0) in direction V by whatever is the
754
 *               value if sin at this point.
755 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
756 4fde55a0 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
757
 */
758 fa6c352d Leszek Koltunski
  public long wave(Data5D wave, Data3D center)
759 4fde55a0 Leszek Koltunski
    {
760 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.WAVE, wave, center, null);
761 4fde55a0 Leszek Koltunski
    }
762
763
///////////////////////////////////////////////////////////////////////////////////////////////////
764
/**
765
 * Directional, sinusoidal wave effect.
766
 *
767 3ef3364d Leszek Koltunski
 * @param wave   see {@link DistortedEffectQueues#wave(Data5D,Data3D)}
768 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
769 4fde55a0 Leszek Koltunski
 * @param region Region that masks the Effect.
770
 * @return       ID of the effect added, or -1 if we failed to add one.
771
 */
772 fa6c352d Leszek Koltunski
  public long wave(Data5D wave, Data3D center, Data4D region)
773 4fde55a0 Leszek Koltunski
    {
774
    return mV.add(EffectNames.WAVE, wave, center, region);
775
    }
776 f2fe7e28 Leszek Koltunski
  }