/src/main/java/org/distorted/library/EffectNames.java - Annotate - Distorted Android

library / src / main / java / org / distorted / library / EffectNames.java @ 5fd28c26

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	e25d0dde	Leszek Koltunski	* 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	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	0df17fad	Leszek Koltunski	* Unity: angle==0
54			*/
55	1e438fc7	Leszek Koltunski	ROTATE ( EffectTypes.MATRIX , new float[] {0.0f} ),
56	0df17fad	Leszek Koltunski	/**
57			* Rotate the whole Object around a center point (in quaternion notation).
58			* <p>
59	e25d0dde	Leszek Koltunski	* Uniforms: (quatX,quatY,quatZ,quatW,centerX,centerY,centerZ)
60	0df17fad	Leszek Koltunski	* 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	e25d0dde	Leszek Koltunski	* Uniforms: (vectorX,vectorY,vectorZ,UNUSED,UNUSED,UNUSED,UNUSED)
67	0df17fad	Leszek Koltunski	* Unity: (vectorX,vectorY,vectorZ) = (0,0,0)
68			*/
69	1e438fc7	Leszek Koltunski	MOVE ( EffectTypes.MATRIX , new float[] {0.0f,0.0f,0.0f} ),
70	0df17fad	Leszek Koltunski	/**
71			* Scale the whole Object independently in all 3 dimensions.
72			* <p>
73	e25d0dde	Leszek Koltunski	* Uniforms: (scaleX,scaleY,scaleZ,UNUSED,UNUSED,UNUSED,UNUSED)
74	0df17fad	Leszek Koltunski	* Unity: (scaleX,scaleY,scaleZ) = (1,1,1)
75			*/
76	1e438fc7	Leszek Koltunski	SCALE ( EffectTypes.MATRIX , new float[] {1.0f,1.0f,1.0f} ),
77	0df17fad	Leszek Koltunski	/**
78			* Shear the whole Object in 3 dimensions around a center point.
79			* <p>
80	e25d0dde	Leszek Koltunski	* Uniforms: (shearX,shearY,shearZ,UNUSED,centerX,centerY,centerZ)
81	0df17fad	Leszek Koltunski	* Unity: (shearX,shearY,shearZ) = (0,0,0)
82			*/
83	1e438fc7	Leszek Koltunski	SHEAR ( EffectTypes.MATRIX , new float[] {0.0f,0.0f,0.0f} ),
84			// add new Matrix effects here...
85	0df17fad	Leszek Koltunski
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	e25d0dde	Leszek Koltunski	* Uniforms: (forceX,forceY,forceZ,regionX,regionY,regionRX,regionRY,centerX,centerY)
94	0df17fad	Leszek Koltunski	* Unity: (forceX,forceY,forceZ) = (0,0,0)
95			*/
96	1e438fc7	Leszek Koltunski	DISTORT ( EffectTypes.VERTEX , new float[] {0.0f,0.0f,0.0f} ), // keep this the first VERT effect (reason: getType)
97	0df17fad	Leszek Koltunski	/**
98			* Deform the whole Object by applying a 2D vector of force to a center point.
99			* <p>
100	e25d0dde	Leszek Koltunski	* Uniforms: (forceX,forceY,UNUSED,UNUSED,UNUSED,UNUSED,UNUSED,centerX,centerY)
101	0df17fad	Leszek Koltunski	* Unity: (forceX,forceY) = (0,0)
102			*/
103	1e438fc7	Leszek Koltunski	DEFORM ( EffectTypes.VERTEX , new float[] {0.0f,0.0f} ),
104	0df17fad	Leszek Koltunski	/**
105			* Pull (or push away) all points around a center point to (from) it.
106			* <p>
107	e25d0dde	Leszek Koltunski	* Uniforms: (sinkFactor,UNUSED,UNUSED,regionX,regionY,regionRX,regionRY,centerX,centerY)
108	0df17fad	Leszek Koltunski	* Unity: sinkFactor = 1
109			*/
110	1e438fc7	Leszek Koltunski	SINK ( EffectTypes.VERTEX , new float[] {1.0f} ),
111	0df17fad	Leszek Koltunski	/**
112			* Smoothly rotate a limited area around a center point.
113			* <p>
114	e25d0dde	Leszek Koltunski	* Uniforms: (swirlAngle,UNUSED,UNUSED,regionX,regionY,regionRX,regionRY,centerX,centerY)
115	0df17fad	Leszek Koltunski	* Unity: swirlAngle = 0
116			*/
117	1e438fc7	Leszek Koltunski	SWIRL ( EffectTypes.VERTEX , new float[] {0.0f} ),
118	6a06a912	Leszek Koltunski	// add new Vertex Effects here...
119	0df17fad	Leszek Koltunski
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	e25d0dde	Leszek Koltunski	* Uniforms: (macroblockSize,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
127	0df17fad	Leszek Koltunski	* Unity: macroblockSize = 1
128			*/
129	1e438fc7	Leszek Koltunski	MACROBLOCK ( EffectTypes.FRAGMENT, new float[] {1.0f} ), // keep this the first FRAG effect (reason: getType)
130	0df17fad	Leszek Koltunski	/**
131			* Make a given Region (partially) transparent.
132			* <p>
133	e25d0dde	Leszek Koltunski	* Uniforms: (transparencyLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
134	0df17fad	Leszek Koltunski	* Unity: transparencyLevel = 1
135			*/
136	1e438fc7	Leszek Koltunski	ALPHA ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
137	0df17fad	Leszek Koltunski	/**
138			* Make a given Region (partially) transparent.
139			* Effect smoothly fades towards the edges of the region.
140			* <p>
141	e25d0dde	Leszek Koltunski	* Uniforms: (transparencyLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
142	0df17fad	Leszek Koltunski	* Unity: transparencyLevel = 1
143			*/
144	1e438fc7	Leszek Koltunski	SMOOTH_ALPHA ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
145	0df17fad	Leszek Koltunski	/**
146			* Blend current color in the texture with a given color.
147			* <p>
148	e25d0dde	Leszek Koltunski	* Uniforms: (blendLevel,colorR,colorG,colorB, regionX, regionY, regionRX, regionRY)
149	0df17fad	Leszek Koltunski	* Unity: blendLevel = 0
150			*/
151	1e438fc7	Leszek Koltunski	CHROMA ( EffectTypes.FRAGMENT, new float[] {0.0f} ),
152	0df17fad	Leszek Koltunski	/**
153			* Smoothly blend current color in the texture with a given color.
154			* <p>
155	e25d0dde	Leszek Koltunski	* Uniforms: (blendLevel,colorR,colorG,colorB, regionX, regionY, regionRX, regionRY)
156	0df17fad	Leszek Koltunski	* Unity: blendLevel = 0
157			*/
158	1e438fc7	Leszek Koltunski	SMOOTH_CHROMA ( EffectTypes.FRAGMENT, new float[] {0.0f} ),
159	0df17fad	Leszek Koltunski	/**
160			* Change brightness level of a given Region.
161			* <p>
162	e25d0dde	Leszek Koltunski	* Uniforms: (brightnessLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
163	0df17fad	Leszek Koltunski	* Unity: brightnessLevel = 1
164			*/
165	1e438fc7	Leszek Koltunski	BRIGHTNESS ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
166	0df17fad	Leszek Koltunski	/**
167			* Smoothly change brightness level of a given Region.
168			* <p>
169	e25d0dde	Leszek Koltunski	* Uniforms: (brightnessLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
170	0df17fad	Leszek Koltunski	* Unity: brightnessLevel = 1
171			*/
172	1e438fc7	Leszek Koltunski	SMOOTH_BRIGHTNESS( EffectTypes.FRAGMENT, new float[] {1.0f} ),
173	0df17fad	Leszek Koltunski	/**
174			* Change saturation level of a given Region.
175			* <p>
176	e25d0dde	Leszek Koltunski	* Uniforms: (saturationLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
177	0df17fad	Leszek Koltunski	* Unity: saturationLevel = 1
178			*/
179	1e438fc7	Leszek Koltunski	SATURATION ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
180	0df17fad	Leszek Koltunski	/**
181			* Smoothly change saturation level of a given Region.
182			* <p>
183	e25d0dde	Leszek Koltunski	* Uniforms: (saturationLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
184	0df17fad	Leszek Koltunski	* Unity: saturationLevel = 1
185			*/
186	1e438fc7	Leszek Koltunski	SMOOTH_SATURATION( EffectTypes.FRAGMENT, new float[] {1.0f} ),
187	0df17fad	Leszek Koltunski	/**
188			* Change contrast level of a given Region.
189			* <p>
190	e25d0dde	Leszek Koltunski	* Uniforms: (contrastLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
191	0df17fad	Leszek Koltunski	* Unity: contrastLevel = 1
192			*/
193	1e438fc7	Leszek Koltunski	CONTRAST ( EffectTypes.FRAGMENT, new float[] {1.0f} ),
194	0df17fad	Leszek Koltunski	/**
195			* Smoothly change contrast level of a given Region.
196			* <p>
197	e25d0dde	Leszek Koltunski	* Uniforms: (contrastLevel,UNUSED,UNUSED,UNUSED, regionX, regionY, regionRX, regionRY)
198	0df17fad	Leszek Koltunski	* Unity: contrastLevel = 1
199			*/
200			SMOOTH_CONTRAST ( EffectTypes.FRAGMENT, new float[] {1.0f} );
201	6a06a912	Leszek Koltunski	// add new Fragment effects here...
202
203			///////////////////////////////////////////////////////////////////////////////////////////////////
204
205			private static final int MAXDIM = 4; // maximum supported dimension of an effect
206
207	1e438fc7	Leszek Koltunski	private EffectTypes type;
208	6a06a912	Leszek Koltunski	private float[] unity;
209
210			static private float[] unities;
211			static private int[] dimensions;
212
213			static
214			{
215			int len = values().length;
216			int i=0;
217
218			dimensions = new int[len];
219			unities = new float[MAXDIM*len];
220
221			for(EffectNames name: EffectNames.values())
222			{
223	b3618cb5	Leszek Koltunski	dimensions[i] = (name.unity==null ? 0 : name.unity.length);
224	6a06a912	Leszek Koltunski
225			switch(dimensions[i])
226			{
227			case 4: unities[MAXDIM*i+3] = name.unity[3];
228			case 3: unities[MAXDIM*i+2] = name.unity[2];
229			case 2: unities[MAXDIM*i+1] = name.unity[1];
230			case 1: unities[MAXDIM*i+0] = name.unity[0];
231			case 0: break;
232			}
233
234			i++;
235			}
236			}
237
238			///////////////////////////////////////////////////////////////////////////////////////////////////
239
240	1e438fc7	Leszek Koltunski	EffectNames(EffectTypes type, float[] unity)
241	6a06a912	Leszek Koltunski	{
242			this.type = type;
243			this.unity= unity;
244			}
245
246			///////////////////////////////////////////////////////////////////////////////////////////////////
247	476bbc81	Leszek Koltunski	// yes, I know we could have used values(i) but that allocates a new copy each time!
248	c6e1c219	Leszek Koltunski
249	1e438fc7	Leszek Koltunski	static EffectTypes getType(int ordinal)
250	6a06a912	Leszek Koltunski	{
251	1e438fc7	Leszek Koltunski	if( ordinal<DISTORT.ordinal() ) return EffectTypes.MATRIX;
252			if( ordinal<MACROBLOCK.ordinal() ) return EffectTypes.VERTEX;
253	b3618cb5	Leszek Koltunski
254	cdd6333d	Leszek Koltunski	return EffectTypes.FRAGMENT;
255	6a06a912	Leszek Koltunski	}
256
257			///////////////////////////////////////////////////////////////////////////////////////////////////
258
259			static void fillWithUnities(int ordinal, float[] buffer, int index)
260			{
261			switch(dimensions[ordinal])
262			{
263			case 0: break;
264			case 1: buffer[index+0]=unities[MAXDIM*ordinal+0];
265			break;
266			case 2: buffer[index+0]=unities[MAXDIM*ordinal+0];
267			buffer[index+1]=unities[MAXDIM*ordinal+1];
268			break;
269			case 3: buffer[index+0]=unities[MAXDIM*ordinal+0];
270			buffer[index+1]=unities[MAXDIM*ordinal+1];
271			buffer[index+2]=unities[MAXDIM*ordinal+2];
272			break;
273			case 4: buffer[index+0]=unities[MAXDIM*ordinal+0];
274			buffer[index+1]=unities[MAXDIM*ordinal+1];
275			buffer[index+2]=unities[MAXDIM*ordinal+2];
276			buffer[index+3]=unities[MAXDIM*ordinal+3];
277			break;
278			}
279			}
280
281			///////////////////////////////////////////////////////////////////////////////////////////////////
282
283			static boolean isUnity(int ordinal, float[] buffer, int index)
284			{
285			switch(dimensions[ordinal])
286			{
287			case 0: return true;
288			case 1: return buffer[index+0]==unities[MAXDIM*ordinal+0];
289			case 2: return buffer[index+0]==unities[MAXDIM*ordinal+0] &&
290			buffer[index+1]==unities[MAXDIM*ordinal+1];
291			case 3: return buffer[index+0]==unities[MAXDIM*ordinal+0] &&
292			buffer[index+1]==unities[MAXDIM*ordinal+1] &&
293			buffer[index+2]==unities[MAXDIM*ordinal+2];
294			case 4: return buffer[index+0]==unities[MAXDIM*ordinal+0] &&
295			buffer[index+1]==unities[MAXDIM*ordinal+1] &&
296			buffer[index+2]==unities[MAXDIM*ordinal+2] &&
297			buffer[index+3]==unities[MAXDIM*ordinal+3];
298			}
299
300			return false;
301			}
302
303			///////////////////////////////////////////////////////////////////////////////////////////////////
304	476bbc81	Leszek Koltunski	// PUBLIC API
305			///////////////////////////////////////////////////////////////////////////////////////////////////
306			/**
307			* Returns the Type of an individual Effect. For example, EffectNames.ROTATION.getType() will
308			* return EffectTypes.MATRIX.
309			* @return type of the effect.
310			*/
311			public EffectTypes getType()
312			{
313			return type;
314			}
315	d333eb6b	Leszek Koltunski	}

Project

General

Profile

Distorted Android

library / src / main / java / org / distorted / library / EffectNames.java @ 5fd28c26