VectorEffects

jme3-effects/src/main/java/com/jme3/vectoreffect/EaseVectorEffect.java

@@ -0,0 +1,148 @@
+/*
+ * Copyright (c) 2009-2026 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.jme3.vectoreffect;
+
+import com.jme3.math.EaseFunction;
+import com.jme3.math.Easing;
+import com.jme3.math.Vector4f;
+
+/**
+ *
+ * @author yaRnMcDonuts
+ */
+public final class EaseVectorEffect extends VectorEffect {
+
+    private VectorGroup targetVectors;
+    private VectorGroup startVectors;
+
+    private float duration = 0f;
+    private float easeTimer = 0f;
+    private float delay = 0f;
+    private float delayTimer = 0f;
+
+    private EaseFunction easeFunction = Easing.linear; 
+
+    public EaseVectorEffect(Object vectorToModify) {
+        super(vectorToModify);
+    }
+
+    public EaseVectorEffect(Object vectorToModify, Object targetVector, float duration) {
+        this(vectorToModify);
+        setEaseToValueOverDuration(duration, targetVector);
+    }
+
+    public EaseVectorEffect(Object vectorToModify, Object targetVector, float duration, float delay) {
+        this(vectorToModify);
+        setEaseToValueOverDuration(duration, targetVector);
+        setDelayTime(delay);
+    }
+
+    public EaseVectorEffect(Object vectorToModify, Object targetVector, float duration, EaseFunction easeFunction) {
+        this(vectorToModify, targetVector, duration);
+        setEaseFunction(easeFunction);
+    }
+
+    public EaseVectorEffect(Object vectorToModify, Object targetVector, float duration, EaseFunction easeFunction, float delay) {
+        this(vectorToModify, targetVector, duration);
+        setEaseFunction(easeFunction);
+        setDelayTime(delay);
+    }
+
+    @Override
+    public void update(float tpf) {
+        super.update(tpf);
+
+        if (delayTimer <= delay) {
+            delayTimer += tpf;
+            return;
+        }
+
+
+        if (startVectors == null) {
+            startVectors = new VectorGroup();
+
+            for(int v = 0; v < vectorsToModify.getSize(); v++){
+                Vector4f startVector = vectorsToModify.getAsVector4(v).clone();
+                startVectors.addVectorToGroup(startVector);
+            }
+        }
+
+        easeTimer += tpf;
+        float t = Math.min(easeTimer / duration, 1f);
+
+        float easedT = easeFunction.apply(t);
+
+        for(int v = 0; v < vectorsToModify.getSize(); v++){
+
+                Vector4f targetVector = targetVectors.getAsVector4(v);
+                Vector4f startVector = startVectors.getAsVector4(v);
+                Vector4f difference = targetVector.subtract(startVector);
+
+                Vector4f currentValue = startVector.add(difference.mult(easedT));
+                vectorsToModify.updateVectorObject(currentValue, v);            
+        }        
+
+        if (t >= 1f) {
+            super.setIsFinished(true);
+        }
+    }
+
+    public EaseVectorEffect setEaseToValueOverDuration(float dur, Object targetVector) {
+        if(targetVector instanceof VectorGroup){
+            targetVectors = (VectorGroup) targetVector;
+        }
+        else{
+            targetVectors = new VectorGroup(targetVector);
+        }
+
+        duration = dur;
+        startVectors = null;
+        return this;
+    }
+
+    public void setDelayTime(float delay) {
+        this.delay = delay;
+    }
+
+    public void setEaseFunction(EaseFunction func) {
+        this.easeFunction = func;
+    }
+
+    @Override
+    public void reset() {
+        delayTimer = 0;
+        easeTimer = 0;
+        startVectors = null;
+        super.reset(); 
+    }
+}

jme3-effects/src/main/java/com/jme3/vectoreffect/SequencedVectorEffect.java

@@ -0,0 +1,95 @@
+/*
+ * Copyright (c) 2009-2026 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.jme3.vectoreffect;
+
+import java.util.ArrayList;
+import java.util.Collections;
+
+/**
+ *
+ * @author yaRnMcDonuts
+ */
+public class SequencedVectorEffect extends VectorEffect {
+    private final ArrayList<VectorEffect> effects = new ArrayList<>();
+    private int currentIndex = 0;
+    private boolean isRepeatingInfinitely = false;
+    private float numTimesToRepeat = -1;
+    private float currentCycle = 0;
+
+    public void setLooping(boolean repeat) {        this.isRepeatingInfinitely = repeat;    }
+    public void setRepeatNumberOfTimes(float repititionCount){ this.numTimesToRepeat = repititionCount; }
+    public void addEffect(VectorEffect effect) {        effects.add(effect);    }
+
+    public SequencedVectorEffect(VectorEffect... effects) {
+        super();
+        Collections.addAll(this.effects, effects);
+    }
+
+
+    @Override
+    public void update(float tpf) {
+        super.update(tpf);
+        if (effects.isEmpty()) {
+            setIsFinished(true);
+            return;
+        }
+
+        VectorEffect current = effects.get(currentIndex);
+        current.update(tpf);
+
+        if (current.isFinished()) {
+            currentIndex++;
+
+            if (currentIndex >= effects.size()) {
+                currentCycle++;
+                reset();
+
+                if (!isRepeatingInfinitely && currentCycle >= numTimesToRepeat) {
+                    setIsFinished(true);
+                    currentCycle = 0;
+                }
+
+            }
+        }
+    }    
+
+    @Override
+    public void reset() {
+        super.reset(); 
+        isFinished = false;
+        currentIndex = 0;
+        for (VectorEffect e : effects) {
+            e.reset();
+        }
+    }
+}

jme3-effects/src/main/java/com/jme3/vectoreffect/VectorEffect.java

@@ -0,0 +1,104 @@
+/*
+ * Copyright (c) 2009-2026 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.jme3.vectoreffect;
+
+import com.jme3.app.state.AppStateManager;
+import java.util.ArrayList;
+
+/**
+ * Base class for vector/color effects. * 
+ * Supports Vector2f, Vector3f, Vector4f, and ColorRGBA.
+ * 
+ * @author yaRnMcDonuts
+ */
+
+public abstract class VectorEffect {
+
+    protected VectorGroup vectorsToModify;    
+    private final ArrayList<Runnable> onFinishedCallbacks = new ArrayList<>();    
+    protected boolean isFinished = false;       
+
+    public VectorEffect(){
+
+    }
+
+    public VectorEffect(Object vectorObj) {
+
+        if(vectorObj instanceof VectorGroup){
+            vectorsToModify = (VectorGroup) vectorObj;
+        }else{
+            vectorsToModify = new VectorGroup(vectorObj); 
+        }        
+    }        
+
+    public void setIsFinished(boolean isFinished) {        
+        this.isFinished = isFinished;
+        if (isFinished) {
+            for(Runnable r : onFinishedCallbacks) {
+                r.run();
+            }
+            onFinishedCallbacks.clear();
+        }
+    }
+
+    public boolean isFinished() {        
+        return isFinished;  
+    }    
+
+
+    public void reset() {
+        isFinished = false;
+    }
+
+
+    public void registerRunnableOnFinish(Runnable runnable) {
+        onFinishedCallbacks.add(runnable);
+    }  
+
+    public void update(float tpf){
+
+    }    
+
+    // convenience registration method so users can avoid repeatedly writing this AppState fetching code
+    public void convenienceRegister(AppStateManager stateManager) {
+        if(stateManager != null){
+            VectorEffectManagerState vectorEffectManagerState = stateManager.getState(VectorEffectManagerState.class);
+            if(vectorEffectManagerState != null){
+                vectorEffectManagerState.registerVectorEffect(this);
+            }
+        }
+    }
+
+
+}
+