Project

General

Profile

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

library / src / main / java / org / distorted / library / EffectNames.java @ 1beb6f13

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
///////////////////////////////////////////////////////////////////////////////////////////////////
23 476bbc81 Leszek Koltunski
/**
24
 * Names of Effects one can apply to DistortedObjects.
25 0df17fad Leszek Koltunski
 * <p>
26 b911dc09 Leszek Koltunski
 * Effect's 'Type' is one of the constants defined in {@link EffectTypes}.
27 e25d0dde Leszek Koltunski
 * </p>
28
 * <p>
29 8298e6af Leszek Koltunski
 * Effect's 'Uniforms' are a vector of 7 (matrix effects) 12 (vertex) or 8 (fragment) floats, which
30 e25d0dde Leszek Koltunski
 * together form full information how to compute a given effect.
31
 * Typically, some of those values will be Interpolated in CPU (by one of the 'EffectQueueX.compute()'
32
 * methods) and the effect of such Interpolation sent to the Shaders.
33
 * </p>
34
 * <p>
35
 * Effect's 'Unity' is such a particular vector of its 'interpolated values' which makes the
36
 * effect NULL. For example, if the effect is 'MOVE' by a 3-dimensional vector, then a 'NULL
37
 * MOVE' is a MOVE by vector (0,0,0), thus (0,0,0) is the unity of the MOVE effect.
38
 * This is used by the EffectQueue classes to decide if the final form of the Effect is NULL - and
39
 * thus if it can safely be removed from Effect Queues without affecting the visual in any way.
40
 * </p>
41 476bbc81 Leszek Koltunski
 */
42
public enum EffectNames
43 6a06a912 Leszek Koltunski
  {
44
  // EFFECT NAME /////// EFFECT TYPE ////////////// UNITY /////////////////////////
45 0df17fad Leszek Koltunski
46
  /////////////////////////////////////////////////////////////////////////////////
47
  // MATRIX EFFECTS.
48
  // Always 7 Uniforms: 4 per-effect interpolated values + 3 dimensional center.
49
 /**
50
   * Rotate the whole Object around a center point (in angle-axis notation).
51
   * <p>
52 e25d0dde Leszek Koltunski
   * Uniforms: (angle,axisX,axisY,axisZ,centerX,centerY,centerZ)
53 3695d6fa Leszek Koltunski
   * <p>
54 0df17fad Leszek Koltunski
   * Unity: angle==0
55
   */
56 1beb6f13 Leszek Koltunski
  ROTATE           ( EffectTypes.MATRIX  ,   new float[] {0.0f}           , 1, false ),
57 0df17fad Leszek Koltunski
 /**
58
   * Rotate the whole Object around a center point (in quaternion notation).
59
   * <p>
60 e25d0dde Leszek Koltunski
   * Uniforms: (quatX,quatY,quatZ,quatW,centerX,centerY,centerZ)
61 3695d6fa Leszek Koltunski
   * <p>
62 0df17fad Leszek Koltunski
   * Unity: (quatX,quatY,quatZ) = (0,0,0)
63
   */
64 1beb6f13 Leszek Koltunski
  QUATERNION       ( EffectTypes.MATRIX  ,   new float[] {0.0f,0.0f,0.0f} , 4, false ),
65 0df17fad Leszek Koltunski
 /**
66
   * Move the whole Object by a vector.
67
   * <p>
68 e25d0dde Leszek Koltunski
   * Uniforms: (vectorX,vectorY,vectorZ,UNUSED,UNUSED,UNUSED,UNUSED)
69 3695d6fa Leszek Koltunski
   * <p>
70 0df17fad Leszek Koltunski
   * Unity: (vectorX,vectorY,vectorZ) = (0,0,0)
71
   */
72 1beb6f13 Leszek Koltunski
  MOVE             ( EffectTypes.MATRIX  ,   new float[] {0.0f,0.0f,0.0f} , 3, false ),
73 0df17fad Leszek Koltunski
 /**
74
   * Scale the whole Object independently in all 3 dimensions.
75
   * <p>
76 e25d0dde Leszek Koltunski
   * Uniforms: (scaleX,scaleY,scaleZ,UNUSED,UNUSED,UNUSED,UNUSED)
77 3695d6fa Leszek Koltunski
   * <p>
78 0df17fad Leszek Koltunski
   * Unity: (scaleX,scaleY,scaleZ) = (1,1,1)
79
   */
80 1beb6f13 Leszek Koltunski
  SCALE            ( EffectTypes.MATRIX  ,   new float[] {1.0f,1.0f,1.0f} , 3, false ),
81 0df17fad Leszek Koltunski
 /**
82
   * Shear the whole Object in 3 dimensions around a center point.
83
   * <p>
84 e25d0dde Leszek Koltunski
   * Uniforms: (shearX,shearY,shearZ,UNUSED,centerX,centerY,centerZ)
85 3695d6fa Leszek Koltunski
   * <p>
86 0df17fad Leszek Koltunski
   * Unity:  (shearX,shearY,shearZ) = (0,0,0)
87
   */
88 1beb6f13 Leszek Koltunski
  SHEAR            ( EffectTypes.MATRIX  ,   new float[] {0.0f,0.0f,0.0f} , 3, false ),
89 1e438fc7 Leszek Koltunski
  // add new Matrix effects here...
90 0df17fad Leszek Koltunski
91
 /////////////////////////////////////////////////////////////////////////////////
92
 // VERTEX EFFECTS
93 8298e6af Leszek Koltunski
 // Always 12 Uniforms: 6 per-effect interpolated values, 2-dimensional center of
94
 // the effect, 4-dimensional Region
95 0df17fad Leszek Koltunski
 /**
96
   * Apply a 3D vector of force to area around a point on the surface of the Object.
97
   * <p>
98 02ef26bc Leszek Koltunski
   * Uniforms: (forceX ,forceY ,forceZ  ,UNUSED  ,
99 3695d6fa Leszek Koltunski
   *            UNUSED , UNUSED,centerX ,centerY ,
100
   *            regionX,regionY,regionRX,regionRY)
101
   * <p>
102 0df17fad Leszek Koltunski
   * Unity: (forceX,forceY,forceZ) = (0,0,0)
103
   */
104 1beb6f13 Leszek Koltunski
  DISTORT          ( EffectTypes.VERTEX  ,   new float[] {0.0f,0.0f,0.0f} , 3, true ),
105 0df17fad Leszek Koltunski
 /**
106
   * Deform the whole Object by applying a 2D vector of force to a center point.
107
   * <p>
108 02ef26bc Leszek Koltunski
   * Uniforms: (forceX,forceY,UNUSED,UNUSED,
109
   *            UNUSED,UNUSED,centerX,centerY,
110
   *            UNUSED,UNUSED,UNUSED,UNUSED)
111 3695d6fa Leszek Koltunski
   * <p>
112 0df17fad Leszek Koltunski
   * Unity: (forceX,forceY) = (0,0)
113
   */
114 1beb6f13 Leszek Koltunski
  DEFORM           ( EffectTypes.VERTEX  ,   new float[] {0.0f,0.0f}      , 3, false ),
115 0df17fad Leszek Koltunski
 /**
116
   * Pull (or push away) all points around a center point to (from) it.
117
   * <p>
118 02ef26bc Leszek Koltunski
   * Uniforms: (sinkFactor,UNUSED,UNUSED,UNUSED,
119
   *            UNUSED,UNUSED,centerX,centerY,
120
   *            regionX,regionY,regionRX,regionRY)
121 3695d6fa Leszek Koltunski
   * <p>
122 0df17fad Leszek Koltunski
   * Unity: sinkFactor = 1
123
   */
124 1beb6f13 Leszek Koltunski
  SINK             ( EffectTypes.VERTEX  ,   new float[] {1.0f}           , 1, true ),
125 0df17fad Leszek Koltunski
 /**
126
   * Smoothly rotate a limited area around a center point.
127
   * <p>
128 02ef26bc Leszek Koltunski
   * Uniforms: (swirlAngle,UNUSED,UNUSED,UNUSED,
129 35bece36 Leszek Koltunski
   *            UNUSED, UNUSED,centerX,centerY,
130 02ef26bc Leszek Koltunski
   *            regionX,regionY,regionRX,regionRY)
131 3695d6fa Leszek Koltunski
   * <p>
132 0df17fad Leszek Koltunski
   * Unity: swirlAngle = 0
133
   */
134 1beb6f13 Leszek Koltunski
  SWIRL            ( EffectTypes.VERTEX  ,   new float[] {0.0f}           , 1, true ),
135 4fde55a0 Leszek Koltunski
  /**
136
   * Directional sinusoidal wave effect. The direction of the wave is given by the 'angle'
137 b911dc09 Leszek Koltunski
   * parameters. Details: {@link DistortedObject#wave(Data5D,Data2D)}
138 4fde55a0 Leszek Koltunski
   * <p>
139 291705f6 Leszek Koltunski
   * Uniforms: (amplitude,length,phase,angleAlpha,
140 3695d6fa Leszek Koltunski
   *            angleBeta, UNUSED,centerX,centerY,
141 02ef26bc Leszek Koltunski
   *            regionX,regionY,regionRX,regionRY)
142 3695d6fa Leszek Koltunski
   * <p>
143 4fde55a0 Leszek Koltunski
   * Unity: amplitude  = 0
144
   */
145 1beb6f13 Leszek Koltunski
  WAVE             ( EffectTypes.VERTEX  ,   new float[] {0.0f}           , 5, true ),
146 6a06a912 Leszek Koltunski
  // add new Vertex Effects here...
147 0df17fad Leszek Koltunski
148
 /////////////////////////////////////////////////////////////////////////////////
149
 // FRAGMENT EFFECTS
150
 // Always 8 Uniforms: 4-per effect interpolated values, 4 dimensional Region.
151
 /**
152
   * Make a given Region (partially) transparent.
153
   * <p>
154 e25d0dde Leszek Koltunski
   * Uniforms: (transparencyLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
155 3695d6fa Leszek Koltunski
   * <p>
156 0df17fad Leszek Koltunski
   * Unity: transparencyLevel = 1
157
   */
158 1beb6f13 Leszek Koltunski
  ALPHA            ( EffectTypes.FRAGMENT,   new float[] {1.0f}           , 1, true ),
159 0df17fad Leszek Koltunski
 /**
160
   * Make a given Region (partially) transparent.
161
   * Effect smoothly fades towards the edges of the region.
162
   * <p>
163 e25d0dde Leszek Koltunski
   * Uniforms: (transparencyLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
164 0df17fad Leszek Koltunski
   * Unity: transparencyLevel = 1
165
   */
166 1beb6f13 Leszek Koltunski
  SMOOTH_ALPHA     ( EffectTypes.FRAGMENT,   new float[] {1.0f}           , 1, true ),
167 0df17fad Leszek Koltunski
 /**
168
   * Blend current color in the texture with a given color.
169
   * <p>
170 e25d0dde Leszek Koltunski
   * Uniforms: (blendLevel,colorR,colorG,colorB, regionX, regionY, regionRX, regionRY)
171 3695d6fa Leszek Koltunski
   * <p>
172 0df17fad Leszek Koltunski
   * Unity: blendLevel = 0
173
   */
174 1beb6f13 Leszek Koltunski
  CHROMA           ( EffectTypes.FRAGMENT,   new float[] {0.0f}           , 4, true ),
175 0df17fad Leszek Koltunski
 /**
176
   * Smoothly blend current color in the texture with a given color.
177
   * <p>
178 e25d0dde Leszek Koltunski
   * Uniforms: (blendLevel,colorR,colorG,colorB, regionX, regionY, regionRX, regionRY)
179 0df17fad Leszek Koltunski
   * Unity: blendLevel = 0
180
   */
181 1beb6f13 Leszek Koltunski
  SMOOTH_CHROMA    ( EffectTypes.FRAGMENT,   new float[] {0.0f}           , 4, true ),
182 0df17fad Leszek Koltunski
 /**
183
   * Change brightness level of a given Region.
184
   * <p>
185 e25d0dde Leszek Koltunski
   * Uniforms: (brightnessLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
186 3695d6fa Leszek Koltunski
   * <p>
187 0df17fad Leszek Koltunski
   * Unity: brightnessLevel = 1
188
   */
189 1beb6f13 Leszek Koltunski
  BRIGHTNESS       ( EffectTypes.FRAGMENT,   new float[] {1.0f}           , 1, true ),
190 0df17fad Leszek Koltunski
 /**
191
   * Smoothly change brightness level of a given Region.
192
   * <p>
193 e25d0dde Leszek Koltunski
   * Uniforms: (brightnessLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
194 3695d6fa Leszek Koltunski
   * <p>
195 0df17fad Leszek Koltunski
   * Unity: brightnessLevel = 1
196
   */
197 1beb6f13 Leszek Koltunski
  SMOOTH_BRIGHTNESS( EffectTypes.FRAGMENT,   new float[] {1.0f}           , 1, true ),
198 0df17fad Leszek Koltunski
 /**
199
   * Change saturation level of a given Region.
200
   * <p>
201 e25d0dde Leszek Koltunski
   * Uniforms: (saturationLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
202 3695d6fa Leszek Koltunski
   * <p>
203 0df17fad Leszek Koltunski
   * Unity: saturationLevel = 1
204
   */
205 1beb6f13 Leszek Koltunski
  SATURATION       ( EffectTypes.FRAGMENT,   new float[] {1.0f}           , 1, true ),
206 0df17fad Leszek Koltunski
 /**
207
   * Smoothly change saturation level of a given Region.
208
   * <p>
209 e25d0dde Leszek Koltunski
   * Uniforms: (saturationLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
210 3695d6fa Leszek Koltunski
   * <p>
211 0df17fad Leszek Koltunski
   * Unity: saturationLevel = 1
212
   */
213 1beb6f13 Leszek Koltunski
  SMOOTH_SATURATION( EffectTypes.FRAGMENT,   new float[] {1.0f}           , 1, true ),
214 0df17fad Leszek Koltunski
 /**
215
   * Change contrast level of a given Region.
216
   * <p>
217 e25d0dde Leszek Koltunski
   * Uniforms: (contrastLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
218 3695d6fa Leszek Koltunski
   * <p>
219 0df17fad Leszek Koltunski
   * Unity: contrastLevel = 1
220
   */
221 1beb6f13 Leszek Koltunski
  CONTRAST         ( EffectTypes.FRAGMENT,   new float[] {1.0f}           , 1, true ),
222 0df17fad Leszek Koltunski
 /**
223
   * Smoothly change contrast level of a given Region.
224
   * <p>
225 e25d0dde Leszek Koltunski
   * Uniforms: (contrastLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
226 3695d6fa Leszek Koltunski
   * <p>
227 0df17fad Leszek Koltunski
   * Unity: contrastLevel = 1
228
   */
229 1beb6f13 Leszek Koltunski
  SMOOTH_CONTRAST  ( EffectTypes.FRAGMENT,   new float[] {1.0f}           , 1, true );
230 6a06a912 Leszek Koltunski
  // add new Fragment effects here...
231
232
///////////////////////////////////////////////////////////////////////////////////////////////////
233
  
234
  private static final int MAXDIM = 4;  // maximum supported dimension of an effect  
235
  
236 e8c81a8e Leszek Koltunski
  private final EffectTypes type;
237
  private final float[] unity;
238 1beb6f13 Leszek Koltunski
  private final int dimension;
239
  private final boolean supportsRegion;
240 6a06a912 Leszek Koltunski
  
241 e8c81a8e Leszek Koltunski
  private static final float[] unities;
242 1beb6f13 Leszek Koltunski
  private static final int[] unityDimensions;
243 e8c81a8e Leszek Koltunski
  private static final int[] dimensions;
244 1beb6f13 Leszek Koltunski
  private static final boolean[] supports;
245 e8c81a8e Leszek Koltunski
  private static final EffectNames[] names;
246
247 6a06a912 Leszek Koltunski
  static
248
    {
249
    int len = values().length;
250
    int i=0;
251
    
252 1beb6f13 Leszek Koltunski
    unityDimensions = new int[len];
253
    dimensions      = new int[len];
254
    supports        = new boolean[len];
255
    unities         = new float[MAXDIM*len];
256
    names           = new EffectNames[len];
257 e8c81a8e Leszek Koltunski
258 6a06a912 Leszek Koltunski
    for(EffectNames name: EffectNames.values())
259
      {
260 1beb6f13 Leszek Koltunski
      unityDimensions[i] = (name.unity==null ? 0 : name.unity.length);
261
      dimensions[i]      = name.dimension;
262
      supports[i]        = name.supportsRegion;
263
      names[i]           = name;
264 e8c81a8e Leszek Koltunski
265 1beb6f13 Leszek Koltunski
      switch(unityDimensions[i])
266 6a06a912 Leszek Koltunski
        {
267
        case 4: unities[MAXDIM*i+3] = name.unity[3];
268
        case 3: unities[MAXDIM*i+2] = name.unity[2];
269
        case 2: unities[MAXDIM*i+1] = name.unity[1];
270 0318e7e3 Leszek Koltunski
        case 1: unities[MAXDIM*i  ] = name.unity[0];
271 6a06a912 Leszek Koltunski
        case 0: break;
272
        }
273
      
274
      i++;  
275
      }
276
    }
277
  
278
///////////////////////////////////////////////////////////////////////////////////////////////////
279
  
280 1beb6f13 Leszek Koltunski
  EffectNames(EffectTypes type, float[] unity, int dimension, boolean supportsRegion)
281 6a06a912 Leszek Koltunski
    {
282 1beb6f13 Leszek Koltunski
    this.type           = type;
283
    this.unity          = unity;
284
    this.dimension      = dimension;
285
    this.supportsRegion = supportsRegion;
286 6a06a912 Leszek Koltunski
    }
287
288
///////////////////////////////////////////////////////////////////////////////////////////////////
289 c6e1c219 Leszek Koltunski
290 1e438fc7 Leszek Koltunski
  static EffectTypes getType(int ordinal)
291 6a06a912 Leszek Koltunski
    {
292 e8c81a8e Leszek Koltunski
    return names[ordinal].type;
293
    }
294 b3618cb5 Leszek Koltunski
295 e8c81a8e Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
296
297
  static EffectNames getName(int ordinal)
298
    {
299
    return names[ordinal];
300 6a06a912 Leszek Koltunski
    }
301
302
///////////////////////////////////////////////////////////////////////////////////////////////////
303
304
  static void fillWithUnities(int ordinal, float[] buffer, int index)
305
    {
306 1beb6f13 Leszek Koltunski
    switch(unityDimensions[ordinal])
307 6a06a912 Leszek Koltunski
      {
308
      case 0: break;
309 0318e7e3 Leszek Koltunski
      case 1: buffer[index  ]=unities[MAXDIM*ordinal  ];
310 6a06a912 Leszek Koltunski
              break;
311 0318e7e3 Leszek Koltunski
      case 2: buffer[index  ]=unities[MAXDIM*ordinal  ];
312 6a06a912 Leszek Koltunski
              buffer[index+1]=unities[MAXDIM*ordinal+1];
313
              break;
314 0318e7e3 Leszek Koltunski
      case 3: buffer[index  ]=unities[MAXDIM*ordinal  ];
315 6a06a912 Leszek Koltunski
              buffer[index+1]=unities[MAXDIM*ordinal+1]; 
316
              buffer[index+2]=unities[MAXDIM*ordinal+2];
317
              break;
318 0318e7e3 Leszek Koltunski
      case 4: buffer[index  ]=unities[MAXDIM*ordinal  ];
319 6a06a912 Leszek Koltunski
              buffer[index+1]=unities[MAXDIM*ordinal+1]; 
320
              buffer[index+2]=unities[MAXDIM*ordinal+2];
321
              buffer[index+3]=unities[MAXDIM*ordinal+3];
322
              break;
323
      }  
324
    }
325
  
326
///////////////////////////////////////////////////////////////////////////////////////////////////
327
  
328
  static boolean isUnity(int ordinal, float[] buffer, int index)
329
    {
330 1beb6f13 Leszek Koltunski
    switch(unityDimensions[ordinal])
331 6a06a912 Leszek Koltunski
      {
332
      case 0: return true;
333 0318e7e3 Leszek Koltunski
      case 1: return buffer[index  ]==unities[MAXDIM*ordinal  ];
334
      case 2: return buffer[index  ]==unities[MAXDIM*ordinal  ] &&
335 6a06a912 Leszek Koltunski
                     buffer[index+1]==unities[MAXDIM*ordinal+1];
336 0318e7e3 Leszek Koltunski
      case 3: return buffer[index  ]==unities[MAXDIM*ordinal  ] &&
337 6a06a912 Leszek Koltunski
                     buffer[index+1]==unities[MAXDIM*ordinal+1] && 
338
                     buffer[index+2]==unities[MAXDIM*ordinal+2];
339 0318e7e3 Leszek Koltunski
      case 4: return buffer[index  ]==unities[MAXDIM*ordinal  ] &&
340 6a06a912 Leszek Koltunski
                     buffer[index+1]==unities[MAXDIM*ordinal+1] && 
341
                     buffer[index+2]==unities[MAXDIM*ordinal+2] &&
342
                     buffer[index+3]==unities[MAXDIM*ordinal+3];
343
      }
344
   
345
    return false;
346
    }
347
348
///////////////////////////////////////////////////////////////////////////////////////////////////
349 476bbc81 Leszek Koltunski
// PUBLIC API
350
///////////////////////////////////////////////////////////////////////////////////////////////////
351
/**
352
 * Returns the Type of an individual Effect. For example, EffectNames.ROTATION.getType() will
353
 * return EffectTypes.MATRIX.
354
 * @return type of the effect.
355
 */
356
  public EffectTypes getType()
357
    {
358
    return type;
359
    }
360 ac094579 Leszek Koltunski
361 1beb6f13 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
362
363 ac094579 Leszek Koltunski
/**
364
 * Returns the dimension of an Effect (in other words, the number of interpolated values).
365
 * @return dimension of the Effect.
366
 */
367
  public int getDimension() { return dimensions[ordinal()]; }
368 1beb6f13 Leszek Koltunski
369
///////////////////////////////////////////////////////////////////////////////////////////////////
370
371
/**
372
 * Do we support being masked by a Region?
373
 * @return true if the Effect supports being masked with a Region.
374
 */
375
  public boolean supportsRegion() { return supports[ordinal()]; }
376
377 d333eb6b Leszek Koltunski
  }