Project

General

Profile

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

library / src / main / java / org / distorted / library / DistortedEffectQueues.java @ b6a5d557

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