Project

General

Profile

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

library / src / main / java / org / distorted / library / DistortedEffectQueues.java @ 7b8086eb

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