1
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
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
|
package org.distorted.library;
|
21
|
|
22
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
23
|
/**
|
24
|
* Names of Effects one can apply to DistortedObjects.
|
25
|
* <p>
|
26
|
* Effect's 'Type' is one of the constants defined in {@see EffectTypes}.
|
27
|
* </p>
|
28
|
* <p>
|
29
|
* Effect's 'Uniforms' are a vector of 7 (matrix effects) 9 (vertex) or 8 (fragment) floats, which
|
30
|
* 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
|
*/
|
42
|
public enum EffectNames
|
43
|
{
|
44
|
// EFFECT NAME /////// EFFECT TYPE ////////////// UNITY /////////////////////////
|
45
|
|
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
|
* Uniforms: (angle,axisX,axisY,axisZ,centerX,centerY,centerZ)
|
53
|
* Unity: angle==0
|
54
|
*/
|
55
|
ROTATE ( EffectTypes.MATRIX , new float[] {0.0f} ),
|
56
|
/**
|
57
|
* Rotate the whole Object around a center point (in quaternion notation).
|
58
|
* <p>
|
59
|
* Uniforms: (quatX,quatY,quatZ,quatW,centerX,centerY,centerZ)
|
60
|
* Unity: (quatX,quatY,quatZ) = (0,0,0)
|
61
|
*/
|
62
|
QUATERNION ( EffectTypes.MATRIX , new float[] {0.0f,0.0f,0.0f} ),
|
63
|
/**
|
64
|
* Move the whole Object by a vector.
|
65
|
* <p>
|
66
|
* Uniforms: (vectorX,vectorY,vectorZ,UNUSED,UNUSED,UNUSED,UNUSED)
|
67
|
* Unity: (vectorX,vectorY,vectorZ) = (0,0,0)
|
68
|
*/
|
69
|
MOVE ( EffectTypes.MATRIX , new float[] {0.0f,0.0f,0.0f} ),
|
70
|
/**
|
71
|
* Scale the whole Object independently in all 3 dimensions.
|
72
|
* <p>
|
73
|
* Uniforms: (scaleX,scaleY,scaleZ,UNUSED,UNUSED,UNUSED,UNUSED)
|
74
|
* Unity: (scaleX,scaleY,scaleZ) = (1,1,1)
|
75
|
*/
|
76
|
SCALE ( EffectTypes.MATRIX , new float[] {1.0f,1.0f,1.0f} ),
|
77
|
/**
|
78
|
* Shear the whole Object in 3 dimensions around a center point.
|
79
|
* <p>
|
80
|
* Uniforms: (shearX,shearY,shearZ,UNUSED,centerX,centerY,centerZ)
|
81
|
* Unity: (shearX,shearY,shearZ) = (0,0,0)
|
82
|
*/
|
83
|
SHEAR ( EffectTypes.MATRIX , new float[] {0.0f,0.0f,0.0f} ),
|
84
|
// add new Matrix effects here...
|
85
|
|
86
|
/////////////////////////////////////////////////////////////////////////////////
|
87
|
// VERTEX EFFECTS
|
88
|
// Always 9 Uniforms: 3 per-effect interpolated values, 4-dimensional Region,
|
89
|
// 2-dimensional center of the effect.
|
90
|
/**
|
91
|
* Apply a 3D vector of force to area around a point on the surface of the Object.
|
92
|
* <p>
|
93
|
* Uniforms: (forceX,forceY,forceZ,regionX,regionY,regionRX,regionRY,centerX,centerY)
|
94
|
* Unity: (forceX,forceY,forceZ) = (0,0,0)
|
95
|
*/
|
96
|
DISTORT ( EffectTypes.VERTEX , new float[] {0.0f,0.0f,0.0f} ),
|
97
|
/**
|
98
|
* Deform the whole Object by applying a 2D vector of force to a center point.
|
99
|
* <p>
|
100
|
* Uniforms: (forceX,forceY,UNUSED,UNUSED,UNUSED,UNUSED,UNUSED,centerX,centerY)
|
101
|
* Unity: (forceX,forceY) = (0,0)
|
102
|
*/
|
103
|
DEFORM ( EffectTypes.VERTEX , new float[] {0.0f,0.0f} ),
|
104
|
/**
|
105
|
* Pull (or push away) all points around a center point to (from) it.
|
106
|
* <p>
|
107
|
* Uniforms: (sinkFactor,UNUSED,UNUSED,regionX,regionY,regionRX,regionRY,centerX,centerY)
|
108
|
* Unity: sinkFactor = 1
|
109
|
*/
|
110
|
SINK ( EffectTypes.VERTEX , new float[] {1.0f} ),
|
111
|
/**
|
112
|
* Smoothly rotate a limited area around a center point.
|
113
|
* <p>
|
114
|
* Uniforms: (swirlAngle,UNUSED,UNUSED,regionX,regionY,regionRX,regionRY,centerX,centerY)
|
115
|
* Unity: swirlAngle = 0
|
116
|
*/
|
117
|
SWIRL ( EffectTypes.VERTEX , new float[] {0.0f} ),
|
118
|
// add new Vertex Effects here...
|
119
|
|
120
|
/////////////////////////////////////////////////////////////////////////////////
|
121
|
// FRAGMENT EFFECTS
|
122
|
// Always 8 Uniforms: 4-per effect interpolated values, 4 dimensional Region.
|
123
|
/**
|
124
|
* Create square-shaped macroblocks.
|
125
|
* <p>
|
126
|
* Uniforms: (macroblockSize,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
127
|
* Unity: macroblockSize = 1
|
128
|
*/
|
129
|
MACROBLOCK ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
|
130
|
/**
|
131
|
* Make a given Region (partially) transparent.
|
132
|
* <p>
|
133
|
* Uniforms: (transparencyLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
134
|
* Unity: transparencyLevel = 1
|
135
|
*/
|
136
|
ALPHA ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
|
137
|
/**
|
138
|
* Make a given Region (partially) transparent.
|
139
|
* Effect smoothly fades towards the edges of the region.
|
140
|
* <p>
|
141
|
* Uniforms: (transparencyLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
142
|
* Unity: transparencyLevel = 1
|
143
|
*/
|
144
|
SMOOTH_ALPHA ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
|
145
|
/**
|
146
|
* Blend current color in the texture with a given color.
|
147
|
* <p>
|
148
|
* Uniforms: (blendLevel,colorR,colorG,colorB, regionX, regionY, regionRX, regionRY)
|
149
|
* Unity: blendLevel = 0
|
150
|
*/
|
151
|
CHROMA ( EffectTypes.FRAGMENT, new float[] {0.0f} ),
|
152
|
/**
|
153
|
* Smoothly blend current color in the texture with a given color.
|
154
|
* <p>
|
155
|
* Uniforms: (blendLevel,colorR,colorG,colorB, regionX, regionY, regionRX, regionRY)
|
156
|
* Unity: blendLevel = 0
|
157
|
*/
|
158
|
SMOOTH_CHROMA ( EffectTypes.FRAGMENT, new float[] {0.0f} ),
|
159
|
/**
|
160
|
* Change brightness level of a given Region.
|
161
|
* <p>
|
162
|
* Uniforms: (brightnessLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
163
|
* Unity: brightnessLevel = 1
|
164
|
*/
|
165
|
BRIGHTNESS ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
|
166
|
/**
|
167
|
* Smoothly change brightness level of a given Region.
|
168
|
* <p>
|
169
|
* Uniforms: (brightnessLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
170
|
* Unity: brightnessLevel = 1
|
171
|
*/
|
172
|
SMOOTH_BRIGHTNESS( EffectTypes.FRAGMENT, new float[] {1.0f} ),
|
173
|
/**
|
174
|
* Change saturation level of a given Region.
|
175
|
* <p>
|
176
|
* Uniforms: (saturationLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
177
|
* Unity: saturationLevel = 1
|
178
|
*/
|
179
|
SATURATION ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
|
180
|
/**
|
181
|
* Smoothly change saturation level of a given Region.
|
182
|
* <p>
|
183
|
* Uniforms: (saturationLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
184
|
* Unity: saturationLevel = 1
|
185
|
*/
|
186
|
SMOOTH_SATURATION( EffectTypes.FRAGMENT, new float[] {1.0f} ),
|
187
|
/**
|
188
|
* Change contrast level of a given Region.
|
189
|
* <p>
|
190
|
* Uniforms: (contrastLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
191
|
* Unity: contrastLevel = 1
|
192
|
*/
|
193
|
CONTRAST ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
|
194
|
/**
|
195
|
* Smoothly change contrast level of a given Region.
|
196
|
* <p>
|
197
|
* Uniforms: (contrastLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
|
198
|
* Unity: contrastLevel = 1
|
199
|
*/
|
200
|
SMOOTH_CONTRAST ( EffectTypes.FRAGMENT, new float[] {1.0f} );
|
201
|
// add new Fragment effects here...
|
202
|
|
203
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
204
|
|
205
|
private static final int MAXDIM = 4; // maximum supported dimension of an effect
|
206
|
|
207
|
private final EffectTypes type;
|
208
|
private final float[] unity;
|
209
|
|
210
|
private static final float[] unities;
|
211
|
private static final int[] dimensions;
|
212
|
private static final EffectNames[] names;
|
213
|
|
214
|
static
|
215
|
{
|
216
|
int len = values().length;
|
217
|
int i=0;
|
218
|
|
219
|
dimensions = new int[len];
|
220
|
unities = new float[MAXDIM*len];
|
221
|
names = new EffectNames[len];
|
222
|
|
223
|
for(EffectNames name: EffectNames.values())
|
224
|
{
|
225
|
dimensions[i] = (name.unity==null ? 0 : name.unity.length);
|
226
|
names[i] = name;
|
227
|
|
228
|
switch(dimensions[i])
|
229
|
{
|
230
|
case 4: unities[MAXDIM*i+3] = name.unity[3];
|
231
|
case 3: unities[MAXDIM*i+2] = name.unity[2];
|
232
|
case 2: unities[MAXDIM*i+1] = name.unity[1];
|
233
|
case 1: unities[MAXDIM*i ] = name.unity[0];
|
234
|
case 0: break;
|
235
|
}
|
236
|
|
237
|
i++;
|
238
|
}
|
239
|
}
|
240
|
|
241
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
242
|
|
243
|
EffectNames(EffectTypes type, float[] unity)
|
244
|
{
|
245
|
this.type = type;
|
246
|
this.unity= unity;
|
247
|
}
|
248
|
|
249
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
250
|
|
251
|
static EffectTypes getType(int ordinal)
|
252
|
{
|
253
|
return names[ordinal].type;
|
254
|
}
|
255
|
|
256
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
257
|
|
258
|
static EffectNames getName(int ordinal)
|
259
|
{
|
260
|
return names[ordinal];
|
261
|
}
|
262
|
|
263
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
264
|
|
265
|
static void fillWithUnities(int ordinal, float[] buffer, int index)
|
266
|
{
|
267
|
switch(dimensions[ordinal])
|
268
|
{
|
269
|
case 0: break;
|
270
|
case 1: buffer[index ]=unities[MAXDIM*ordinal ];
|
271
|
break;
|
272
|
case 2: buffer[index ]=unities[MAXDIM*ordinal ];
|
273
|
buffer[index+1]=unities[MAXDIM*ordinal+1];
|
274
|
break;
|
275
|
case 3: buffer[index ]=unities[MAXDIM*ordinal ];
|
276
|
buffer[index+1]=unities[MAXDIM*ordinal+1];
|
277
|
buffer[index+2]=unities[MAXDIM*ordinal+2];
|
278
|
break;
|
279
|
case 4: buffer[index ]=unities[MAXDIM*ordinal ];
|
280
|
buffer[index+1]=unities[MAXDIM*ordinal+1];
|
281
|
buffer[index+2]=unities[MAXDIM*ordinal+2];
|
282
|
buffer[index+3]=unities[MAXDIM*ordinal+3];
|
283
|
break;
|
284
|
}
|
285
|
}
|
286
|
|
287
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
288
|
|
289
|
static boolean isUnity(int ordinal, float[] buffer, int index)
|
290
|
{
|
291
|
switch(dimensions[ordinal])
|
292
|
{
|
293
|
case 0: return true;
|
294
|
case 1: return buffer[index ]==unities[MAXDIM*ordinal ];
|
295
|
case 2: return buffer[index ]==unities[MAXDIM*ordinal ] &&
|
296
|
buffer[index+1]==unities[MAXDIM*ordinal+1];
|
297
|
case 3: return buffer[index ]==unities[MAXDIM*ordinal ] &&
|
298
|
buffer[index+1]==unities[MAXDIM*ordinal+1] &&
|
299
|
buffer[index+2]==unities[MAXDIM*ordinal+2];
|
300
|
case 4: return buffer[index ]==unities[MAXDIM*ordinal ] &&
|
301
|
buffer[index+1]==unities[MAXDIM*ordinal+1] &&
|
302
|
buffer[index+2]==unities[MAXDIM*ordinal+2] &&
|
303
|
buffer[index+3]==unities[MAXDIM*ordinal+3];
|
304
|
}
|
305
|
|
306
|
return false;
|
307
|
}
|
308
|
|
309
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
310
|
// PUBLIC API
|
311
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
312
|
/**
|
313
|
* Returns the Type of an individual Effect. For example, EffectNames.ROTATION.getType() will
|
314
|
* return EffectTypes.MATRIX.
|
315
|
* @return type of the effect.
|
316
|
*/
|
317
|
public EffectTypes getType()
|
318
|
{
|
319
|
return type;
|
320
|
}
|
321
|
|
322
|
/**
|
323
|
* Returns the dimension of an Effect (in other words, the number of interpolated values).
|
324
|
* @return dimension of the Effect.
|
325
|
*/
|
326
|
public int getDimension() { return dimensions[ordinal()]; }
|
327
|
}
|