Project

General

Profile

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

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

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