FrameGraph API

jme3-core/src/main/java/com/jme3/anim/tween/action/Action.java

@@ -38,13 +38,13 @@
 
 /**
  * Wraps an array of Tween actions into an action object.
- * 
  * <p>
  * Notes :
- * <li> The sequence of tweens is determined by {@link com.jme3.anim.tween.Tweens} utility class and the {@link BaseAction} interpolates that sequence. </li>
- * <li> This implementation mimics the {@link com.jme3.anim.tween.AbstractTween}, but it delegates the interpolation method {@link Tween#interpolate(double)}
+ * <ul>
+ *   <li> The sequence of tweens is determined by {@link com.jme3.anim.tween.Tweens} utility class and the {@link BaseAction} interpolates that sequence. </li>
+ *   <li> This implementation mimics the {@link com.jme3.anim.tween.AbstractTween}, but it delegates the interpolation method {@link Tween#interpolate(double)}
  * to the {@link BlendableAction} class. </li>
- * </p>
+ * </ul>
  * 
  * Created by Nehon.
  *
@@ -66,10 +66,11 @@ public abstract class Action implements JmeCloneable, Tween {
      * Instantiates an action object that wraps a tween actions array by extracting their actions to the collection {@link Action#actions}.
      * <p>
      * Notes :
-     * <li> If intentions are to wrap some tween actions, then subclasses have to call this constructor, examples : {@link BlendableAction} and {@link BlendAction}. </li>
-     * <li> If intentions are to make an implementation of {@link Action} that shouldn't wrap tweens of actions, then subclasses shouldn't call this
+     * <ul>
+     *   <li> If intentions are to wrap some tween actions, then subclasses have to call this constructor, examples : {@link BlendableAction} and {@link BlendAction}. </li>
+     *   <li> If intentions are to make an implementation of {@link Action} that shouldn't wrap tweens of actions, then subclasses shouldn't call this
      * constructor, examples : {@link ClipAction} and {@link BaseAction}. </li>
-     * </p> 
+     * </ul>
      *
      * @param tweens the tween actions to be wrapped (not null).
      */    
@@ -119,11 +120,12 @@ public double getSpeed() {
      * Alters the speedup factor applied by the layer running this action.
      * <p>
      * Notes:
-     * <li> This factor controls the animation direction, if the speed is a positive value then the animation will run forward and vice versa. </li>
-     * <li> The speed factor gets applied, inside the {@link com.jme3.anim.AnimLayer}, on each interpolation step by this formula : time += tpf * action.getSpeed() * composer.globalSpeed. </li>
-     * <li> Default speed is 1.0, it plays the animation clips at their normal speed. </li>
-     * <li> Setting the speed factor to Zero will stop the animation, while setting it to a negative number will play the animation in a backward fashion. </li>
-     * </p>
+     * <ul>
+     *   <li> This factor controls the animation direction, if the speed is a positive value then the animation will run forward and vice versa. </li>
+     *   <li> The speed factor gets applied, inside the {@link com.jme3.anim.AnimLayer}, on each interpolation step by this formula : time += tpf * action.getSpeed() * composer.globalSpeed. </li>
+     *   <li> Default speed is 1.0, it plays the animation clips at their normal speed. </li>
+     *   <li> Setting the speed factor to Zero will stop the animation, while setting it to a negative number will play the animation in a backward fashion. </li>
+     * </ul>
      * 
      * @param speed the speed of frames.
      */

jme3-core/src/main/java/com/jme3/anim/tween/action/BaseAction.java

@@ -55,7 +55,6 @@
  * //run the action within this layer
  * animComposer.setCurrentAction("basicAction", ActionState.class.getSimpleName());
  * </pre>
- * </p>
  * Created by Nehon.
  */
 public class BaseAction extends Action {

jme3-core/src/main/java/com/jme3/app/BasicProfiler.java

@@ -35,6 +35,7 @@
 
 import com.jme3.profile.AppProfiler;
 import com.jme3.profile.AppStep;
+import com.jme3.profile.FgStep;
 import com.jme3.profile.SpStep;
 import com.jme3.profile.VpStep;
 import com.jme3.renderer.ViewPort;
@@ -204,4 +205,5 @@ public void vpStep(VpStep step, ViewPort vp, Bucket bucket) {
     @Override
     public void spStep(SpStep step, String... additionalInfo) {
     }
+
 }

jme3-core/src/main/java/com/jme3/app/DetailedProfiler.java

@@ -57,6 +57,7 @@ public class DetailedProfiler implements AppProfiler {
     private String curAppPath = null;
     private String curVpPath = null;
     private String curSpPath = null;
+    private String curFgPath = null;
     private VpStep lastVpStep = null;
 
     private final StringBuilder path = new StringBuilder(256);
@@ -185,6 +186,16 @@ public void spStep(SpStep step, String... additionalInfo) {
         }
 
     }
+
+    @Override
+    public void fgStep(FgStep step, String... additionalInfo) {
+        if (data != null) {
+            curFgPath = getPath("", additionalInfo);
+            path.setLength(0);
+            path.append(curAppPath).append("/").append(curVpPath).append(curFgPath);
+            addStep(path.toString(), System.nanoTime());
+        }
+    }
 
     public Map<String, StatLine> getStats() {
         if (data != null) {

jme3-core/src/main/java/com/jme3/app/LegacyApplication.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2022 jMonkeyEngine
+ * Copyright (c) 2024 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -336,6 +336,7 @@ private void initCamera() {
         Camera guiCam = new Camera(settings.getWidth(), settings.getHeight());
         guiViewPort = renderManager.createPostView("Gui Default", guiCam);
         guiViewPort.setClearFlags(false, false, false);
+        //guiViewPort.setUseFrameGraphs(false);
     }
 
     /**

jme3-core/src/main/java/com/jme3/asset/AssetManager.java

@@ -39,6 +39,8 @@
 import com.jme3.material.Material;
 import com.jme3.post.FilterPostProcessor;
 import com.jme3.renderer.Caps;
+import com.jme3.renderer.framegraph.export.FrameGraphData;
+import com.jme3.renderer.framegraph.export.ModuleGraphData;
 import com.jme3.scene.Spatial;
 import com.jme3.scene.plugins.OBJLoader;
 import com.jme3.shader.ShaderGenerator;
@@ -364,6 +366,24 @@ public default List<ClassLoader> getClassLoaders() {
      */
     public FilterPostProcessor loadFilter(String name);
 
+    /**
+     * Loads a framegraph *.j3g file with a FrameGraphKey.
+     * 
+     * @param key asset key of the framegraph file to load
+     * @return loaded framegraph
+     * @see #loadAsset(com.jme3.asset.AssetKey)
+     */
+    public FrameGraphData loadFrameGraph(FrameGraphKey key);
+
+    /**
+     * Loads a framegraph *.j3g file with a FrameGraphKey.
+     * 
+     * @param name asset name of the framegraph file to load
+     * @return loaded framegraph
+     * @see #loadAsset(com.jme3.asset.AssetKey)
+     */
+    public FrameGraphData loadFrameGraph(String name);
+
     /**
      * Sets the shaderGenerator to generate shaders based on shaderNodes.
      * @param generator the shaderGenerator 

jme3-core/src/main/java/com/jme3/asset/DesktopAssetManager.java

@@ -38,6 +38,8 @@
 import com.jme3.material.Material;
 import com.jme3.post.FilterPostProcessor;
 import com.jme3.renderer.Caps;
+import com.jme3.renderer.framegraph.export.FrameGraphData;
+import com.jme3.renderer.framegraph.export.ModuleGraphData;
 import com.jme3.scene.Spatial;
 import com.jme3.shader.Glsl100ShaderGenerator;
 import com.jme3.shader.Glsl150ShaderGenerator;
@@ -455,6 +457,16 @@ public FilterPostProcessor loadFilter(FilterKey key) {
     public FilterPostProcessor loadFilter(String name) {
         return loadFilter(new FilterKey(name));
     }
+
+    @Override
+    public FrameGraphData loadFrameGraph(FrameGraphKey key) {
+        return loadAsset(key);
+    }
+
+    @Override
+    public FrameGraphData loadFrameGraph(String name) {
+        return loadAsset(new FrameGraphKey(name));
+    }
 
     /**
      * {@inheritDoc}

jme3-core/src/main/java/com/jme3/asset/FrameGraphKey.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2024 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.asset;
+
+import com.jme3.asset.cache.AssetCache;
+import com.jme3.renderer.framegraph.export.FrameGraphData;
+
+/**
+ *
+ * @author codex
+ */
+public class FrameGraphKey extends AssetKey<FrameGraphData> {
+
+    public FrameGraphKey(String name) {
+        super(name);
+    }
+    public FrameGraphKey() {
+        super();
+    }
+
+    @Override
+    public Class<? extends AssetCache> getCacheType() {
+        return null;
+    }
+
+}

jme3-core/src/main/java/com/jme3/asset/ModuleGraphKey.java

@@ -0,0 +1,28 @@
+/*
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template
+ */
+package com.jme3.asset;
+
+import com.jme3.asset.cache.AssetCache;
+import com.jme3.renderer.framegraph.export.ModuleGraphData;
+
+/**
+ *
+ * @author codex
+ */
+public class ModuleGraphKey extends AssetKey<ModuleGraphData> {
+
+    public ModuleGraphKey(String name) {
+        super(name);
+    }
+    public ModuleGraphKey() {
+        super();
+    }
+
+    @Override
+    public Class<? extends AssetCache> getCacheType() {
+        return null;
+    }
+
+}

jme3-core/src/main/java/com/jme3/environment/EnvironmentProbeControl.java

@@ -65,7 +65,7 @@
  *    ec1.setPosition(new Vector3f(0,0,0));
  *    // ec2.setPosition(new Vector3f(0,0,10));
  * 3. Tag the spatials that are part of the environment
- *    scene.deepFirstTraversal(s->{
+ *    scene.deepFirstTraversal(s -> {
  *        if(s.getUserData("isEnvNode")!=null){
  *          EnvironmentProbeControl.tagGlobal(s);
  *          // or ec1.tag(s); 

jme3-core/src/main/java/com/jme3/export/InputCapsule.java

@@ -39,6 +39,7 @@
 import java.nio.ShortBuffer;
 import java.util.ArrayList;
 import java.util.BitSet;
+import java.util.Collection;
 import java.util.Map;
 
 /**
@@ -109,14 +110,32 @@ public interface InputCapsule {
 
 
     // BinarySavable
-
+    
     public Savable readSavable(String name, Savable defVal) throws IOException;
     public Savable[] readSavableArray(String name, Savable[] defVal) throws IOException;
     public Savable[][] readSavableArray2D(String name, Savable[][] defVal) throws IOException;
-
+    public default <T extends Savable> T readSavable(String name, Class<T> type, T defVal) throws IOException {
+        Savable s = readSavable(name, defVal);
+        if (s != defVal && type.isAssignableFrom(s.getClass())) {
+            return (T)s;
+        } else {
+            return defVal;
+        }
+    }
+    public default SavableObject readSavableObject(String name, SavableObject defVal) throws IOException {
+        return readSavable(name, SavableObject.class, defVal);
+    }
 
     // ArrayLists
 
+    public default Collection readToCollection(String name, Collection target) throws IOException {
+        ArrayList list = readSavableArrayList(name, new ArrayList());
+        for (Object obj : list) {
+            target.add(obj);
+        }
+        return target;
+    }
+
     public ArrayList readSavableArrayList(String name, ArrayList defVal) throws IOException;
     public ArrayList[] readSavableArrayListArray(String name, ArrayList[] defVal) throws IOException;
     public ArrayList[][] readSavableArrayListArray2D(String name, ArrayList[][] defVal) throws IOException;

jme3-core/src/main/java/com/jme3/export/NullSavable.java

@@ -41,10 +41,12 @@
  * @author Kirill Vainer
  */
 public class NullSavable implements Savable {
+
+    public static final NullSavable INSTANCE = new NullSavable();
+
     @Override
-    public void write(JmeExporter ex) throws IOException {
-    }
+    public void write(JmeExporter ex) throws IOException {}
     @Override
-    public void read(JmeImporter im) throws IOException {
-    }
+    public void read(JmeImporter im) throws IOException {}
+
 }

jme3-core/src/main/java/com/jme3/export/OutputCapsule.java

@@ -39,13 +39,14 @@
 import java.nio.ShortBuffer;
 import java.util.ArrayList;
 import java.util.BitSet;
+import java.util.Collection;
 import java.util.Map;
 
 /**
  * @author Joshua Slack
  */
 public interface OutputCapsule {
-
+    
     // byte primitive
 
     public void write(byte value, String name, byte defVal) throws IOException;
@@ -115,7 +116,17 @@ public interface OutputCapsule {
 
 
     // ArrayLists
-
+
+    public default void writeFromCollection(Collection collection, String name, boolean checkSavable) throws IOException {
+        ArrayList list = new ArrayList(collection.size());
+        for (Object obj : collection) {
+            if (!checkSavable || obj instanceof Savable) {
+                list.add(obj);
+            }
+        }
+        writeSavableArrayList(list, name, new ArrayList());
+    }
+
     public void writeSavableArrayList(ArrayList array, String name, ArrayList defVal) throws IOException;
     public void writeSavableArrayListArray(ArrayList[] array, String name, ArrayList[] defVal) throws IOException;
     public void writeSavableArrayListArray2D(ArrayList[][] array, String name, ArrayList[][] defVal) throws IOException;

jme3-core/src/main/java/com/jme3/export/Savable.java

@@ -40,6 +40,8 @@
  * @author Kirill Vainer
  */
 public interface Savable {
+
     void write(JmeExporter ex) throws IOException;
     void read(JmeImporter im) throws IOException;
+
 }

jme3-core/src/main/java/com/jme3/export/SavableClassUtil.java

@@ -252,4 +252,5 @@ private static Constructor findNoArgConstructor(String className)
 
         return result;
     }
+
 }