Project

General

Profile

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

library / src / main / java / org / distorted / library / DistortedObject.java @ 8e34674e

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.graphics.Bitmap;
23 985ea9c5 Leszek Koltunski
import android.graphics.Matrix;
24 6a06a912 Leszek Koltunski
import android.opengl.GLES20;
25
import android.opengl.GLUtils;
26
27 e458a4ba Leszek Koltunski
import org.distorted.library.message.EffectListener;
28 568b29d8 Leszek Koltunski
import org.distorted.library.type.Data1D;
29 f2fe7e28 Leszek Koltunski
import org.distorted.library.type.Data2D;
30 568b29d8 Leszek Koltunski
import org.distorted.library.type.Data3D;
31
import org.distorted.library.type.Data4D;
32 350cc2f5 Leszek Koltunski
import org.distorted.library.type.Data5D;
33 568b29d8 Leszek Koltunski
import org.distorted.library.type.Static3D;
34 a4835695 Leszek Koltunski
35 8e34674e Leszek Koltunski
import java.util.HashMap;
36
37 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
38 b329f352 Leszek Koltunski
/**
39 437bc43e Leszek Koltunski
 * All Objects to which Distorted Graphics effects can be applied need to be extended from here.
40 8e34674e Leszek Koltunski
 *
41
 * Just like in DistortedNode and DistortedFramebuffer, we need to have a static list of all
42
 * DistortedObjects currently created by the application so that we can implement the 'mark for
43
 * deletion now - actually delete on next render' thing.
44
 * We need to be able to quickly retrieve an Object by its ID, thus a HashMap.
45 b329f352 Leszek Koltunski
 */
46 6a06a912 Leszek Koltunski
public abstract class DistortedObject 
47 d425545a Leszek Koltunski
  {
48 8e34674e Leszek Koltunski
  private static long mNextID =0;
49
  private static HashMap<Long,DistortedObject> mObjects = new HashMap<>();
50
51 3d590d8d Leszek Koltunski
  private EffectQueueMatrix    mM;
52
  private EffectQueueFragment  mF;
53
  private EffectQueueVertex    mV;
54
55
  private boolean matrixCloned, vertexCloned, fragmentCloned;
56
  private long mID;
57
  private int mSizeX, mSizeY, mSizeZ; // in screen space
58 6a06a912 Leszek Koltunski
59 d425545a Leszek Koltunski
  protected DistortedObjectGrid mGrid = null;
60 6a06a912 Leszek Koltunski
61 3d590d8d Leszek Koltunski
  private Bitmap[] mBmp= null; //
62
  int[] mTextureDataH;         // have to be shared among all the cloned Objects
63
  boolean[] mBitmapSet;        //
64 9361b337 Leszek Koltunski
65 985ea9c5 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
66
// We have to flip vertically every single Bitmap that we get fed with.
67
//
68
// Reason: textures read from files are the only objects in OpenGL which have their origins at the
69
// upper-left corner. Everywhere else the origin is in the lower-left corner. Thus we have to flip.
70
// The alternative solution, namely inverting the y-coordinate of the TexCoord does not really work-
71
// i.e. it works only in case of rendering directly to the screen, but if we render to an FBO and
72
// then take the FBO and render to screen, (DistortedNode does so!) things get inverted as textures
73
// created from FBO have their origins in the lower-left... Mindfuck!
74
75
  private static Bitmap flipBitmap(Bitmap src)
76
    {
77
    Matrix matrix = new Matrix();
78
    matrix.preScale(1.0f,-1.0f);
79
80
    return Bitmap.createBitmap(src,0,0,src.getWidth(),src.getHeight(), matrix,true);
81
    }
82
83 9361b337 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
84
85 d425545a Leszek Koltunski
  protected abstract DistortedObject deepCopy(int flags);
86 9361b337 Leszek Koltunski
87 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
88
89 3d590d8d Leszek Koltunski
  protected void initializeData(int x, int y, int z)
90 d425545a Leszek Koltunski
    {
91 3d590d8d Leszek Koltunski
    mSizeX= x;
92
    mSizeY= y;
93
    mSizeZ= z;
94
95 8e34674e Leszek Koltunski
    mID = mNextID++;
96
    mObjects.put(mID,this);
97
98 d425545a Leszek Koltunski
    mTextureDataH   = new int[1];
99
    mTextureDataH[0]= 0;
100
    mBmp            = new Bitmap[1];
101
    mBmp[0]         = null;
102
    mBitmapSet      = new boolean[1];
103
    mBitmapSet[0]   = false;
104 6a06a912 Leszek Koltunski
      
105 d425545a Leszek Koltunski
    initializeEffectLists(this,0);
106 6a06a912 Leszek Koltunski
      
107 d425545a Leszek Koltunski
    if( Distorted.isInitialized() ) resetTexture();
108
    }
109 6a06a912 Leszek Koltunski
    
110
///////////////////////////////////////////////////////////////////////////////////////////////////
111
    
112 3d590d8d Leszek Koltunski
  private void initializeEffectLists(DistortedObject d, int flags)
113 d425545a Leszek Koltunski
    {
114 015642fb Leszek Koltunski
    if( (flags & Distorted.CLONE_MATRIX) != 0 )
115 6a06a912 Leszek Koltunski
      {
116 d425545a Leszek Koltunski
      mM = d.mM;
117
      matrixCloned = true;
118
      }
119
    else
120
      {
121
      mM = new EffectQueueMatrix(d);
122
      matrixCloned = false;
123
      }
124 6a06a912 Leszek Koltunski
    
125 d425545a Leszek Koltunski
    if( (flags & Distorted.CLONE_VERTEX) != 0 )
126
      {
127
      mV = d.mV;
128
      vertexCloned = true;
129
      }
130
    else
131
      {
132
      mV = new EffectQueueVertex(d);
133
      vertexCloned = false;
134
      }
135 6a06a912 Leszek Koltunski
    
136 d425545a Leszek Koltunski
    if( (flags & Distorted.CLONE_FRAGMENT) != 0 )
137
      {
138
      mF = d.mF;
139
      fragmentCloned = true;
140 6a06a912 Leszek Koltunski
      }
141 d425545a Leszek Koltunski
    else
142
      {
143
      mF = new EffectQueueFragment(d);
144
      fragmentCloned = false;
145
      }
146
    }
147 6a06a912 Leszek Koltunski
    
148
///////////////////////////////////////////////////////////////////////////////////////////////////
149
// this will be called on startup and every time OpenGL context has been lost
150
// also call this from the constructor if the OpenGL context has been created already.
151
    
152 8e34674e Leszek Koltunski
  private void resetTexture()
153 d425545a Leszek Koltunski
    {
154
    if( mTextureDataH!=null )
155 6a06a912 Leszek Koltunski
      {
156 d425545a Leszek Koltunski
      if( mTextureDataH[0]==0 ) GLES20.glGenTextures(1, mTextureDataH, 0);
157 6a06a912 Leszek Koltunski
158 d425545a Leszek Koltunski
      GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, mTextureDataH[0]);
159
      GLES20.glTexParameteri ( GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_MIN_FILTER, GLES20.GL_LINEAR );
160
      GLES20.glTexParameteri ( GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_MAG_FILTER, GLES20.GL_LINEAR );
161
      GLES20.glTexParameteri ( GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_WRAP_S, GLES20.GL_CLAMP_TO_EDGE );
162
      GLES20.glTexParameteri ( GLES20.GL_TEXTURE_2D, GLES20.GL_TEXTURE_WRAP_T, GLES20.GL_CLAMP_TO_EDGE );
163 6a06a912 Leszek Koltunski
       
164 d425545a Leszek Koltunski
      if( mBmp!=null && mBmp[0]!=null)
165
        {
166 985ea9c5 Leszek Koltunski
        GLUtils.texImage2D(GLES20.GL_TEXTURE_2D, 0, flipBitmap(mBmp[0]), 0);
167 d425545a Leszek Koltunski
        mBmp[0] = null;
168 6a06a912 Leszek Koltunski
        }
169
      }
170 d425545a Leszek Koltunski
    }
171 6a06a912 Leszek Koltunski
  
172
///////////////////////////////////////////////////////////////////////////////////////////////////
173
   
174 ed13a5de Leszek Koltunski
  void drawPriv(long currTime, DistortedFramebuffer df)
175 d425545a Leszek Koltunski
    {
176 8e34674e Leszek Koltunski
    DistortedFramebuffer.deleteAllMarked();
177 16d8b8f3 Leszek Koltunski
178 ed13a5de Leszek Koltunski
    GLES20.glViewport(0, 0, df.mWidth, df.mHeight);
179 6a06a912 Leszek Koltunski
      
180 d425545a Leszek Koltunski
    mM.compute(currTime);
181 ed13a5de Leszek Koltunski
    mM.send(df);
182 6a06a912 Leszek Koltunski
      
183 d425545a Leszek Koltunski
    mV.compute(currTime);
184
    mV.send();
185 6a06a912 Leszek Koltunski
        
186 d425545a Leszek Koltunski
    mF.compute(currTime);
187
    mF.send();
188 6a06a912 Leszek Koltunski
       
189 d425545a Leszek Koltunski
    mGrid.draw();
190
    }
191 6a06a912 Leszek Koltunski
192
///////////////////////////////////////////////////////////////////////////////////////////////////
193
   
194 ed13a5de Leszek Koltunski
  void drawNoEffectsPriv(DistortedFramebuffer df)
195 d425545a Leszek Koltunski
    {
196 ed13a5de Leszek Koltunski
    GLES20.glViewport(0, 0, df.mWidth, df.mHeight);
197
    mM.sendZero(df);
198 d425545a Leszek Koltunski
    mV.sendZero();
199
    mF.sendZero();
200
    mGrid.draw();
201
    }
202 6a06a912 Leszek Koltunski
    
203
///////////////////////////////////////////////////////////////////////////////////////////////////
204
   
205 8e34674e Leszek Koltunski
  private void releasePriv()
206 d425545a Leszek Koltunski
    {
207 8e34674e Leszek Koltunski
    if( !matrixCloned  ) mM.abortAll(false);
208
    if( !vertexCloned  ) mV.abortAll(false);
209
    if( !fragmentCloned) mF.abortAll(false);
210 d425545a Leszek Koltunski
211
    mBmp          = null;
212
    mGrid         = null;
213
    mM            = null;
214
    mV            = null;
215
    mF            = null;
216
    mTextureDataH = null;
217
    }
218 6a06a912 Leszek Koltunski
 
219
///////////////////////////////////////////////////////////////////////////////////////////////////
220
221 d425545a Leszek Koltunski
  long getBitmapID()
222 8e34674e Leszek Koltunski
    {
223
    return mBmp==null ? 0 : mBmp.hashCode();
224
    }
225
226
///////////////////////////////////////////////////////////////////////////////////////////////////
227
228
  static synchronized void reset()
229
    {
230
    for(long id: mObjects.keySet())
231 6a06a912 Leszek Koltunski
      {
232 8e34674e Leszek Koltunski
      mObjects.get(id).resetTexture();
233
      }
234
    }
235
236
///////////////////////////////////////////////////////////////////////////////////////////////////
237
238
  static synchronized void release()
239
    {
240
    for(long id: mObjects.keySet())
241
      {
242
      mObjects.get(id).releasePriv();
243 6a06a912 Leszek Koltunski
      }
244
245 8e34674e Leszek Koltunski
    mObjects.clear();
246
    mNextID = 0;
247
    }
248
249
///////////////////////////////////////////////////////////////////////////////////////////////////
250
// PUBLIC API
251 ada90d33 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
252 d425545a Leszek Koltunski
/**
253
 * Default empty constructor so that derived classes can call it
254
 */
255
  public DistortedObject()
256
    {
257 ada90d33 Leszek Koltunski
258 d425545a Leszek Koltunski
    }
259 ada90d33 Leszek Koltunski
260
///////////////////////////////////////////////////////////////////////////////////////////////////
261 d425545a Leszek Koltunski
/**
262
 * Copy constructor used to create a DistortedObject based on various parts of another object.
263
 * <p>
264
 * Whatever we do not clone gets created just like in the default constructor.
265
 * We only call this from the descendant's classes' constructors where we have to pay attention
266
 * to give it the appropriate type of a DistortedObject!
267
 *
268
 * @param dc    Source object to create our object from
269
 * @param flags A bitmask of values specifying what to copy.
270
 *              For example, CLONE_BITMAP | CLONE_MATRIX.
271
 */
272
  public DistortedObject(DistortedObject dc, int flags)
273
    {
274
    initializeEffectLists(dc,flags);
275 ada90d33 Leszek Koltunski
276 8e34674e Leszek Koltunski
    mID = mNextID++;
277
    mObjects.put(mID,this);
278 ada90d33 Leszek Koltunski
279 d425545a Leszek Koltunski
    mSizeX = dc.mSizeX;
280
    mSizeY = dc.mSizeY;
281
    mSizeZ = dc.mSizeZ;
282
    mGrid  = dc.mGrid;
283 ada90d33 Leszek Koltunski
284 d425545a Leszek Koltunski
    if( (flags & Distorted.CLONE_BITMAP) != 0 )
285
      {
286
      mTextureDataH = dc.mTextureDataH;
287
      mBmp          = dc.mBmp;
288
      mBitmapSet    = dc.mBitmapSet;
289 ada90d33 Leszek Koltunski
      }
290 d425545a Leszek Koltunski
    else
291
      {
292
      mTextureDataH   = new int[1];
293
      mTextureDataH[0]= 0;
294
      mBitmapSet      = new boolean[1];
295
      mBitmapSet[0]   = false;
296
      mBmp            = new Bitmap[1];
297
      mBmp[0]         = null;
298
299
      if( Distorted.isInitialized() ) resetTexture();
300
      }
301
    }
302 ada90d33 Leszek Koltunski
303 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
304
/**
305
 * Draw the DistortedObject to the location specified by current Matrix effects.    
306
 *     
307
 * @param currTime current time, in milliseconds, as returned by System.currentTimeMillis().
308 5d923c17 Leszek Koltunski
 *        This gets passed on to Dynamics inside the Effects that are currently applied to the
309 6a06a912 Leszek Koltunski
 *        Object.
310
 */
311 d425545a Leszek Koltunski
  public void draw(long currTime)
312
    {
313
    GLES20.glActiveTexture(GLES20.GL_TEXTURE0);
314
    GLES20.glBindFramebuffer(GLES20.GL_FRAMEBUFFER, 0);
315
    GLES20.glUniform1i(Distorted.mTextureUniformH, 0);
316
    GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, mTextureDataH[0]);
317 ed13a5de Leszek Koltunski
318
    drawPriv(currTime, Distorted.mFramebuffer);
319 d425545a Leszek Koltunski
    }
320 6a06a912 Leszek Koltunski
 
321
///////////////////////////////////////////////////////////////////////////////////////////////////
322
/**
323
 * Releases all resources.
324
 */
325 8e34674e Leszek Koltunski
  public synchronized void delete()
326 d425545a Leszek Koltunski
    {
327
    releasePriv();
328 8e34674e Leszek Koltunski
    mObjects.remove(this);
329 d425545a Leszek Koltunski
    }
330 6a06a912 Leszek Koltunski
331
///////////////////////////////////////////////////////////////////////////////////////////////////
332
/**
333
 * Sets the underlying android.graphics.Bitmap object and uploads it to the GPU. 
334
 * <p>
335
 * You can only recycle() the passed Bitmap once the OpenGL context gets created (i.e. after call 
336
 * to onSurfaceCreated) because only after this point can the Library upload it to the GPU!
337
 * 
338
 * @param bmp The android.graphics.Bitmap object to apply effects to and display.
339
 */
340
   
341 d425545a Leszek Koltunski
  public void setBitmap(Bitmap bmp)
342
    {
343
    mBitmapSet[0] = true;
344 6a06a912 Leszek Koltunski
      
345 d425545a Leszek Koltunski
    if( Distorted.isInitialized() )
346
      {
347
      GLES20.glActiveTexture(GLES20.GL_TEXTURE0);
348
      GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, mTextureDataH[0]);
349 985ea9c5 Leszek Koltunski
      GLUtils.texImage2D(GLES20.GL_TEXTURE_2D, 0, flipBitmap(bmp), 0);
350 d425545a Leszek Koltunski
      }
351
    else
352
      {
353
      mBmp[0] = bmp;
354
      }
355
    }
356 6a06a912 Leszek Koltunski
    
357
///////////////////////////////////////////////////////////////////////////////////////////////////
358
/**
359
 * Adds the calling class to the list of Listeners that get notified each time some event happens 
360 9351ad55 Leszek Koltunski
 * to one of the Effects that are currently applied to the DistortedObject.
361 6a06a912 Leszek Koltunski
 * 
362
 * @param el A class implementing the EffectListener interface that wants to get notifications.
363
 */
364 d425545a Leszek Koltunski
  public void addEventListener(EffectListener el)
365
    {
366
    mV.addListener(el);
367
    mF.addListener(el);
368
    mM.addListener(el);
369
    }
370 6a06a912 Leszek Koltunski
371
///////////////////////////////////////////////////////////////////////////////////////////////////
372
/**
373
 * Removes the calling class from the list of Listeners.
374
 * 
375
 * @param el A class implementing the EffectListener interface that no longer wants to get notifications.
376
 */
377 d425545a Leszek Koltunski
  public void removeEventListener(EffectListener el)
378
    {
379
    mV.removeListener(el);
380
    mF.removeListener(el);
381
    mM.removeListener(el);
382
    }
383 6a06a912 Leszek Koltunski
   
384
///////////////////////////////////////////////////////////////////////////////////////////////////
385
/**
386
 * Returns the height of the DistortedObject.
387
 *    
388
 * @return height of the object, in pixels.
389
 */
390 d425545a Leszek Koltunski
  public int getWidth()
391 6a06a912 Leszek Koltunski
     {
392
     return mSizeX;   
393
     }
394
395
///////////////////////////////////////////////////////////////////////////////////////////////////
396
/**
397
 * Returns the width of the DistortedObject.
398
 * 
399
 * @return width of the Object, in pixels.
400
 */
401 d425545a Leszek Koltunski
  public int getHeight()
402 6a06a912 Leszek Koltunski
      {
403
      return mSizeY;  
404
      }
405
    
406
///////////////////////////////////////////////////////////////////////////////////////////////////
407
/**
408
 * Returns the depth of the DistortedObject.
409
 * 
410
 * @return depth of the Object, in pixels.
411
 */
412 d425545a Leszek Koltunski
  public int getDepth()
413 6a06a912 Leszek Koltunski
      {
414
      return mSizeZ;  
415
      }
416
        
417
///////////////////////////////////////////////////////////////////////////////////////////////////
418
/**
419
 * Returns unique ID of this instance.
420
 * 
421
 * @return ID of the object.
422
 */
423 d425545a Leszek Koltunski
  public long getID()
424 6a06a912 Leszek Koltunski
      {
425
      return mID;  
426
      }
427
    
428
///////////////////////////////////////////////////////////////////////////////////////////////////
429
/**
430 d07f2950 Leszek Koltunski
 * Aborts all Effects.
431
 * @return Number of effects aborted.
432 6a06a912 Leszek Koltunski
 */
433 d425545a Leszek Koltunski
  public int abortAllEffects()
434 6a06a912 Leszek Koltunski
      {
435 0df17fad Leszek Koltunski
      return mM.abortAll(true) + mV.abortAll(true) + mF.abortAll(true);
436 6a06a912 Leszek Koltunski
      }
437
438
///////////////////////////////////////////////////////////////////////////////////////////////////
439
/**
440 d07f2950 Leszek Koltunski
 * Aborts all Effects of a given type, for example all MATRIX Effects.
441 6a06a912 Leszek Koltunski
 * 
442 d07f2950 Leszek Koltunski
 * @param type one of the constants defined in {@link EffectTypes}
443
 * @return Number of effects aborted.
444 6a06a912 Leszek Koltunski
 */
445 d425545a Leszek Koltunski
  public int abortEffects(EffectTypes type)
446
    {
447
    switch(type)
448 6a06a912 Leszek Koltunski
      {
449 0df17fad Leszek Koltunski
      case MATRIX  : return mM.abortAll(true);
450
      case VERTEX  : return mV.abortAll(true);
451
      case FRAGMENT: return mF.abortAll(true);
452 d425545a Leszek Koltunski
      default      : return 0;
453 6a06a912 Leszek Koltunski
      }
454 d425545a Leszek Koltunski
    }
455 6a06a912 Leszek Koltunski
    
456
///////////////////////////////////////////////////////////////////////////////////////////////////
457
/**
458
 * Aborts a single Effect.
459
 * 
460
 * @param id ID of the Effect we want to abort.
461 476bbc81 Leszek Koltunski
 * @return number of Effects aborted. Always either 0 or 1.
462 6a06a912 Leszek Koltunski
 */
463 d425545a Leszek Koltunski
  public int abortEffect(long id)
464
    {
465
    int type = (int)(id&EffectTypes.MASK);
466 1e438fc7 Leszek Koltunski
467 d425545a Leszek Koltunski
    if( type==EffectTypes.MATRIX.type   ) return mM.removeByID(id>>EffectTypes.LENGTH);
468
    if( type==EffectTypes.VERTEX.type   ) return mV.removeByID(id>>EffectTypes.LENGTH);
469
    if( type==EffectTypes.FRAGMENT.type ) return mF.removeByID(id>>EffectTypes.LENGTH);
470 1e438fc7 Leszek Koltunski
471 d425545a Leszek Koltunski
    return 0;
472
    }
473 6a06a912 Leszek Koltunski
474
///////////////////////////////////////////////////////////////////////////////////////////////////
475
/**
476 e8c81a8e Leszek Koltunski
 * Abort all Effects of a given name, for example all rotations.
477 6a06a912 Leszek Koltunski
 * 
478 d07f2950 Leszek Koltunski
 * @param name one of the constants defined in {@link EffectNames}
479 476bbc81 Leszek Koltunski
 * @return number of Effects aborted.
480 6a06a912 Leszek Koltunski
 */
481 d425545a Leszek Koltunski
  public int abortEffects(EffectNames name)
482
    {
483
    switch(name.getType())
484 6a06a912 Leszek Koltunski
      {
485 d425545a Leszek Koltunski
      case MATRIX  : return mM.removeByType(name);
486
      case VERTEX  : return mV.removeByType(name);
487
      case FRAGMENT: return mF.removeByType(name);
488
      default      : return 0;
489 6a06a912 Leszek Koltunski
      }
490 d425545a Leszek Koltunski
    }
491 6a06a912 Leszek Koltunski
    
492
///////////////////////////////////////////////////////////////////////////////////////////////////
493
/**
494
 * Print some info about a given Effect to Android's standard out. Used for debugging only.
495
 * 
496
 * @param id Effect ID we want to print info about
497
 * @return <code>true</code> if a single Effect of type effectType has been found.
498
 */
499
    
500 d425545a Leszek Koltunski
  public boolean printEffect(long id)
501
    {
502
    int type = (int)(id&EffectTypes.MASK);
503 1e438fc7 Leszek Koltunski
504 d425545a Leszek Koltunski
    if( type==EffectTypes.MATRIX.type   )  return mM.printByID(id>>EffectTypes.LENGTH);
505
    if( type==EffectTypes.VERTEX.type   )  return mV.printByID(id>>EffectTypes.LENGTH);
506
    if( type==EffectTypes.FRAGMENT.type )  return mF.printByID(id>>EffectTypes.LENGTH);
507 1e438fc7 Leszek Koltunski
508 d425545a Leszek Koltunski
    return false;
509
    }
510 6a06a912 Leszek Koltunski
   
511
///////////////////////////////////////////////////////////////////////////////////////////////////   
512
///////////////////////////////////////////////////////////////////////////////////////////////////
513
// Individual effect functions.
514
///////////////////////////////////////////////////////////////////////////////////////////////////
515
// Matrix-based effects
516
///////////////////////////////////////////////////////////////////////////////////////////////////
517
/**
518 e8c81a8e Leszek Koltunski
 * Moves the Object by a (possibly changing in time) vector.
519 6a06a912 Leszek Koltunski
 * 
520 568b29d8 Leszek Koltunski
 * @param vector 3-dimensional Data which at any given time will return a Static3D
521 e0a16874 Leszek Koltunski
 *               representing the current coordinates of the vector we want to move the Object with.
522
 * @return       ID of the effect added, or -1 if we failed to add one.
523 6a06a912 Leszek Koltunski
 */
524 568b29d8 Leszek Koltunski
  public long move(Data3D vector)
525 6a06a912 Leszek Koltunski
    {   
526 e0a16874 Leszek Koltunski
    return mM.add(EffectNames.MOVE,vector);
527 6a06a912 Leszek Koltunski
    }
528
529
///////////////////////////////////////////////////////////////////////////////////////////////////
530
/**
531 e8c81a8e Leszek Koltunski
 * Scales the Object by (possibly changing in time) 3D scale factors.
532 6a06a912 Leszek Koltunski
 * 
533 568b29d8 Leszek Koltunski
 * @param scale 3-dimensional Dynamic which at any given time returns a Static3D
534 e0a16874 Leszek Koltunski
 *              representing the current x- , y- and z- scale factors.
535
 * @return      ID of the effect added, or -1 if we failed to add one.
536 6a06a912 Leszek Koltunski
 */
537 568b29d8 Leszek Koltunski
  public long scale(Data3D scale)
538 6a06a912 Leszek Koltunski
    {   
539 e0a16874 Leszek Koltunski
    return mM.add(EffectNames.SCALE,scale);
540 6a06a912 Leszek Koltunski
    }
541
542 2fce34f4 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
543
/**
544 e8c81a8e Leszek Koltunski
 * Scales the Object by one uniform, constant factor in all 3 dimensions. Convenience function.
545 2fce34f4 Leszek Koltunski
 *
546
 * @param scale The factor to scale all 3 dimensions with.
547
 * @return      ID of the effect added, or -1 if we failed to add one.
548
 */
549 d425545a Leszek Koltunski
  public long scale(float scale)
550
    {
551
    return mM.add(EffectNames.SCALE, new Static3D(scale,scale,scale));
552
    }
553 2fce34f4 Leszek Koltunski
554 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
555
/**
556 568b29d8 Leszek Koltunski
 * Rotates the Object by 'angle' degrees around the center.
557
 * Static axis of rotation is given by the last parameter.
558
 *
559 9351ad55 Leszek Koltunski
 * @param angle  Angle that we want to rotate the Object to. Unit: degrees
560 568b29d8 Leszek Koltunski
 * @param axis   Axis of rotation
561 0df17fad Leszek Koltunski
 * @param center Coordinates of the Point we are rotating around.
562 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
563
 */
564 0df17fad Leszek Koltunski
  public long rotate(Data1D angle, Static3D axis, Data3D center )
565 6a06a912 Leszek Koltunski
    {   
566 0df17fad Leszek Koltunski
    return mM.add(EffectNames.ROTATE, angle, axis, center);
567 6a06a912 Leszek Koltunski
    }
568
569
///////////////////////////////////////////////////////////////////////////////////////////////////
570
/**
571 568b29d8 Leszek Koltunski
 * Rotates the Object by 'angle' degrees around the center.
572 2fce34f4 Leszek Koltunski
 * Here both angle and axis can dynamically change.
573 568b29d8 Leszek Koltunski
 *
574
 * @param angleaxis Combined 4-tuple representing the (angle,axisX,axisY,axisZ).
575 0df17fad Leszek Koltunski
 * @param center    Coordinates of the Point we are rotating around.
576 568b29d8 Leszek Koltunski
 * @return          ID of the effect added, or -1 if we failed to add one.
577 e0a16874 Leszek Koltunski
 */
578 0df17fad Leszek Koltunski
  public long rotate(Data4D angleaxis, Data3D center)
579 568b29d8 Leszek Koltunski
    {
580 0df17fad Leszek Koltunski
    return mM.add(EffectNames.ROTATE, angleaxis, center);
581 6a06a912 Leszek Koltunski
    }
582
583
///////////////////////////////////////////////////////////////////////////////////////////////////
584
/**
585 568b29d8 Leszek Koltunski
 * Rotates the Object by quaternion.
586 0df17fad Leszek Koltunski
 *
587 568b29d8 Leszek Koltunski
 * @param quaternion The quaternion describing the rotation.
588 0df17fad Leszek Koltunski
 * @param center     Coordinates of the Point we are rotating around.
589 568b29d8 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
590 6a06a912 Leszek Koltunski
 */
591 0df17fad Leszek Koltunski
  public long quaternion(Data4D quaternion, Data3D center )
592 568b29d8 Leszek Koltunski
    {
593 0df17fad Leszek Koltunski
    return mM.add(EffectNames.QUATERNION,quaternion,center);
594 6a06a912 Leszek Koltunski
    }
595
596
///////////////////////////////////////////////////////////////////////////////////////////////////
597
/**
598 568b29d8 Leszek Koltunski
 * Shears the Object.
599 6a06a912 Leszek Koltunski
 *
600 8c3cdec5 Leszek Koltunski
 * @param shear   The 3-tuple of shear factors. The first controls level
601
 *                of shearing in the X-axis, second - Y-axis and the third -
602
 *                Z-axis. Each is the tangens of the shear angle, i.e 0 -
603
 *                no shear, 1 - shear by 45 degrees (tan(45deg)=1) etc.
604 0df17fad Leszek Koltunski
 * @param center  Center of shearing, i.e. the point which stays unmoved.
605 e0a16874 Leszek Koltunski
 * @return        ID of the effect added, or -1 if we failed to add one.
606 6a06a912 Leszek Koltunski
 */
607 0df17fad Leszek Koltunski
  public long shear(Data3D shear, Data3D center)
608 6a06a912 Leszek Koltunski
    {
609 0df17fad Leszek Koltunski
    return mM.add(EffectNames.SHEAR, shear, center);
610 6a06a912 Leszek Koltunski
    }
611
612
///////////////////////////////////////////////////////////////////////////////////////////////////
613
// Fragment-based effects  
614
///////////////////////////////////////////////////////////////////////////////////////////////////
615
/**
616 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change all three of its RGB components.
617 6a06a912 Leszek Koltunski
 *        
618 2fce34f4 Leszek Koltunski
 * @param blend  1-dimensional Data that returns the level of blend a given pixel will be
619 e4878781 Leszek Koltunski
 *               mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color.
620
 *               Valid range: <0,1>
621 b1e91f2c Leszek Koltunski
 * @param color  Color to mix. (1,0,0) is RED.
622 2fce34f4 Leszek Koltunski
 * @param region Region this Effect is limited to.
623
 * @param smooth If true, the level of 'blend' will smoothly fade out towards the edges of the region.
624
 * @return       ID of the effect added, or -1 if we failed to add one.
625 6a06a912 Leszek Koltunski
 */
626 8c893ffc Leszek Koltunski
  public long chroma(Data1D blend, Data3D color, Data4D region, boolean smooth)
627 6a06a912 Leszek Koltunski
    {
628 2fce34f4 Leszek Koltunski
    return mF.add( smooth? EffectNames.SMOOTH_CHROMA:EffectNames.CHROMA, blend, color, region);
629 6a06a912 Leszek Koltunski
    }
630
631
///////////////////////////////////////////////////////////////////////////////////////////////////
632
/**
633 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change all three of its RGB components.
634
 *
635
 * @param blend  1-dimensional Data that returns the level of blend a given pixel will be
636 e4878781 Leszek Koltunski
 *               mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color.
637
 *               Valid range: <0,1>
638 b1e91f2c Leszek Koltunski
 * @param color  Color to mix. (1,0,0) is RED.
639 2fce34f4 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
640 6a06a912 Leszek Koltunski
 */
641 8c893ffc Leszek Koltunski
  public long chroma(Data1D blend, Data3D color)
642 6a06a912 Leszek Koltunski
    {
643 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.CHROMA, blend, color);
644 6a06a912 Leszek Koltunski
    }
645
646
///////////////////////////////////////////////////////////////////////////////////////////////////
647
/**
648 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its transparency level.
649 6a06a912 Leszek Koltunski
 *        
650 2fce34f4 Leszek Koltunski
 * @param alpha  1-dimensional Data that returns the level of transparency we want to have at any given
651 e4878781 Leszek Koltunski
 *               moment: pixel.a *= alpha.
652
 *               Valid range: <0,1>
653 d7bbef2f Leszek Koltunski
 * @param region Region this Effect is limited to. 
654 2fce34f4 Leszek Koltunski
 * @param smooth If true, the level of 'alpha' will smoothly fade out towards the edges of the region.
655 d7bbef2f Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one. 
656 6a06a912 Leszek Koltunski
 */
657 2fce34f4 Leszek Koltunski
  public long alpha(Data1D alpha, Data4D region, boolean smooth)
658 6a06a912 Leszek Koltunski
    {
659 2fce34f4 Leszek Koltunski
    return mF.add( smooth? EffectNames.SMOOTH_ALPHA:EffectNames.ALPHA, alpha, region);
660 6a06a912 Leszek Koltunski
    }
661
662
///////////////////////////////////////////////////////////////////////////////////////////////////
663
/**
664 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its transparency level.
665
 *
666
 * @param alpha  1-dimensional Data that returns the level of transparency we want to have at any
667 e4878781 Leszek Koltunski
 *               given moment: pixel.a *= alpha.
668
 *               Valid range: <0,1>
669 2fce34f4 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
670 6a06a912 Leszek Koltunski
 */
671 2fce34f4 Leszek Koltunski
  public long alpha(Data1D alpha)
672 6a06a912 Leszek Koltunski
    {
673 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.ALPHA, alpha);
674 6a06a912 Leszek Koltunski
    }
675
676
///////////////////////////////////////////////////////////////////////////////////////////////////
677
/**
678 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its brightness level.
679 6a06a912 Leszek Koltunski
 *        
680 2fce34f4 Leszek Koltunski
 * @param brightness 1-dimensional Data that returns the level of brightness we want to have
681 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
682 e0a16874 Leszek Koltunski
 * @param region     Region this Effect is limited to.
683 2fce34f4 Leszek Koltunski
 * @param smooth     If true, the level of 'brightness' will smoothly fade out towards the edges of the region.
684 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
685 6a06a912 Leszek Koltunski
 */
686 2fce34f4 Leszek Koltunski
  public long brightness(Data1D brightness, Data4D region, boolean smooth)
687 6a06a912 Leszek Koltunski
    {
688 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_BRIGHTNESS: EffectNames.BRIGHTNESS, brightness, region);
689 6a06a912 Leszek Koltunski
    }
690
691
///////////////////////////////////////////////////////////////////////////////////////////////////
692
/**
693 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its brightness level.
694
 *
695
 * @param brightness 1-dimensional Data that returns the level of brightness we want to have
696 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
697 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
698 6a06a912 Leszek Koltunski
 */
699 2fce34f4 Leszek Koltunski
  public long brightness(Data1D brightness)
700 6a06a912 Leszek Koltunski
    {
701 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.BRIGHTNESS, brightness);
702 6a06a912 Leszek Koltunski
    }
703
704
///////////////////////////////////////////////////////////////////////////////////////////////////
705
/**
706 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its contrast level.
707 6a06a912 Leszek Koltunski
 *        
708 2fce34f4 Leszek Koltunski
 * @param contrast 1-dimensional Data that returns the level of contrast we want to have
709 e4878781 Leszek Koltunski
 *                 at any given moment. Valid range: <0,infinity)
710 e0a16874 Leszek Koltunski
 * @param region   Region this Effect is limited to.
711 2fce34f4 Leszek Koltunski
 * @param smooth   If true, the level of 'contrast' will smoothly fade out towards the edges of the region.
712 e0a16874 Leszek Koltunski
 * @return         ID of the effect added, or -1 if we failed to add one.
713 6a06a912 Leszek Koltunski
 */
714 2fce34f4 Leszek Koltunski
  public long contrast(Data1D contrast, Data4D region, boolean smooth)
715 6a06a912 Leszek Koltunski
    {
716 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_CONTRAST:EffectNames.CONTRAST, contrast, region);
717 6a06a912 Leszek Koltunski
    }
718
719
///////////////////////////////////////////////////////////////////////////////////////////////////
720
/**
721 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its contrast level.
722
 *
723
 * @param contrast 1-dimensional Data that returns the level of contrast we want to have
724 e4878781 Leszek Koltunski
 *                 at any given moment. Valid range: <0,infinity)
725 e0a16874 Leszek Koltunski
 * @return         ID of the effect added, or -1 if we failed to add one.
726 6a06a912 Leszek Koltunski
 */
727 2fce34f4 Leszek Koltunski
  public long contrast(Data1D contrast)
728 6a06a912 Leszek Koltunski
    {
729 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.CONTRAST, contrast);
730 6a06a912 Leszek Koltunski
    }
731
732
///////////////////////////////////////////////////////////////////////////////////////////////////
733
/**
734 e0a16874 Leszek Koltunski
 * Makes a certain sub-region of the Object smoothly change its saturation level.
735 6a06a912 Leszek Koltunski
 *        
736 2fce34f4 Leszek Koltunski
 * @param saturation 1-dimensional Data that returns the level of saturation we want to have
737 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
738 e0a16874 Leszek Koltunski
 * @param region     Region this Effect is limited to.
739 2fce34f4 Leszek Koltunski
 * @param smooth     If true, the level of 'saturation' will smoothly fade out towards the edges of the region.
740 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
741 6a06a912 Leszek Koltunski
 */
742 2fce34f4 Leszek Koltunski
  public long saturation(Data1D saturation, Data4D region, boolean smooth)
743 6a06a912 Leszek Koltunski
    {
744 2fce34f4 Leszek Koltunski
    return mF.add( smooth ? EffectNames.SMOOTH_SATURATION:EffectNames.SATURATION, saturation, region);
745 6a06a912 Leszek Koltunski
    }
746
747
///////////////////////////////////////////////////////////////////////////////////////////////////
748
/**
749 2fce34f4 Leszek Koltunski
 * Makes the whole Object smoothly change its saturation level.
750
 *
751
 * @param saturation 1-dimensional Data that returns the level of saturation we want to have
752 e4878781 Leszek Koltunski
 *                   at any given moment. Valid range: <0,infinity)
753 e0a16874 Leszek Koltunski
 * @return           ID of the effect added, or -1 if we failed to add one.
754 6a06a912 Leszek Koltunski
 */
755 2fce34f4 Leszek Koltunski
  public long saturation(Data1D saturation)
756 6a06a912 Leszek Koltunski
    {
757 2fce34f4 Leszek Koltunski
    return mF.add(EffectNames.SATURATION, saturation);
758 6a06a912 Leszek Koltunski
    }
759
760
///////////////////////////////////////////////////////////////////////////////////////////////////
761
// Vertex-based effects  
762
///////////////////////////////////////////////////////////////////////////////////////////////////
763
/**
764 e0a16874 Leszek Koltunski
 * Distort a (possibly changing in time) part of the Object by a (possibly changing in time) vector of force.
765 f2fe7e28 Leszek Koltunski
 *
766
 * @param vector 3-dimensional Vector which represents the force the Center of the Effect is
767
 *               currently being dragged with.
768 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
769 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
770
 * @return       ID of the effect added, or -1 if we failed to add one.
771 6a06a912 Leszek Koltunski
 */
772 fa6c352d Leszek Koltunski
  public long distort(Data3D vector, Data3D center, Data4D region)
773 6a06a912 Leszek Koltunski
    {  
774 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.DISTORT, vector, center, region);
775 6a06a912 Leszek Koltunski
    }
776
777
///////////////////////////////////////////////////////////////////////////////////////////////////
778
/**
779 e0a16874 Leszek Koltunski
 * Distort the whole Object by a (possibly changing in time) vector of force.
780 f2fe7e28 Leszek Koltunski
 *
781
 * @param vector 3-dimensional Vector which represents the force the Center of the Effect is
782
 *               currently being dragged with.
783 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
784 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
785 6a06a912 Leszek Koltunski
 */
786 fa6c352d Leszek Koltunski
  public long distort(Data3D vector, Data3D center)
787 d425545a Leszek Koltunski
    {
788 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.DISTORT, vector, center, null);
789 d425545a Leszek Koltunski
    }
790 6a06a912 Leszek Koltunski
791 6ebdbbf1 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
792
/**
793
 * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to
794
 * a (possibly changing in time) point on the Object.
795
 *
796
 * @param vector Vector of force that deforms the shape of the whole Object.
797
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
798
 * @param region Region that masks the Effect.
799
 * @return       ID of the effect added, or -1 if we failed to add one.
800
 */
801
  public long deform(Data3D vector, Data3D center, Data4D region)
802
    {
803
    return mV.add(EffectNames.DEFORM, vector, center, region);
804
    }
805
806 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
807
/**
808 e0a16874 Leszek Koltunski
 * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to
809 9351ad55 Leszek Koltunski
 * a (possibly changing in time) point on the Object.
810 6a06a912 Leszek Koltunski
 *     
811 f2fe7e28 Leszek Koltunski
 * @param vector Vector of force that deforms the shape of the whole Object.
812 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
813 e0a16874 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
814 6a06a912 Leszek Koltunski
 */
815 fa6c352d Leszek Koltunski
  public long deform(Data3D vector, Data3D center)
816 6a06a912 Leszek Koltunski
    {  
817 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.DEFORM, vector, center, null);
818 6a06a912 Leszek Koltunski
    }
819
820
///////////////////////////////////////////////////////////////////////////////////////////////////  
821
/**
822 f2fe7e28 Leszek Koltunski
 * Pull all points around the center of the Effect towards the center (if degree>=1) or push them
823 6a06a912 Leszek Koltunski
 * away from the center (degree<=1)
824 f2fe7e28 Leszek Koltunski
 *
825
 * @param sink   The current degree of the Effect.
826 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
827 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
828
 * @return       ID of the effect added, or -1 if we failed to add one.
829 6a06a912 Leszek Koltunski
 */
830 fa6c352d Leszek Koltunski
  public long sink(Data1D sink, Data3D center, Data4D region)
831 6a06a912 Leszek Koltunski
    {
832 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.SINK, sink, center, region);
833 6a06a912 Leszek Koltunski
    }
834
835
///////////////////////////////////////////////////////////////////////////////////////////////////
836
/**
837 f2fe7e28 Leszek Koltunski
 * Pull all points around the center of the Effect towards the center (if degree>=1) or push them
838
 * away from the center (degree<=1)
839
 *
840
 * @param sink   The current degree of the Effect.
841 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
842 f2fe7e28 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
843 6a06a912 Leszek Koltunski
 */
844 fa6c352d Leszek Koltunski
  public long sink(Data1D sink, Data3D center)
845 d425545a Leszek Koltunski
    {
846
    return mV.add(EffectNames.SINK, sink, center);
847
    }
848 6a06a912 Leszek Koltunski
849 82ee855a Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
850
/**
851
 * Pull all points around the center of the Effect towards a line passing through the center
852
 * (that's if degree>=1) or push them away from the line (degree<=1)
853
 *
854
 * @param pinch  The current degree of the Effect + angle the line forms with X-axis
855
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
856
 * @param region Region that masks the Effect.
857
 * @return       ID of the effect added, or -1 if we failed to add one.
858
 */
859
  public long pinch(Data2D pinch, Data3D center, Data4D region)
860
    {
861
    return mV.add(EffectNames.PINCH, pinch, center, region);
862
    }
863
864
///////////////////////////////////////////////////////////////////////////////////////////////////
865
/**
866
 * Pull all points around the center of the Effect towards a line passing through the center
867
 * (that's if degree>=1) or push them away from the line (degree<=1)
868
 *
869
 * @param pinch  The current degree of the Effect + angle the line forms with X-axis
870
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
871
 * @return       ID of the effect added, or -1 if we failed to add one.
872
 */
873
  public long pinch(Data2D pinch, Data3D center)
874
    {
875
    return mV.add(EffectNames.PINCH, pinch, center);
876
    }
877
878 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////  
879
/**
880 f2fe7e28 Leszek Koltunski
 * Rotate part of the Object around the Center of the Effect by a certain angle.
881
 *
882 4fde55a0 Leszek Koltunski
 * @param swirl  The angle of Swirl (in degrees). Positive values swirl clockwise.
883 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
884 f2fe7e28 Leszek Koltunski
 * @param region Region that masks the Effect.
885
 * @return       ID of the effect added, or -1 if we failed to add one.
886 6a06a912 Leszek Koltunski
 */
887 fa6c352d Leszek Koltunski
  public long swirl(Data1D swirl, Data3D center, Data4D region)
888 6a06a912 Leszek Koltunski
    {    
889 f2fe7e28 Leszek Koltunski
    return mV.add(EffectNames.SWIRL, swirl, center, region);
890 6a06a912 Leszek Koltunski
    }
891
892
///////////////////////////////////////////////////////////////////////////////////////////////////
893
/**
894 f2fe7e28 Leszek Koltunski
 * Rotate the whole Object around the Center of the Effect by a certain angle.
895
 *
896 4fde55a0 Leszek Koltunski
 * @param swirl  The angle of Swirl (in degrees). Positive values swirl clockwise.
897 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
898 f2fe7e28 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
899 6a06a912 Leszek Koltunski
 */
900 fa6c352d Leszek Koltunski
  public long swirl(Data1D swirl, Data3D center)
901 d425545a Leszek Koltunski
    {
902
    return mV.add(EffectNames.SWIRL, swirl, center);
903
    }
904 4fde55a0 Leszek Koltunski
905
///////////////////////////////////////////////////////////////////////////////////////////////////
906
/**
907
 * Directional, sinusoidal wave effect.
908
 *
909 350cc2f5 Leszek Koltunski
 * @param wave   A 5-dimensional data structure describing the wave: first member is the amplitude,
910 ea16dc89 Leszek Koltunski
 *               second is the wave length, third is the phase (i.e. when phase = PI/2, the sine
911 350cc2f5 Leszek Koltunski
 *               wave at the center does not start from sin(0), but from sin(PI/2) ) and the next two
912
 *               describe the 'direction' of the wave.
913 3695d6fa Leszek Koltunski
 *               <p>
914 d0c902b8 Leszek Koltunski
 *               Wave direction is defined to be a 3D vector of length 1. To define such vectors, we
915
 *               need 2 floats: thus the third member is the angle Alpha (in degrees) which the vector
916
 *               forms with the XY-plane, and the fourth is the angle Beta (again in degrees) which
917
 *               the projection of the vector to the XY-plane forms with the Y-axis (counterclockwise).
918 3695d6fa Leszek Koltunski
 *               <p>
919
 *               <p>
920 d0c902b8 Leszek Koltunski
 *               Example1: if Alpha = 90, Beta = 90, (then V=(0,0,1) ) and the wave acts 'vertically'
921
 *               in the X-direction, i.e. cross-sections of the resulting surface with the XZ-plane
922
 *               will be sine shapes.
923 3695d6fa Leszek Koltunski
 *               <p>
924 d0c902b8 Leszek Koltunski
 *               Example2: if Alpha = 90, Beta = 0, the again V=(0,0,1) and the wave is 'vertical',
925
 *               but this time it waves in the Y-direction, i.e. cross sections of the surface and the
926
 *               YZ-plane with be sine shapes.
927 3695d6fa Leszek Koltunski
 *               <p>
928 d0c902b8 Leszek Koltunski
 *               Example3: if Alpha = 0 and Beta = 45, then V=(sqrt(2)/2, -sqrt(2)/2, 0) and the wave
929 350cc2f5 Leszek Koltunski
 *               is entirely 'horizontal' and moves point (x,y,0) in direction V by whatever is the
930
 *               value if sin at this point.
931 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
932 4fde55a0 Leszek Koltunski
 * @return       ID of the effect added, or -1 if we failed to add one.
933
 */
934 fa6c352d Leszek Koltunski
  public long wave(Data5D wave, Data3D center)
935 4fde55a0 Leszek Koltunski
    {
936 02ef26bc Leszek Koltunski
    return mV.add(EffectNames.WAVE, wave, center, null);
937 4fde55a0 Leszek Koltunski
    }
938
939
///////////////////////////////////////////////////////////////////////////////////////////////////
940
/**
941
 * Directional, sinusoidal wave effect.
942
 *
943 3d590d8d Leszek Koltunski
 * @param wave   see {@link DistortedObject#wave(Data5D,Data3D)}
944 fa6c352d Leszek Koltunski
 * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect.
945 4fde55a0 Leszek Koltunski
 * @param region Region that masks the Effect.
946
 * @return       ID of the effect added, or -1 if we failed to add one.
947
 */
948 fa6c352d Leszek Koltunski
  public long wave(Data5D wave, Data3D center, Data4D region)
949 4fde55a0 Leszek Koltunski
    {
950
    return mV.add(EffectNames.WAVE, wave, center, region);
951
    }
952 f2fe7e28 Leszek Koltunski
  }