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

library / src / main / java / org / distorted / library / effect / EffectName.java @ c1fa9e3c

1	da9b3f07	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
2			// Copyright 2016 Leszek Koltunski //
3			// //
4	46b572b5	Leszek Koltunski	// This file is part of Distorted. //
5	da9b3f07	Leszek Koltunski	// //
6	46b572b5	Leszek Koltunski	// Distorted is free software: you can redistribute it and/or modify //
7	da9b3f07	Leszek Koltunski	// 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	46b572b5	Leszek Koltunski	// Distorted is distributed in the hope that it will be useful, //
12	da9b3f07	Leszek Koltunski	// 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	46b572b5	Leszek Koltunski	// along with Distorted. If not, see <http://www.gnu.org/licenses/>. //
18	da9b3f07	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
19
20			package org.distorted.library.effect;
21
22			///////////////////////////////////////////////////////////////////////////////////////////////////
23			/**
24			* Names of Effects one can add to the DistortedEffects queues.
25			* <p>
26			* Effect's 'Type' is one of the constants defined in {@link EffectType}.
27	9d0d8530	leszek	* </p>
28			* <p>
29			* Effect's 'Uniforms' are a vector of 7 (matrix effects) 12 (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	da9b3f07	Leszek Koltunski	*/
42
43			public enum EffectName
44			{
45	143095f7	Leszek Koltunski	// EFFECT NAME /////// EFFECT TYPE ////////// EFFECT UNITY //////////// DIM REGION CENTER // CLASS
46	b24e4719	Leszek Koltunski	ROTATE ( EffectType.MATRIX , new float[] {0.0f} , 4, 0, 3 , MatrixEffectRotate.class ),
47			QUATERNION ( EffectType.MATRIX , new float[] {0.0f,0.0f,0.0f} , 4, 0, 3 , MatrixEffectQuaternion.class ),
48			MOVE ( EffectType.MATRIX , new float[] {0.0f,0.0f,0.0f} , 3, 0, 0 , MatrixEffectMove.class ),
49			SCALE ( EffectType.MATRIX , new float[] {1.0f,1.0f,1.0f} , 3, 0, 0 , MatrixEffectScale.class ),
50			SHEAR ( EffectType.MATRIX , new float[] {0.0f,0.0f,0.0f} , 3, 0, 3 , MatrixEffectShear.class ),
51
52	5e96393c	Leszek Koltunski	DISTORT ( EffectType.VERTEX , new float[] {0.0f,0.0f,0.0f} , 3, 4, 3 , VertexEffectDistort.class ),
53	0f10a0b6	Leszek Koltunski	DEFORM ( EffectType.VERTEX , new float[] {0.0f,0.0f,0.0f} , 4, 4, 3 , VertexEffectDeform.class ),
54	5e96393c	Leszek Koltunski	SINK ( EffectType.VERTEX , new float[] {1.0f} , 1, 4, 3 , VertexEffectSink.class ),
55	aee0b581	Leszek Koltunski	PINCH ( EffectType.VERTEX , new float[] {1.0f} , 3, 4, 3 , VertexEffectPinch.class ),
56	5e96393c	Leszek Koltunski	SWIRL ( EffectType.VERTEX , new float[] {0.0f} , 1, 4, 3 , VertexEffectSwirl.class ),
57			WAVE ( EffectType.VERTEX , new float[] {0.0f} , 5, 4, 3 , VertexEffectWave.class ),
58	e979d285	Leszek Koltunski	VERTEX_MOVE ( EffectType.VERTEX , new float[] {0.0f,0.0f,0.0f} , 3, 0, 0 , VertexEffectMove.class ),
59			VERTEX_QUATERNION( EffectType.VERTEX , new float[] {0.0f,0.0f,0.0f} , 4, 0, 3 , VertexEffectQuaternion.class ),
60	9f34a0f6	Leszek Koltunski	VERTEX_ROTATE ( EffectType.VERTEX , new float[] {0.0f} , 4, 0, 3 , VertexEffectRotate.class ),
61	a918bba1	Leszek Koltunski	VERTEX_SCALE ( EffectType.VERTEX , new float[] {1.0f,1.0f,1.0f} , 3, 0, 0 , VertexEffectScale.class ),
62	00be51f0	Leszek Koltunski	VERTEX_SHEAR ( EffectType.VERTEX , new float[] {0.0f,0.0f,0.0f} , 3, 0, 3 , VertexEffectShear.class ),
63	b24e4719	Leszek Koltunski
64	5e96393c	Leszek Koltunski	ALPHA ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectAlpha.class ),
65			SMOOTH_ALPHA ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectAlpha.class ),
66			CHROMA ( EffectType.FRAGMENT, new float[] {0.0f} , 4, 3, 3 , FragmentEffectChroma.class ),
67			SMOOTH_CHROMA ( EffectType.FRAGMENT, new float[] {0.0f} , 4, 3, 3 , FragmentEffectChroma.class ),
68			BRIGHTNESS ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectBrightness.class ),
69			SMOOTH_BRIGHTNESS( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectBrightness.class ),
70			SATURATION ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectSaturation.class ),
71			SMOOTH_SATURATION( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectSaturation.class ),
72			CONTRAST ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectContrast.class ),
73			SMOOTH_CONTRAST ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectContrast.class ),
74	b24e4719	Leszek Koltunski
75	bb4755e2	Leszek Koltunski	BLUR ( EffectType.POSTPROCESS,new float[] {0.0f} , 2, 0, 0 , PostprocessEffectBlur.class ),
76			GLOW ( EffectType.POSTPROCESS,new float[] {0.0f} , 6, 0, 0 , PostprocessEffectGlow.class );
77	da9b3f07	Leszek Koltunski
78			///////////////////////////////////////////////////////////////////////////////////////////////////
79
80	c3651001	Leszek Koltunski	public static final int LENGTH = values().length;
81	9d0d8530	leszek
82	da9b3f07	Leszek Koltunski	private final EffectType type;
83	9d0d8530	leszek	private final float[] unity;
84			private final int dimension;
85	b24e4719	Leszek Koltunski	private final int regionDim;
86			private final int centerDim;
87	2f1f7570	Leszek Koltunski	private final Class<? extends Effect> effectClass;
88	9d0d8530	leszek
89			private static final int[] dimensions;
90	b24e4719	Leszek Koltunski	private static final int[] regionDimension;
91			private static final int[] centerDimension;
92	c3651001	Leszek Koltunski	private static final EffectName[] names; // copy the values() to a local variable so that we
93			// don't have to keep recreating the array every time
94			static
95	da9b3f07	Leszek Koltunski	{
96	c3651001	Leszek Koltunski	int i=0;
97	9d0d8530	leszek
98			dimensions = new int[LENGTH];
99	b24e4719	Leszek Koltunski	regionDimension = new int[LENGTH];
100			centerDimension = new int[LENGTH];
101	9d0d8530	leszek	names = new EffectName[LENGTH];
102	c3651001	Leszek Koltunski
103			for(EffectName name: EffectName.values())
104			{
105	9d0d8530	leszek	dimensions[i] = name.dimension;
106	b24e4719	Leszek Koltunski	regionDimension[i] = name.regionDim;
107			centerDimension[i] = name.centerDim;
108	9d0d8530	leszek	names[i] = name;
109
110			i++;
111	c3651001	Leszek Koltunski	}
112	da9b3f07	Leszek Koltunski	}
113
114			///////////////////////////////////////////////////////////////////////////////////////////////////
115
116	9d0d8530	leszek	float[] getUnity()
117			{
118			return unity;
119			}
120
121			///////////////////////////////////////////////////////////////////////////////////////////////////
122
123	b24e4719	Leszek Koltunski	EffectName(EffectType type, float[] unity, int dimension, int regionDim,
124			int centerDim, Class<? extends Effect> effectClass )
125	da9b3f07	Leszek Koltunski	{
126	2f1f7570	Leszek Koltunski	this.type = type;
127			this.unity = unity;
128			this.dimension = dimension;
129	b24e4719	Leszek Koltunski	this.regionDim = regionDim;
130			this.centerDim = centerDim;
131	2f1f7570	Leszek Koltunski	this.effectClass = effectClass;
132	da9b3f07	Leszek Koltunski	}
133
134			///////////////////////////////////////////////////////////////////////////////////////////////////
135			// PUBLIC API
136			///////////////////////////////////////////////////////////////////////////////////////////////////
137			/**
138	143095f7	Leszek Koltunski	* Returns the Type of an individual Effect. For example, EffectName.ROTATE.getType() will
139	da9b3f07	Leszek Koltunski	* return EffectType.MATRIX.
140			* @return type of the effect.
141			*/
142			public EffectType getType()
143			{
144			return type;
145			}
146	c3651001	Leszek Koltunski
147	2f1f7570	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
148	143095f7	Leszek Koltunski	/**
149			* Returns the Class of an individual Effect. For example, EffectName.ROTATE.getEffectClass()
150			* returns MatrixEffectRotate.class.
151			* @return effect class.
152			*/
153	2f1f7570	Leszek Koltunski	public Class<? extends Effect> getEffectClass()
154			{
155			return effectClass;
156			}
157
158	c3651001	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
159			/**
160			* Returns the i-th EffectName.
161			* <p>
162			* If you want to loop over all possible Effects, you need this.
163			*/
164			public static EffectName getName(int ordinal)
165			{
166			return names[ordinal];
167			}
168	9d0d8530	leszek
169			///////////////////////////////////////////////////////////////////////////////////////////////////
170			/**
171			* Returns the dimension of an Effect (in other words, the number of interpolated values).
172			* @return dimension of the Effect.
173			*/
174	b24e4719	Leszek Koltunski	public int getEffectDimension() { return dimensions[ordinal()]; }
175	9d0d8530	leszek
176			///////////////////////////////////////////////////////////////////////////////////////////////////
177			/**
178	b24e4719	Leszek Koltunski	* What is the dimension of the Region supported by this effect?
179			* @return Dimension of the Region supported (0-region not supported at all).
180	9d0d8530	leszek	*/
181	b24e4719	Leszek Koltunski	public int getRegionDimension() { return regionDimension[ordinal()]; }
182	9d0d8530	leszek
183			///////////////////////////////////////////////////////////////////////////////////////////////////
184			/**
185	b24e4719	Leszek Koltunski	* What is the dimension of the Center supported by this effect?
186			* @return Dimension of the Center supported (0-center not supported at all).
187	9d0d8530	leszek	*/
188	b24e4719	Leszek Koltunski	public int getCenterDimension() { return centerDimension[ordinal()]; }
189	da9b3f07	Leszek Koltunski	}

Project

General

Profile

Distorted Android

library / src / main / java / org / distorted / library / effect / EffectName.java @ c1fa9e3c