commit faa3ff56bbf5af5cc9fc48573cd0ea16658017bc Author: Leszek Koltunski Date: Tue Jun 27 11:57:06 2017 +0100 Javadoc. diff --git a/src/main/java/org/distorted/library/effect/Effect.java b/src/main/java/org/distorted/library/effect/Effect.java index 3c333e8..51926d0 100644 --- a/src/main/java/org/distorted/library/effect/Effect.java +++ b/src/main/java/org/distorted/library/effect/Effect.java @@ -20,7 +20,9 @@ package org.distorted.library.effect; /////////////////////////////////////////////////////////////////////////////////////////////////// - +/** + * Abstract Effect of any type. + */ public abstract class Effect { private final static int MAX_UNITY_DIM = 4; @@ -47,10 +49,34 @@ public abstract class Effect /////////////////////////////////////////////////////////////////////////////////////////////////// - public abstract boolean compute(float[] uniforms, int index, long currentDuration, long step ); + Effect(EffectName name) + { + mName = name; + mType = name.getType(); + mDimension = name.getDimension(); + mSupportsC = name.supportsCenter(); + mSupportsR = name.supportsRegion(); -/////////////////////////////////////////////////////////////////////////////////////////////////// + int n = name.ordinal(); + float[] u = name.getUnity(); + int l = name.getUnity().length; + for(int i=0; i3 ? radius:3); + mWeights[0] = GAUSSIAN[0]; + float sum = GAUSSIAN[0]; + int j; + + for(int i=1; i<=radius; i++) + { + x += P; + j = (int)x; + z = x-j; + + mWeights[i] = (1-z)*GAUSSIAN[j] + z*GAUSSIAN[j+1]; + sum += 2*mWeights[i]; + } + + for(int i=0; i<=radius; i++) mWeights[i] /= sum; + + int numloops = radius/2; + weightsCache[offset] = mWeights[0]; + offsetsCache[offset] = 0.0f; + + for(int i=0; i3 ? radius:3); - mWeights[0] = GAUSSIAN[0]; - float sum = GAUSSIAN[0]; - int j; - - for(int i=1; i<=radius; i++) - { - x += P; - j = (int)x; - z = x-j; - - mWeights[i] = (1-z)*GAUSSIAN[j] + z*GAUSSIAN[j+1]; - sum += 2*mWeights[i]; - } - - for(int i=0; i<=radius; i++) mWeights[i] /= sum; - - int numloops = radius/2; - weightsCache[offset] = mWeights[0]; - offsetsCache[offset] = 0.0f; - - for(int i=0; i3 ? radius:3); + mWeights[0] = GAUSSIAN[0]; + float sum = GAUSSIAN[0]; + int j; + + for(int i=1; i<=radius; i++) + { + x += P; + j = (int)x; + z = x-j; + + mWeights[i] = (1-z)*GAUSSIAN[j] + z*GAUSSIAN[j+1]; + sum += 2*mWeights[i]; + } + + for(int i=0; i<=radius; i++) mWeights[i] /= sum; + + int numloops = radius/2; + weightsCache[offset] = mWeights[0]; + offsetsCache[offset] = 0.0f; + + for(int i=0; i3 ? radius:3); - mWeights[0] = GAUSSIAN[0]; - float sum = GAUSSIAN[0]; - int j; - - for(int i=1; i<=radius; i++) - { - x += P; - j = (int)x; - z = x-j; - - mWeights[i] = (1-z)*GAUSSIAN[j] + z*GAUSSIAN[j+1]; - sum += 2*mWeights[i]; - } - - for(int i=0; i<=radius; i++) mWeights[i] /= sum; - - int numloops = radius/2; - weightsCache[offset] = mWeights[0]; - offsetsCache[offset] = 0.0f; - - for(int i=0; i when (Px,Py) is above (Sx,Sy)) or a=Px/Sx (W) or a=(w-Px)/(w-Sx) (E) or a=(h-Py)/(h-Sy) (S) @@ -127,7 +104,10 @@ public class VertexEffectDistort extends VertexEffect // // Thus we actually want to compute N(v.x,v.y) = a*(-(dx/|PS|)*f'(|PX|), -(dy/|PS|)*f'(|PX|), 1) and keep adding // the first two components. (a is the horizontal part) - +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Have to call this before the shaders get compiled (i.e before Distorted.onCreate()) for the Effect to work. + */ public static void enable() { addEffect(EffectName.DISTORT, @@ -152,6 +132,37 @@ public class VertexEffectDistort extends VertexEffect + "n.xy += n.z*b*ps;" ); } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Distort a (possibly changing in time) part of the Object by a (possibly changing in time) vector of force. + * + * @param vector vector of force the Center of the Effect is currently being dragged with. + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + * @param region Region that masks the Effect. + */ + public VertexEffectDistort(Data3D vector, Data3D center, Data4D region) + { + super(EffectName.DISTORT); + mVector = vector; + mCenter = center; + mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); + } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Distort the whole Object by a (possibly changing in time) vector of force. + * + * @param vector vector of force the Center of the Effect is currently being dragged with. + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + */ + public VertexEffectDistort(Data3D vector, Data3D center) + { + super(EffectName.DISTORT); + mVector = vector; + mCenter = center; + mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); + } } diff --git a/src/main/java/org/distorted/library/effect/VertexEffectPinch.java b/src/main/java/org/distorted/library/effect/VertexEffectPinch.java index 424f554..e3c6913 100644 --- a/src/main/java/org/distorted/library/effect/VertexEffectPinch.java +++ b/src/main/java/org/distorted/library/effect/VertexEffectPinch.java @@ -25,7 +25,10 @@ import org.distorted.library.type.Data4D; import org.distorted.library.type.Static4D; /////////////////////////////////////////////////////////////////////////////////////////////////// - +/** + * Pull all points around the center of the Effect towards a line passing through the center + * (that's if degree>=1) or push them away from the line (degree<=1). + */ public class VertexEffectPinch extends VertexEffect { private Data2D mPinch; @@ -34,39 +37,10 @@ public class VertexEffectPinch extends VertexEffect /////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Pull all points around the center of the Effect towards a line passing through the center - * (that's if degree>=1) or push them away from the line (degree<=1) + * Only for use by the library itself. * - * @param pinch The current degree of the Effect + angle the line forms with X-axis - * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. - * @param region Region that masks the Effect. + * @y.exclude */ - public VertexEffectPinch(Data2D pinch, Data3D center, Data4D region) - { - super(EffectName.PINCH); - mPinch = pinch; - mCenter = center; - mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); - } - -/////////////////////////////////////////////////////////////////////////////////////////////////// -/** - * Pull all points around the center of the Effect towards a line passing through the center - * (that's if degree>=1) or push them away from the line (degree<=1) - * - * @param pinch The current degree of the Effect + angle the line forms with X-axis - * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. - */ - public VertexEffectPinch(Data2D pinch, Data3D center) - { - super(EffectName.PINCH); - mPinch = pinch; - mCenter = center; - mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); - } - -/////////////////////////////////////////////////////////////////////////////////////////////////// - public boolean compute(float[] uniforms, int index, long currentDuration, long step ) { mCenter.get(uniforms,index+5,currentDuration,step); @@ -79,13 +53,18 @@ public class VertexEffectPinch extends VertexEffect return ret; } +/////////////////////////////////////////////////////////////////////////////////////////////////// +// PUBLIC API /////////////////////////////////////////////////////////////////////////////////////////////////// // Pull P=(v.x,v.y) towards the line that // a) passes through the center of the effect // b) forms angle defined in the 2nd interpolated value with the X-axis // with P' = P + (1-h)*dist(line to P) // when h>1 we are pushing points away from S: P' = P + (1/h-1)*dist(line to P) - +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Have to call this before the shaders get compiled (i.e before Distorted.onCreate()) for the Effect to work. + */ public static void enable() { addEffect(EffectName.PINCH, @@ -99,4 +78,37 @@ public class VertexEffectPinch extends VertexEffect + "v.xy += t*dot(ps,dir)*dir;" ); } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Pull all points around the center of the Effect towards a line passing through the center + * (that's if degree>=1) or push them away from the line (degree<=1) + * + * @param pinch The current degree of the Effect + angle the line forms with X-axis + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + * @param region Region that masks the Effect. + */ + public VertexEffectPinch(Data2D pinch, Data3D center, Data4D region) + { + super(EffectName.PINCH); + mPinch = pinch; + mCenter = center; + mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); + } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Pull all points around the center of the Effect towards a line passing through the center + * (that's if degree>=1) or push them away from the line (degree<=1) + * + * @param pinch The current degree of the Effect + angle the line forms with X-axis + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + */ + public VertexEffectPinch(Data2D pinch, Data3D center) + { + super(EffectName.PINCH); + mPinch = pinch; + mCenter = center; + mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); + } } diff --git a/src/main/java/org/distorted/library/effect/VertexEffectSink.java b/src/main/java/org/distorted/library/effect/VertexEffectSink.java index e7de40e..29fae8f 100644 --- a/src/main/java/org/distorted/library/effect/VertexEffectSink.java +++ b/src/main/java/org/distorted/library/effect/VertexEffectSink.java @@ -25,7 +25,10 @@ import org.distorted.library.type.Data4D; import org.distorted.library.type.Static4D; /////////////////////////////////////////////////////////////////////////////////////////////////// - +/** + * Pull all points around the center of the Effect towards the center point (if degree>=1) or push them + * away from it (degree<=1). + */ public class VertexEffectSink extends VertexEffect { private Data1D mSink; @@ -34,39 +37,10 @@ public class VertexEffectSink extends VertexEffect /////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Pull all points around the center of the Effect towards the center (if degree>=1) or push them - * away from the center (degree<=1) - * - * @param sink The current degree of the Effect. - * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. - * @param region Region that masks the Effect. - */ - public VertexEffectSink(Data1D sink, Data3D center, Data4D region) - { - super(EffectName.SINK); - mSink = sink; - mCenter = center; - mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); - } - -/////////////////////////////////////////////////////////////////////////////////////////////////// -/** - * Pull all points around the center of the Effect towards the center (if degree>=1) or push them - * away from the center (degree<=1) + * Only for use by the library itself. * - * @param sink The current degree of the Effect. - * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + * @y.exclude */ - public VertexEffectSink(Data1D sink, Data3D center) - { - super(EffectName.SINK); - mSink = sink; - mCenter = center; - mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); - } - -/////////////////////////////////////////////////////////////////////////////////////////////////// - public boolean compute(float[] uniforms, int index, long currentDuration, long step ) { mCenter.get(uniforms,index+5,currentDuration,step); @@ -78,10 +52,15 @@ public class VertexEffectSink extends VertexEffect return ret; } +/////////////////////////////////////////////////////////////////////////////////////////////////// +// PUBLIC API /////////////////////////////////////////////////////////////////////////////////////////////////// // Pull P=(v.x,v.y) towards center of the effect with P' = P + (1-h)*dist(S-P) // when h>1 we are pushing points away from S: P' = P + (1/h-1)*dist(S-P) - +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Have to call this before the shaders get compiled (i.e before Distorted.onCreate()) for the Effect to work. + */ public static void enable() { addEffect(EffectName.SINK, @@ -94,4 +73,37 @@ public class VertexEffectSink extends VertexEffect + "v.xy += t*ps;" ); } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Pull all points around the center of the Effect towards the center point (if degree>=1) or push them + * away from it (degree<=1) + * + * @param sink The current degree of the Effect. + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + * @param region Region that masks the Effect. + */ + public VertexEffectSink(Data1D sink, Data3D center, Data4D region) + { + super(EffectName.SINK); + mSink = sink; + mCenter = center; + mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); + } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Pull all points around the center of the Effect towards the center point(if degree>=1) or push them + * away from it (degree<=1) + * + * @param sink The current degree of the Effect. + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + */ + public VertexEffectSink(Data1D sink, Data3D center) + { + super(EffectName.SINK); + mSink = sink; + mCenter = center; + mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); + } } diff --git a/src/main/java/org/distorted/library/effect/VertexEffectSwirl.java b/src/main/java/org/distorted/library/effect/VertexEffectSwirl.java index 236a8e5..a5ee386 100644 --- a/src/main/java/org/distorted/library/effect/VertexEffectSwirl.java +++ b/src/main/java/org/distorted/library/effect/VertexEffectSwirl.java @@ -25,7 +25,9 @@ import org.distorted.library.type.Data4D; import org.distorted.library.type.Static4D; /////////////////////////////////////////////////////////////////////////////////////////////////// - +/** + * 'Swirl' part of the Mesh, i.e rotate part of it around a point. + */ public class VertexEffectSwirl extends VertexEffect { private Data1D mSwirl; @@ -34,37 +36,10 @@ public class VertexEffectSwirl extends VertexEffect /////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Rotate part of the Object around the Center of the Effect by a certain angle. - * - * @param swirl The angle of Swirl (in degrees). Positive values swirl clockwise. - * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. - * @param region Region that masks the Effect. - */ - public VertexEffectSwirl(Data1D swirl, Data3D center, Data4D region) - { - super(EffectName.SWIRL); - mSwirl = swirl; - mCenter = center; - mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); - } - -/////////////////////////////////////////////////////////////////////////////////////////////////// -/** - * Rotate the whole Object around the Center of the Effect by a certain angle. + * Only for use by the library itself. * - * @param swirl The angle of Swirl (in degrees). Positive values swirl clockwise. - * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + * @y.exclude */ - public VertexEffectSwirl(Data1D swirl, Data3D center) - { - super(EffectName.SWIRL); - mSwirl = swirl; - mCenter = center; - mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); - } - -/////////////////////////////////////////////////////////////////////////////////////////////////// - public boolean compute(float[] uniforms, int index, long currentDuration, long step ) { mCenter.get(uniforms,index+5,currentDuration,step); @@ -77,11 +52,16 @@ public class VertexEffectSwirl extends VertexEffect return ret; } +/////////////////////////////////////////////////////////////////////////////////////////////////// +// PUBLIC API /////////////////////////////////////////////////////////////////////////////////////////////////// // Let d be the degree of the current vertex V with respect to center of the effect S and Region vRegion. // This effect rotates the current vertex V by vInterpolated.x radians clockwise around the circle dilated // by (1-d) around the center of the effect S. - +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Have to call this before the shaders get compiled (i.e before Distorted.onCreate()) for the Effect to work. + */ public static void enable() { addEffect(EffectName.SWIRL, @@ -103,5 +83,36 @@ public class VertexEffectSwirl extends VertexEffect + "v.xy += min(d1_circle,d1_bitmap)*(PS - PS2/(1.0-d2)); \n" // if d2=1 (i.e P=center) we should have P unchanged. How to do it? ); } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Rotate part of the Mesh around the Center of the Effect by a certain angle. + * + * @param swirl The angle of Swirl (in degrees). Positive values swirl clockwise. + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + * @param region Region that masks the Effect. + */ + public VertexEffectSwirl(Data1D swirl, Data3D center, Data4D region) + { + super(EffectName.SWIRL); + mSwirl = swirl; + mCenter = center; + mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); + } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Rotate the whole Mesh around the Center of the Effect by a certain angle. + * + * @param swirl The angle of Swirl (in degrees). Positive values swirl clockwise. + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + */ + public VertexEffectSwirl(Data1D swirl, Data3D center) + { + super(EffectName.SWIRL); + mSwirl = swirl; + mCenter = center; + mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); + } } diff --git a/src/main/java/org/distorted/library/effect/VertexEffectWave.java b/src/main/java/org/distorted/library/effect/VertexEffectWave.java index a53a89c..0315dd1 100644 --- a/src/main/java/org/distorted/library/effect/VertexEffectWave.java +++ b/src/main/java/org/distorted/library/effect/VertexEffectWave.java @@ -25,7 +25,9 @@ import org.distorted.library.type.Data5D; import org.distorted.library.type.Static4D; /////////////////////////////////////////////////////////////////////////////////////////////////// - +/** + * Directional, sinusoidal wave effect. + */ public class VertexEffectWave extends VertexEffect { private Data5D mWave; @@ -34,58 +36,10 @@ public class VertexEffectWave extends VertexEffect /////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Directional, sinusoidal wave effect. - * - * @param wave A 5-dimensional data structure describing the wave: first member is the amplitude, - * second is the wave length, third is the phase (i.e. when phase = PI/2, the sine - * wave at the center does not start from sin(0), but from sin(PI/2) ) and the next two - * describe the 'direction' of the wave. - *

- * Wave direction is defined to be a 3D vector of length 1. To define such vectors, we - * need 2 floats: thus the third member is the angle Alpha (in degrees) which the vector - * forms with the XY-plane, and the fourth is the angle Beta (again in degrees) which - * the projection of the vector to the XY-plane forms with the Y-axis (counterclockwise). - *

- *

- * Example1: if Alpha = 90, Beta = 90, (then V=(0,0,1) ) and the wave acts 'vertically' - * in the X-direction, i.e. cross-sections of the resulting surface with the XZ-plane - * will be sine shapes. - *

- * Example2: if Alpha = 90, Beta = 0, the again V=(0,0,1) and the wave is 'vertical', - * but this time it waves in the Y-direction, i.e. cross sections of the surface and the - * YZ-plane with be sine shapes. - *

- * Example3: if Alpha = 0 and Beta = 45, then V=(sqrt(2)/2, -sqrt(2)/2, 0) and the wave - * is entirely 'horizontal' and moves point (x,y,0) in direction V by whatever is the - * value if sin at this point. - * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. - * @param region Region that masks the Effect. - */ - public VertexEffectWave(Data5D wave, Data3D center, Data4D region) - { - super(EffectName.WAVE); - mWave = wave; - mCenter = center; - mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); - } - -/////////////////////////////////////////////////////////////////////////////////////////////////// -/** - * Directional, sinusoidal wave effect. + * Only for use by the library itself. * - * @param wave see {@link VertexEffectWave(Data5D,Data3D)} - * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + * @y.exclude */ - public VertexEffectWave(Data5D wave, Data3D center) - { - super(EffectName.WAVE); - mWave = wave; - mCenter = center; - mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); - } - -/////////////////////////////////////////////////////////////////////////////////////////////////// - public boolean compute(float[] uniforms, int index, long currentDuration, long step ) { mCenter.get(uniforms,index+5,currentDuration,step); @@ -100,6 +54,8 @@ public class VertexEffectWave extends VertexEffect return ret; } +/////////////////////////////////////////////////////////////////////////////////////////////////// +// PUBLIC API /////////////////////////////////////////////////////////////////////////////////////////////////// // Directional sinusoidal wave effect. // @@ -163,7 +119,10 @@ public class VertexEffectWave extends VertexEffect // points very dark) // // Generally speaking I'd keep to amplitude < length, as the opposite case has some other problems as well. - +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Have to call this before the shaders get compiled (i.e before Distorted.onCreate()) for the Effect to work. + */ public static void enable() { addEffect(EffectName.WAVE, @@ -226,4 +185,56 @@ public class VertexEffectWave extends VertexEffect + "}" ); } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Directional, sinusoidal wave effect. + * + * @param wave A 5-dimensional data structure describing the wave: first member is the amplitude, + * second is the wave length, third is the phase (i.e. when phase = PI/2, the sine + * wave at the center does not start from sin(0), but from sin(PI/2) ) and the next two + * describe the 'direction' of the wave. + *

+ * Wave direction is defined to be a 3D vector of length 1. To define such vectors, we + * need 2 floats: thus the third member is the angle Alpha (in degrees) which the vector + * forms with the XY-plane, and the fourth is the angle Beta (again in degrees) which + * the projection of the vector to the XY-plane forms with the Y-axis (counterclockwise). + *

+ *

+ * Example1: if Alpha = 90, Beta = 90, (then V=(0,0,1) ) and the wave acts 'vertically' + * in the X-direction, i.e. cross-sections of the resulting surface with the XZ-plane + * will be sine shapes. + *

+ * Example2: if Alpha = 90, Beta = 0, the again V=(0,0,1) and the wave is 'vertical', + * but this time it waves in the Y-direction, i.e. cross sections of the surface and the + * YZ-plane with be sine shapes. + *

+ * Example3: if Alpha = 0 and Beta = 45, then V=(sqrt(2)/2, -sqrt(2)/2, 0) and the wave + * is entirely 'horizontal' and moves point (x,y,0) in direction V by whatever is the + * value if sin at this point. + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + * @param region Region that masks the Effect. + */ + public VertexEffectWave(Data5D wave, Data3D center, Data4D region) + { + super(EffectName.WAVE); + mWave = wave; + mCenter = center; + mRegion = (region==null ? new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE) : region); + } + +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Directional, sinusoidal wave effect. + * + * @param wave see {@link VertexEffectWave(Data5D,Data3D)} + * @param center 3-dimensional Data that, at any given time, returns the Center of the Effect. + */ + public VertexEffectWave(Data5D wave, Data3D center) + { + super(EffectName.WAVE); + mWave = wave; + mCenter = center; + mRegion = new Static4D(0,0,Float.MAX_VALUE, Float.MAX_VALUE); + } } diff --git a/src/main/java/org/distorted/library/main/DistortedEffects.java b/src/main/java/org/distorted/library/main/DistortedEffects.java index 5d1582b..b633cbf 100644 --- a/src/main/java/org/distorted/library/main/DistortedEffects.java +++ b/src/main/java/org/distorted/library/main/DistortedEffects.java @@ -45,10 +45,9 @@ import java.util.ArrayList; /////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Class containing Matrix,Vertex and Fragment effect queues. Postprocessing queue is held in a separate - * class. + * Class containing Matrix, Vertex, Fragment and Postprocessing effect queues. *

- * The queues hold actual effects to be applied to a given (DistortedTexture,MeshObject) combo. + * The queues hold actual effects to be applied to a given (InputSurface,MeshObject) combo. */ public class DistortedEffects implements DistortedSlave { @@ -477,7 +476,7 @@ public class DistortedEffects implements DistortedSlave /////////////////////////////////////////////////////////////////////////////////////////////////// /** * Adds the calling class to the list of Listeners that get notified each time some event happens - * to one of the Effects in those queues. Nothing will happen if 'el' is already in the list. + * to one of the Effects in our queues. Nothing will happen if 'el' is already in the list. * * @param el A class implementing the EffectListener interface that wants to get notifications. */ @@ -492,7 +491,7 @@ public class DistortedEffects implements DistortedSlave /////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Removes the calling class from the list of Listeners. + * Removes the calling class from the list of Listeners that get notified if something happens to Effects in our queue. * * @param el A class implementing the EffectListener interface that no longer wants to get notifications. */ @@ -536,7 +535,7 @@ public class DistortedEffects implements DistortedSlave /////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Aborts all Effect by its ID. + * Aborts an Effect by its ID. * * @param id the Id of the Effect to be removed, as returned by getID(). * @return Number of effects aborted. @@ -593,7 +592,8 @@ public class DistortedEffects implements DistortedSlave /////////////////////////////////////////////////////////////////////////////////////////////////// /** - * Returns the maximum number of effects of a given type. + * Returns the maximum number of effects of a given type that can be simultaneously applied to a + * single (InputSurface,MeshObject) combo. * * @param type {@link EffectType} * @return The maximum number of effects of a given type. diff --git a/src/main/java/org/distorted/library/program/DistortedProgram.java b/src/main/java/org/distorted/library/program/DistortedProgram.java index 0d401d4..e2440d8 100644 --- a/src/main/java/org/distorted/library/program/DistortedProgram.java +++ b/src/main/java/org/distorted/library/program/DistortedProgram.java @@ -41,7 +41,13 @@ public class DistortedProgram private String[] mAttributeName; private String[] mUniformName; +/** + * List of Attributes (on OpenGL ES 3.0: 'in' variables) in the same order as declared in the shader source. + */ public final int[] mAttribute; +/** + * List of Uniforms in the same order as declared in the shader source. + */ public final int[] mUniform; /////////////////////////////////////////////////////////////////////////////////////////////////// @@ -342,9 +348,11 @@ android.util.Log.d("Program", end.substring(0,40)); } /////////////////////////////////////////////////////////////////////////////////////////////////// -// feedback: List of 'out' variables (OpenGL ES >= 3.0 only!) that will be transferred back to CPU -// using Transform Feedback. - +/** + * Only for use by the library itself. + * + * @y.exclude + */ public DistortedProgram(final InputStream vertex, final InputStream fragment, final String vertexHeader, final String fragmentHeader, int glslVersion, final String[] feedback ) throws FragmentCompilationException,VertexCompilationException,VertexUniformsException,FragmentUniformsException,LinkingException { @@ -379,19 +387,27 @@ android.util.Log.d("Program", end.substring(0,40)); } /////////////////////////////////////////////////////////////////////////////////////////////////// - - public DistortedProgram(final String vertex, final String fragment) +/** + * Only for use by the library itself. + * + * @y.exclude + */ + public DistortedProgram(final InputStream vertex, final InputStream fragment, final String vertexHeader, final String fragmentHeader, + final String enabledVertex, final String enabledFragment, int glslVersion, final String[] feedback ) throws FragmentCompilationException,VertexCompilationException,VertexUniformsException,FragmentUniformsException,LinkingException { - init(300); + init(glslVersion); - doAttributes(vertex , true ); - doAttributes(fragment, false); + String vertexShader = readTextFileFromRawResource(vertex , true ); + String fragmentShader = readTextFileFromRawResource(fragment, false); - final int vertexShaderHandle = compileShader(GLES30.GL_VERTEX_SHADER , vertex ); - final int fragmentShaderHandle = compileShader(GLES30.GL_FRAGMENT_SHADER, fragment); + vertexShader = insertEnabledEffects(vertexShader ,enabledVertex ); + fragmentShader = insertEnabledEffects(fragmentShader,enabledFragment); - mProgramHandle = createAndLinkProgram(vertexShaderHandle, fragmentShaderHandle, mAttributeName, null ); + final int vertexShaderHandle = compileShader(GLES30.GL_VERTEX_SHADER , vertexHeader + vertexShader ); + final int fragmentShaderHandle = compileShader(GLES30.GL_FRAGMENT_SHADER, fragmentHeader + fragmentShader); + + mProgramHandle = createAndLinkProgram(vertexShaderHandle, fragmentShaderHandle, mAttributeName, glslVersion>= 300 ? feedback:null ); mAttribute = new int[mNumAttributes]; @@ -414,25 +430,46 @@ android.util.Log.d("Program", end.substring(0,40)); } /////////////////////////////////////////////////////////////////////////////////////////////////// -// feedback: List of 'out' variables (OpenGL ES >= 3.0 only!) that will be transferred back to CPU -// using Transform Feedback. - - public DistortedProgram(final InputStream vertex, final InputStream fragment, final String vertexHeader, final String fragmentHeader, - final String enabledVertex, final String enabledFragment, int glslVersion, final String[] feedback ) +/** + * Only for use by the library itself. + * + * @y.exclude + */ + public DistortedProgram(final InputStream vertex, final InputStream fragment, final String vertexHeader, final String fragmentHeader, int glslVersion ) throws FragmentCompilationException,VertexCompilationException,VertexUniformsException,FragmentUniformsException,LinkingException { - init(glslVersion); + this(vertex,fragment,vertexHeader,fragmentHeader,glslVersion,null); + } - String vertexShader = readTextFileFromRawResource(vertex , true ); - String fragmentShader = readTextFileFromRawResource(fragment, false); +/////////////////////////////////////////////////////////////////////////////////////////////////// +// PUBLIC API +/////////////////////////////////////////////////////////////////////////////////////////////////// +/** + * Create a new Shader Program from two source strings. + *

+ * Needs to be called from a thread holding the OpenGL context. + * Assumed to hold GLSL 'version 300 es' source. + * + * @param vertex Vertex shader code. + * @param fragment Fragment shader code. + * @throws FragmentCompilationException + * @throws VertexCompilationException + * @throws VertexUniformsException + * @throws FragmentUniformsException + * @throws LinkingException + */ + public DistortedProgram(final String vertex, final String fragment) + throws FragmentCompilationException,VertexCompilationException,VertexUniformsException,FragmentUniformsException,LinkingException + { + init(300); - vertexShader = insertEnabledEffects(vertexShader ,enabledVertex ); - fragmentShader = insertEnabledEffects(fragmentShader,enabledFragment); + doAttributes(vertex , true ); + doAttributes(fragment, false); - final int vertexShaderHandle = compileShader(GLES30.GL_VERTEX_SHADER , vertexHeader + vertexShader ); - final int fragmentShaderHandle = compileShader(GLES30.GL_FRAGMENT_SHADER, fragmentHeader + fragmentShader); + final int vertexShaderHandle = compileShader(GLES30.GL_VERTEX_SHADER , vertex ); + final int fragmentShaderHandle = compileShader(GLES30.GL_FRAGMENT_SHADER, fragment); - mProgramHandle = createAndLinkProgram(vertexShaderHandle, fragmentShaderHandle, mAttributeName, glslVersion>= 300 ? feedback:null ); + mProgramHandle = createAndLinkProgram(vertexShaderHandle, fragmentShaderHandle, mAttributeName, null ); mAttribute = new int[mNumAttributes]; @@ -454,29 +491,6 @@ android.util.Log.d("Program", end.substring(0,40)); else mUniform = null; } -/////////////////////////////////////////////////////////////////////////////////////////////////// -// PUBLIC API -/////////////////////////////////////////////////////////////////////////////////////////////////// - /** - * Create a new Shader Program from source stored in resource files. - *

- * Needs to be called from a thread holding the OpenGL context. - * - * @param vertex InputStream containing the opened Resource file from where to read vertex shader code. - * @param fragment InputStream containing the opened Resource file from where to read fragment shader code. - * @throws FragmentCompilationException - * @throws VertexCompilationException - * @throws VertexUniformsException - * @throws FragmentUniformsException - * @throws LinkingException - */ - - public DistortedProgram(final InputStream vertex, final InputStream fragment, final String vertexHeader, final String fragmentHeader, int glslVersion ) - throws FragmentCompilationException,VertexCompilationException,VertexUniformsException,FragmentUniformsException,LinkingException - { - this(vertex,fragment,vertexHeader,fragmentHeader,glslVersion,null); - } - /////////////////////////////////////////////////////////////////////////////////////////////////// /** * Return the handle of the created program so that we can later, say, call glUseProgram.