Deprecate FBX loading support (#2715)

Author: 8Keep

jme3-core/src/main/resources/com/jme3/asset/General.cfg

@@ -21,7 +21,6 @@ LOADER com.jme3.scene.plugins.ogre.SkeletonLoader : skeletonxml, skeleton.xml
 LOADER com.jme3.scene.plugins.ogre.MaterialLoader : material
 LOADER com.jme3.scene.plugins.ogre.SceneLoader : scene
 LOADER com.jme3.shader.plugins.GLSLLoader : vert, frag, geom, tsctrl, tseval, glsl, glsllib, comp
-LOADER com.jme3.scene.plugins.fbx.FbxLoader : fbx
 LOADER com.jme3.scene.plugins.gltf.GltfLoader : gltf
 LOADER com.jme3.scene.plugins.gltf.BinLoader : bin
 LOADER com.jme3.scene.plugins.gltf.GlbLoader : glb

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/AnimationList.java

@@ -41,7 +41,11 @@
  * <code>firstFrame</code> and <code>lastFrame</code> defines animation time interval.<br>
  * Use <code>layerName</code> also to define source animation layer in the case of multiple layers in the scene.<br>
  * Skeletal animations will be created if only scene contain skeletal bones</p>
+ *
+ * @deprecated FBX support is deprecated and will be removed in a future release.
+ * Prefer glTF assets instead.
  */
+@Deprecated
 public class AnimationList {
 
     List<AnimInverval> list = new ArrayList<>();

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/ContentTextureKey.java

@@ -41,9 +41,13 @@
 import java.io.IOException;
 
 /**
- * Used to load textures from image binary content.
+ * Texture key used by the FBX loader for embedded textures.
  * <p>Filename is required to acquire proper type asset loader according to extension.</p>
+ *
+ * @deprecated FBX support is deprecated and will be removed in a future release.
+ * Prefer glTF assets instead.
  */
+@Deprecated
 public class ContentTextureKey extends TextureKey {
 
     private byte[] content;

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/ContentTextureLocator.java

@@ -43,7 +43,11 @@
 
 /**
  * Used to locate a resource based on a {@link ContentTextureKey}.
+ *
+ * @deprecated FBX support is deprecated and will be removed in a future release.
+ * Prefer glTF assets instead.
  */
+@Deprecated
 public class ContentTextureLocator implements AssetLocator {
 
     private static final Logger logger = Logger.getLogger(ContentTextureLocator.class.getName());

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/FbxDeprecationWarnings.java

@@ -0,0 +1,25 @@
+package com.jme3.scene.plugins.fbx;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+final class FbxDeprecationWarnings {
+
+    private static volatile boolean logged;
+
+    private FbxDeprecationWarnings() {
+    }
+
+    static void log(Logger logger) {
+        if (!logged) {
+            synchronized (FbxDeprecationWarnings.class) {
+                if (!logged) {
+                    logger.log(Level.WARNING,
+                            "FBX support is deprecated and will be removed in a future release. "
+                            + "Prefer glTF assets instead.");
+                    logged = true;
+                }
+            }
+        }
+    }
+}

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/FbxLoader.java

@@ -70,6 +70,13 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+/**
+ * Loads FBX scene assets.
+ *
+ * @deprecated FBX support is deprecated and will be removed in a future release.
+ * Prefer glTF assets instead.
+ */
+@Deprecated
 public class FbxLoader implements AssetLoader {
 
     private static final Logger logger = Logger.getLogger(FbxLoader.class.getName());
@@ -87,6 +94,7 @@ public class FbxLoader implements AssetLoader {
 
     @Override
     public Object load(AssetInfo assetInfo) throws IOException {
+        FbxDeprecationWarnings.log(logger);
         this.assetManager = assetInfo.getManager();
         AssetKey<?> assetKey = assetInfo.getKey();
         if (!(assetKey instanceof ModelKey)) {
@@ -138,7 +146,7 @@ public Object load(AssetInfo assetInfo) throws IOException {
     private void reset() {
         globalSettings = new FbxGlobalSettings();
     }
-    
+
     private void releaseObjects() {
         globalSettings = null;
         objectMap.clear();

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/SceneKey.java

@@ -34,6 +34,13 @@
 import com.jme3.asset.ModelKey;
 import java.util.Objects;
 
+/**
+ * Asset key for FBX scene loading.
+ *
+ * @deprecated FBX support is deprecated and will be removed in a future release.
+ * Prefer glTF assets instead.
+ */
+@Deprecated
 public class SceneKey extends ModelKey {
 
     private final AnimationList animList;
@@ -75,4 +82,4 @@ public int hashCode() {
         return 413 + Objects.hashCode(animList);
     }
 
-}
+}

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/SceneLoader.java

@@ -46,7 +46,11 @@
  * <p> Loads scene meshes, materials, textures, skeleton and skeletal animation.
  * Multiple animations can be defined with {@link AnimationList} passing into {@link SceneKey}
  * or loaded from different animation layer.</p>
+ *
+ * @deprecated FBX support is deprecated and will be removed in a future release.
+ * Prefer glTF assets instead.
  */
+@Deprecated
 public class SceneLoader implements AssetLoader {
 
     private static final Logger logger = Logger.getLogger(SceneLoader.class.getName());
@@ -87,6 +91,7 @@ public void warning(String warning) {
 
     @Override
     public Object load(AssetInfo assetInfo) throws IOException {
+        FbxDeprecationWarnings.log(logger);
         this.currentAssetInfo = assetInfo;
         this.assetManager = assetInfo.getManager();
         AssetKey<?> assetKey = assetInfo.getKey();

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/SceneWithAnimationLoader.java

@@ -14,6 +14,13 @@
 import com.jme3.asset.AssetLoader;
 import com.jme3.asset.ModelKey;
 
+/**
+ * Loads FBX scenes using an auxiliary animation-list descriptor.
+ *
+ * @deprecated FBX support is deprecated and will be removed in a future release.
+ * Prefer glTF assets instead.
+ */
+@Deprecated
 public class SceneWithAnimationLoader implements AssetLoader {
 
     private Pattern splitStrings = Pattern.compile("([^\"]\\S*|\".+?\")\\s*");

jme3-plugins/src/fbx/java/com/jme3/scene/plugins/fbx/anim/package-info.java

@@ -30,6 +30,10 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * import animations from an FBX asset
+ * Import animations from an FBX asset.
+ *
+ * @deprecated FBX support is deprecated and will be removed in a future release.
+ * Prefer glTF assets instead.
  */
+@Deprecated
 package com.jme3.scene.plugins.fbx.anim;