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 |
|
|
DEFORM ( EffectType.VERTEX , new float[] {0.0f,0.0f,0.0f} , 3, 4, 3 , VertexEffectDeform.class ),
|
54 |
|
|
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 |
b24e4719
|
Leszek Koltunski
|
|
59 |
5e96393c
|
Leszek Koltunski
|
ALPHA ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectAlpha.class ),
|
60 |
|
|
SMOOTH_ALPHA ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectAlpha.class ),
|
61 |
|
|
CHROMA ( EffectType.FRAGMENT, new float[] {0.0f} , 4, 3, 3 , FragmentEffectChroma.class ),
|
62 |
|
|
SMOOTH_CHROMA ( EffectType.FRAGMENT, new float[] {0.0f} , 4, 3, 3 , FragmentEffectChroma.class ),
|
63 |
|
|
BRIGHTNESS ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectBrightness.class ),
|
64 |
|
|
SMOOTH_BRIGHTNESS( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectBrightness.class ),
|
65 |
|
|
SATURATION ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectSaturation.class ),
|
66 |
|
|
SMOOTH_SATURATION( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectSaturation.class ),
|
67 |
|
|
CONTRAST ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectContrast.class ),
|
68 |
|
|
SMOOTH_CONTRAST ( EffectType.FRAGMENT, new float[] {1.0f} , 1, 3, 3 , FragmentEffectContrast.class ),
|
69 |
b24e4719
|
Leszek Koltunski
|
|
70 |
|
|
BLUR ( EffectType.POSTPROCESS,new float[] {0.0f} , 1, 0, 0 , PostprocessEffectBlur.class ),
|
71 |
|
|
GLOW ( EffectType.POSTPROCESS,new float[] {0.0f} , 5, 0, 0 , PostprocessEffectGlow.class );
|
72 |
da9b3f07
|
Leszek Koltunski
|
|
73 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
74 |
|
|
|
75 |
c3651001
|
Leszek Koltunski
|
public static final int LENGTH = values().length;
|
76 |
9d0d8530
|
leszek
|
|
77 |
da9b3f07
|
Leszek Koltunski
|
private final EffectType type;
|
78 |
9d0d8530
|
leszek
|
private final float[] unity;
|
79 |
|
|
private final int dimension;
|
80 |
b24e4719
|
Leszek Koltunski
|
private final int regionDim;
|
81 |
|
|
private final int centerDim;
|
82 |
2f1f7570
|
Leszek Koltunski
|
private final Class<? extends Effect> effectClass;
|
83 |
9d0d8530
|
leszek
|
|
84 |
|
|
private static final int[] dimensions;
|
85 |
b24e4719
|
Leszek Koltunski
|
private static final int[] regionDimension;
|
86 |
|
|
private static final int[] centerDimension;
|
87 |
c3651001
|
Leszek Koltunski
|
private static final EffectName[] names; // copy the values() to a local variable so that we
|
88 |
|
|
// don't have to keep recreating the array every time
|
89 |
|
|
static
|
90 |
da9b3f07
|
Leszek Koltunski
|
{
|
91 |
c3651001
|
Leszek Koltunski
|
int i=0;
|
92 |
9d0d8530
|
leszek
|
|
93 |
|
|
dimensions = new int[LENGTH];
|
94 |
b24e4719
|
Leszek Koltunski
|
regionDimension = new int[LENGTH];
|
95 |
|
|
centerDimension = new int[LENGTH];
|
96 |
9d0d8530
|
leszek
|
names = new EffectName[LENGTH];
|
97 |
c3651001
|
Leszek Koltunski
|
|
98 |
|
|
for(EffectName name: EffectName.values())
|
99 |
|
|
{
|
100 |
9d0d8530
|
leszek
|
dimensions[i] = name.dimension;
|
101 |
b24e4719
|
Leszek Koltunski
|
regionDimension[i] = name.regionDim;
|
102 |
|
|
centerDimension[i] = name.centerDim;
|
103 |
9d0d8530
|
leszek
|
names[i] = name;
|
104 |
|
|
|
105 |
|
|
i++;
|
106 |
c3651001
|
Leszek Koltunski
|
}
|
107 |
da9b3f07
|
Leszek Koltunski
|
}
|
108 |
|
|
|
109 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
110 |
|
|
|
111 |
9d0d8530
|
leszek
|
float[] getUnity()
|
112 |
|
|
{
|
113 |
|
|
return unity;
|
114 |
|
|
}
|
115 |
|
|
|
116 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
117 |
|
|
|
118 |
b24e4719
|
Leszek Koltunski
|
EffectName(EffectType type, float[] unity, int dimension, int regionDim,
|
119 |
|
|
int centerDim, Class<? extends Effect> effectClass )
|
120 |
da9b3f07
|
Leszek Koltunski
|
{
|
121 |
2f1f7570
|
Leszek Koltunski
|
this.type = type;
|
122 |
|
|
this.unity = unity;
|
123 |
|
|
this.dimension = dimension;
|
124 |
b24e4719
|
Leszek Koltunski
|
this.regionDim = regionDim;
|
125 |
|
|
this.centerDim = centerDim;
|
126 |
2f1f7570
|
Leszek Koltunski
|
this.effectClass = effectClass;
|
127 |
da9b3f07
|
Leszek Koltunski
|
}
|
128 |
|
|
|
129 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
130 |
|
|
// PUBLIC API
|
131 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
132 |
|
|
/**
|
133 |
143095f7
|
Leszek Koltunski
|
* Returns the Type of an individual Effect. For example, EffectName.ROTATE.getType() will
|
134 |
da9b3f07
|
Leszek Koltunski
|
* return EffectType.MATRIX.
|
135 |
|
|
* @return type of the effect.
|
136 |
|
|
*/
|
137 |
|
|
public EffectType getType()
|
138 |
|
|
{
|
139 |
|
|
return type;
|
140 |
|
|
}
|
141 |
c3651001
|
Leszek Koltunski
|
|
142 |
2f1f7570
|
Leszek Koltunski
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
143 |
143095f7
|
Leszek Koltunski
|
/**
|
144 |
|
|
* Returns the Class of an individual Effect. For example, EffectName.ROTATE.getEffectClass()
|
145 |
|
|
* returns MatrixEffectRotate.class.
|
146 |
|
|
* @return effect class.
|
147 |
|
|
*/
|
148 |
2f1f7570
|
Leszek Koltunski
|
public Class<? extends Effect> getEffectClass()
|
149 |
|
|
{
|
150 |
|
|
return effectClass;
|
151 |
|
|
}
|
152 |
|
|
|
153 |
c3651001
|
Leszek Koltunski
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
154 |
|
|
/**
|
155 |
|
|
* Returns the i-th EffectName.
|
156 |
|
|
* <p>
|
157 |
|
|
* If you want to loop over all possible Effects, you need this.
|
158 |
|
|
*/
|
159 |
|
|
public static EffectName getName(int ordinal)
|
160 |
|
|
{
|
161 |
|
|
return names[ordinal];
|
162 |
|
|
}
|
163 |
9d0d8530
|
leszek
|
|
164 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
165 |
|
|
/**
|
166 |
|
|
* Returns the dimension of an Effect (in other words, the number of interpolated values).
|
167 |
|
|
* @return dimension of the Effect.
|
168 |
|
|
*/
|
169 |
b24e4719
|
Leszek Koltunski
|
public int getEffectDimension() { return dimensions[ordinal()]; }
|
170 |
9d0d8530
|
leszek
|
|
171 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
172 |
|
|
/**
|
173 |
b24e4719
|
Leszek Koltunski
|
* What is the dimension of the Region supported by this effect?
|
174 |
|
|
* @return Dimension of the Region supported (0-region not supported at all).
|
175 |
9d0d8530
|
leszek
|
*/
|
176 |
b24e4719
|
Leszek Koltunski
|
public int getRegionDimension() { return regionDimension[ordinal()]; }
|
177 |
9d0d8530
|
leszek
|
|
178 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
179 |
|
|
/**
|
180 |
b24e4719
|
Leszek Koltunski
|
* What is the dimension of the Center supported by this effect?
|
181 |
|
|
* @return Dimension of the Center supported (0-center not supported at all).
|
182 |
9d0d8530
|
leszek
|
*/
|
183 |
b24e4719
|
Leszek Koltunski
|
public int getCenterDimension() { return centerDimension[ordinal()]; }
|
184 |
da9b3f07
|
Leszek Koltunski
|
}
|