forked from jMonkeyEngine/jmonkeyengine
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add userdata loader to gltf (jMonkeyEngine#2106)
* Add userdata loader and make it the default * turn unhandled extras log into a warning * Make default extra loader static and configurable * Make default extras loader configurable and reinstance with gltf loader * code cleanup * make defaultExtraLoaderClass volatile * fix
- Loading branch information
1 parent
3ec59c8
commit c8987be
Showing
4 changed files
with
233 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
174 changes: 174 additions & 0 deletions
174
jme3-plugins/src/gltf/java/com/jme3/scene/plugins/gltf/UserDataLoader.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| /* | ||
| * Copyright (c) 2009-2023 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.scene.plugins.gltf; | ||
|
|
||
| import com.jme3.plugins.json.JsonArray; | ||
| import com.jme3.plugins.json.JsonElement; | ||
| import com.jme3.plugins.json.JsonObject; | ||
| import com.jme3.plugins.json.JsonPrimitive; | ||
| import com.jme3.scene.Spatial; | ||
|
|
||
| import java.lang.reflect.Array; | ||
| import java.util.*; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** | ||
| * Import user data from glTF extras. | ||
| * | ||
| * Derived from Simsilica JmeConvert | ||
| * (https://github.com/Simsilica/JmeConvert/blob/master/src/main/java/com/simsilica/jmec/gltf/GltfExtrasLoader.java) | ||
| * by Paul Speed (Copyright (c) 2019, Simsilica, LLC) | ||
| * | ||
| */ | ||
|
|
||
| public class UserDataLoader implements ExtrasLoader { | ||
|
|
||
| private static final Logger log = Logger.getLogger(UserDataLoader.class.getName()); | ||
|
|
||
| public UserDataLoader() { | ||
| } | ||
|
|
||
| @Override | ||
| public Object handleExtras(GltfLoader loader, String parentName, JsonElement parent, JsonElement extras, | ||
| Object input) { | ||
| log.fine("handleExtras(" + loader + ", " + parentName + ", " + parent + ", " + extras + ", " + input | ||
| + ")"); | ||
| // Only interested in composite objects | ||
| if (!(extras instanceof JsonObject)) { | ||
| log.warning("Skipping extras:" + extras); | ||
| return input; | ||
| } | ||
| JsonObject jo = extras.getAsJsonObject(); | ||
| apply(input, jo); | ||
| return input; | ||
| } | ||
|
|
||
| protected void apply(Object input, JsonObject extras) { | ||
| if (input == null) { | ||
| return; | ||
| } | ||
| if (input.getClass().isArray()) { | ||
| applyToArray(input, extras); | ||
| } else if (input instanceof Spatial) { | ||
| applyToSpatial((Spatial) input, extras); | ||
| } else { | ||
| log.warning("Unhandled input type:" + input.getClass()); | ||
| } | ||
| } | ||
|
|
||
| protected void applyToArray(Object array, JsonObject extras) { | ||
| int size = Array.getLength(array); | ||
| for (int i = 0; i < size; i++) { | ||
| Object o = Array.get(array, i); | ||
| log.fine("processing array[" + i + "]:" + o); | ||
| apply(o, extras); | ||
| } | ||
| } | ||
|
|
||
| protected void applyToSpatial(Spatial spatial, JsonObject extras) { | ||
| for (Map.Entry<String, JsonElement> el : extras.entrySet()) { | ||
| log.fine(el.toString()); | ||
| Object val = toAttribute(el.getValue(), false); | ||
|
|
||
| if (log.isLoggable(Level.FINE)) { | ||
| log.fine("setUserData(" + el.getKey() + ", " + val + ")"); | ||
| } | ||
| spatial.setUserData(el.getKey(), val); | ||
| } | ||
| } | ||
|
|
||
| protected Object toAttribute(JsonElement el, boolean nested) { | ||
| if (el == null) { | ||
| return null; | ||
| } | ||
| if (el instanceof JsonObject) { | ||
| return toAttribute(el.getAsJsonObject(), nested); | ||
| } else if (el instanceof JsonArray) { | ||
| return toAttribute(el.getAsJsonArray(), nested); | ||
| } else if (el instanceof JsonPrimitive) { | ||
| return toAttribute(el.getAsJsonPrimitive(), nested); | ||
| } | ||
| log.warning("Unhandled extras element:" + el); | ||
| return null; | ||
| } | ||
|
|
||
| protected Object toAttribute(JsonObject jo, boolean nested) { | ||
| Map<String, Object> result = new HashMap<>(); | ||
| for (Map.Entry<String, JsonElement> el : jo.entrySet()) { | ||
| result.put(el.getKey(), toAttribute(el.getValue(), true)); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| protected Object toAttribute(JsonArray ja, boolean nested) { | ||
| List<Object> result = new ArrayList<>(); | ||
| for (JsonElement el : ja) { | ||
| result.add(toAttribute(el, true)); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| protected Object toAttribute(JsonPrimitive jp, boolean nested) { | ||
| if (jp.isBoolean()) { | ||
| return jp.getAsBoolean(); | ||
| } else if (jp.isNumber()) { | ||
| // JME doesn't save Maps properly and treats them as two | ||
| // separate Lists... and it doesn't like saving Doubles | ||
| // in lists so we'll just return strings in the case where | ||
| // the value would end up in a map. If users someday really | ||
| // need properly typed map values and JME map storage hasn't | ||
| // been fixed then perhaps we give the users the option of | ||
| // flattening the nested properties into dot notation, ie: | ||
| // all directly on UserData with no Map children. | ||
| if (nested) { | ||
| return jp.getAsString(); | ||
| } | ||
| Number num = jp.getAsNumber(); | ||
| // JME doesn't like to save GSON's LazilyParsedNumber so we'll | ||
| // convert it into a real number. I don't think we can reliably | ||
| // guess what type of number the user intended. It would take | ||
| // some expirimentation to determine if things like 0.0 are | ||
| // preserved | ||
| // during export or just get exported as 0. | ||
| // Rather than randomly flip-flop between number types depending | ||
| // on the inclusion (or not) of a decimal point, we'll just always | ||
| // return Double. | ||
| return num.doubleValue(); | ||
| } else if (jp.isString()) { | ||
| return jp.getAsString(); | ||
| } | ||
| log.warning("Unhandled primitive:" + jp); | ||
| return null; | ||
| } | ||
| } |