Gltf support #3785

immortius · 2019-11-10T05:55:11Z

Contains

Adds initial support for gltf mesh, skeletal mesh and animations.

How to test

spawnPrefab "engine:cubesm"

Outstanding before merging

Let me know!

GooeyHub · 2019-11-10T06:14:14Z

Hooray Jenkins reported success with all tests good!

skaldarnar

I haven't tested it in-game yet, but I trust you with the code changes 😉 Only changes I would like to request is to expand the .* star imports to use explicit imports.

skaldarnar · 2019-11-13T08:41:11Z

engine/src/main/java/org/terasology/engine/subsystem/headless/HeadlessGraphics.java

-import org.terasology.rendering.assets.animation.MeshAnimation;
-import org.terasology.rendering.assets.animation.MeshAnimationData;
-import org.terasology.rendering.assets.animation.MeshAnimationImpl;
+import org.terasology.rendering.assets.animation.*;


No start imports 😉

No prob. I assume the IntelliJ default settings just got me there.

skaldarnar · 2019-11-13T08:41:45Z

engine/src/main/java/org/terasology/engine/subsystem/lwjgl/LwjglGraphics.java

-import org.terasology.rendering.assets.animation.MeshAnimation;
-import org.terasology.rendering.assets.animation.MeshAnimationData;
-import org.terasology.rendering.assets.animation.MeshAnimationImpl;
+import org.terasology.rendering.assets.animation.*;


No star import 😉

skaldarnar · 2019-11-13T08:51:20Z

engine/src/main/java/org/terasology/logic/console/commands/CoreCommands.java

@@ -527,7 +527,7 @@ public String spawnPrefab(@Sender EntityRef sender, @CommandParam("prefabId") St

        Optional<Prefab> prefab = Assets.getPrefab(prefabName);
        if (prefab.isPresent() && prefab.get().getComponent(LocationComponent.class) != null) {


Do you have an idea how to use Optional in a more idiomatic way? I think the logic can be expressed as follows, but I'm not sure how to end up with the status strings as before...

Assets.getPrefab(prefabName) .filter(prefab -> prefab.getComponent(LocationComponent.class) != null) .ifPresent(prefab -> entityManager.create(prefab.get(), spawnPos);

Hmm, I think I would do:

return Assets.getPrefab(prefabName).map(prefab -> { LocationComponent loc = prefab.getComponent(LocationComponent.class); if (loc != null) { entityManager.create(prefab, spawnPos); return "Done"; } else { return "Prefab cannot be spawned (no location component)"; } }).orElse("Unknown prefab");

That would work... I'm always hesitant to have side effects in map and try to use ifPresent (forEach in Scala) for that purpose.
I think your proposal is better than using the combination of isPresent and get() (multiple times). 👍

skaldarnar · 2019-11-13T08:52:21Z

engine/src/main/java/org/terasology/logic/location/LocationComponent.java

    public Vector3f getLocalDirection() {
        Vector3f result = Direction.FORWARD.getVector3f();
        getLocalRotation().rotate(result, result);
        return result;
    }

+    /**
+     * @return The location of this component, relative to any parent


Is it location or rotation? And what is the difference between direction and rotation?

Prexisting code, but direction would be a vector pointing the way the entity is facing, while rotation is a quaternion I imagine.

skaldarnar · 2019-11-13T08:53:16Z

engine/src/main/java/org/terasology/logic/location/LocationComponent.java

@@ -202,4 +244,6 @@ public int hashCode() {
    public boolean shouldReplicate(FieldMetadata<?, ?> field, boolean initial, boolean toOwner) {
        return initial || replicateChanges;
    }
+


Important new lines 😉

skaldarnar · 2019-11-13T08:53:27Z

engine/src/main/java/org/terasology/math/MatrixUtils.java

-import org.terasology.math.geom.Matrix3f;
-import org.terasology.math.geom.Matrix4f;
-import org.terasology.math.geom.Vector3f;
+import org.terasology.math.geom.*;


No star imports 😉

skaldarnar · 2019-11-13T08:57:45Z

engine/src/main/java/org/terasology/rendering/gltf/GLTFAnimationFormat.java

+import org.terasology.rendering.assets.animation.MeshAnimationBundleData;
+import org.terasology.rendering.assets.animation.MeshAnimationData;
+import org.terasology.rendering.assets.animation.MeshAnimationFrame;
+import org.terasology.rendering.gltf.model.*;


No star imports 😉

skaldarnar · 2019-11-13T08:58:17Z

engine/src/main/java/org/terasology/rendering/gltf/GLTFMeshFormat.java

+import org.terasology.assets.management.AssetManager;
+import org.terasology.assets.module.annotations.RegisterAssetFileFormat;
+import org.terasology.rendering.assets.mesh.MeshData;
+import org.terasology.rendering.gltf.model.*;


No star imports 😉

skaldarnar

I'll give others a chance to look at this, but here's an approval from my side 🙃

Cervator · 2019-11-24T04:39:28Z

Added some more potential reviewers :-)

@Quarternius just updated the Metal Renegades robots to a single mesh approach that should work, would be good to get somebody to try those out. See https://github.com/MetaTerasology/MetalRenegades

It would also be wonderful if we could have some help adding a page on the new glTF approach in https://github.com/Terasology/TutorialAssetSystem/wiki with a sample model added there as well.

If we can merge this soon'ish we could probably make a GCI task to take one of Quarternius' many models that seem fitting for the game to test them out with the new format while commenting on any difficulties doing so

GooeyHub · 2019-11-24T04:57:13Z

Hooray Jenkins reported success with all tests good!

brylie · 2019-11-24T11:18:04Z

engine/src/main/java/org/terasology/math/MatrixUtils.java

@@ -245,4 +247,10 @@ public static Matrix3f calcNormalMatrix(Matrix4f mv) {
        result.transpose();
        return result;
    }
+
+    public static Quat4f extractRotation(BaseMatrix4f m) {


It might be good here to add a docstring explaining the formulas. They are somewhat dense, and not obvious to the uninitiated. Is there some upstream documentation for these formulas?

brylie · 2019-11-24T11:20:47Z

engine/src/main/java/org/terasology/rendering/assets/skeletalmesh/SkeletalMeshData.java

    }

-    public List<Vector3f> getVertexPositions(List<Vector3f> bonePositions, List<Quat4f> boneRotations) {
+    public List<Vector3f> getVertexPositions(List<Matrix4f> boneTransforms) {


Is there a process for auto-generating documentation? Would documenting these methods potentially be useful for new developers to become familiar with the skeletal mesh API?

If the documentation is autogenerated then it is likely not providing any information of value (since it would all be derived from the method name/parameter names/etc.

I'll chuck some javadoc on these methods. I'm not sure they would be used much - primarily they exist for the rendering system and I'm not sure there is much reason to otherwise interact with them, maybe custom collision checking against exact mesh position I guess.

OK, I just noticed they were public methods, so thought they might be used by a developer somehow.

brylie · 2019-11-24T11:20:59Z

engine/src/main/java/org/terasology/rendering/assets/skeletalmesh/SkeletalMeshData.java

        }
        return results;
    }

-    public List<Vector3f> getVertexNormals(List<Vector3f> bonePositions, List<Quat4f> boneRotations) {
+    public List<Vector3f> getVertexNormals(List<Matrix4f> boneTransforms) {


Add docstring?

brylie · 2019-11-24T11:21:11Z

engine/src/main/java/org/terasology/rendering/assets/skeletalmesh/SkeletalMeshData.java

            }
-            results.add(vertexNorm);
+            skinMat.transformVector(norm);
+            results.add(norm);
        }
        return results;
    }

    public int getVertexCount() {


Add docstring?

brylie

LGTM.

Would like to see some Javadoc docstrings for public classes and methods, so that it might be possible to auto-generate docs. That idea is not specific to this PR, though :-)

casals

Works perfectly. Tested with both Core and Builder Sample Gameplay. Javadoc is minimal but enough. Clean deserializers are refreshing. Voting for immediate merge. :)

GooeyHub · 2019-11-25T10:18:02Z

Hooray Jenkins reported success with all tests good!

Cervator · 2019-11-26T02:41:51Z

Cervator · 2019-12-18T00:24:15Z

Update: There is now a rebased version of this PR in #3808 - easier to use for testing!

Edit: Update to the update! This is now rebased on its own and more fixed :-)

GooeyHub · 2019-12-22T07:51:35Z

Hooray Jenkins reported success with all tests good!

casals · 2019-12-22T17:01:27Z

@immortius about the floating bug discussion mentioned at artwork: there was a bug affecting the heightOffset parameter being masked by another bug - but this PR fixes the second one, so now we can get rid of the first as well :) Basically what's happening now is: this parameter is being processed/rendered off-scale, and with the modifications you made there's no practical effect right now (try setting if to -100 or 100 and you won't see any difference in-game). Here's the fix:

at engine/src/main/java/org/terasology/rendering/logic/SkeletonRenderer.java :

remove worldPos.y -= skeletalMesh.heightOffset; from line 271;
set the offset at line 253, right before the AABB transformation:
worldPos.y -= skeletalMesh.heightOffset;
aabb = aabb.transform(worldRot, worldPos, worldScale);

This, combined with Behaviors PR 23, should correct both the floating bug and the weird rotation observed on deer.

UPDATE: just realized you applied the scale on commit 3adb3bb - I tested the latest commit locally, can confirm it's OK. leaving the original comment for reference from chat channel

PAndaContron · 2019-12-22T17:38:18Z

Not sure if this is a known issue, but I found that the rotation field in gltf files appears to be completely ignored. This can be replicated by going to the "Object Properties" tab in Blender and changing the rotation values, then exporting it. None of these rotations have any effect, despite being exported with the file.

PAndaContron · 2019-12-23T15:52:21Z

Looking through the code, it appears that rotation is used when loading bones, but not when loading meshes. This might also cause some issues with animations, although I have not tested that.

PAndaContron · 2019-12-24T00:02:32Z

I made a PR #3812 to add support for transformations, although it needs more testing.

Cervator · 2020-05-14T03:37:24Z

New Oreons are ready! Many thanks to @Quaternius :-)

https://github.com/MetaTerasology/Oreons

I think that was the bulk of the remainder, if we can just get them all tested and PRed to their module we might finally be able to merge this while retaining most the models (and the gameplay they're used in).

The Light & Shadow critters are still in an odd place. We have most the red team, but in an old storage location at https://github.com/MovingBlocks/TeraMisc/tree/master/lightandshadow/redteam - need to move to a new MetaTerasology repo. Additionally I don't see the knight in there, yet I know we have the game asset to spawn it. There's also the Dominog. I think there was even an adventurer? But maybe that was just the 2D concept art by @SuperSnark. Those might be findable via forum or elsewhere, and then likewise just need a re-export to glTF along with testing. Just a few more volunteer hours and we should be ready :-)

Pinging @brylie @PAndaContron @casals @Kanonbell @Naman-sopho extra in case of interest in helping with the last few (from comments here and on model PRs, along with Naman for MOO itself). Right this moment MOO may be stuck in dependency figuring-outing as we're reworking some fundamental modules, but that shouldn't be too much hassle to sort out.

Now behold! The Oreons v2.0:

https://cdn.discordapp.com/attachments/541688465226596362/710248508279488532/4.gif
https://cdn.discordapp.com/attachments/541688465226596362/710248502646538352/1.gif
https://cdn.discordapp.com/attachments/541688465226596362/710248517989302322/5.gif
https://cdn.discordapp.com/attachments/541688465226596362/710248503791583312/2.gif
https://cdn.discordapp.com/attachments/541688465226596362/710248507692417044/3.gif

brylie · 2020-05-17T18:23:39Z

I am willing to help with the model PRs. What specifically should I do?

Cervator · 2020-05-17T19:04:28Z

Hey @brylie :-)

That would be super awesome. Essentially it is one or two things:

If there is already a contributed gltf PR for a given module make sure it actually tests out and the creature reacts as intended in-game (animations trigger and so on). This may be a little tricky in some cases if it isn't obvious how to actually trigger some animations. We used to have (still might live in the new Debugging module?) an animation tool / UI where you could select and test a model in-game, but i'm not sure if that exists anymore, or would even work for gltf
If there is no PR and we just have loose gltf files somewhere then put the files together with adjusted prefabs so they can be tested like in the first point, and make a module PR.

Cervator · 2020-09-21T04:44:30Z

This has been merged via #4150! Just with rebase etc so this PR doesn't show as merged, but it is! 🎉

Thank you @immortius and everybody else involved :-)

Now time for continuing the cleanup with #4156 😁

skaldarnar requested changes Nov 13, 2019

View reviewed changes

skaldarnar approved these changes Nov 13, 2019

View reviewed changes

Cervator requested review from Quaternius, pollend, brylie and kartikey0303 November 24, 2019 04:35

Cervator added Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc. Artwork labels Nov 24, 2019

Cervator requested review from mayant15, RatMoleRat, Qwertygiy, AndyTechGuy and casals November 24, 2019 04:40

brylie reviewed Nov 24, 2019

View reviewed changes

casals approved these changes Nov 24, 2019

View reviewed changes

This was referenced Dec 15, 2019

Added gltf support MetaTerasology/MawGooey#2

Closed

Rebased gltf support #3807

Closed

Gltf support #3808

Closed

immortius added 2 commits December 21, 2019 10:41

Initial support for glTF - mesh only with some limitations.

e6cfdfb

Added support for embedded binary data for gltf.

dd5aca2

immortius force-pushed the gltf-support branch from ef220da to 3adb3bb Compare December 22, 2019 07:33

This was referenced Dec 24, 2019

feat(gltf): Converted obj models to gltf Terasology/AdditionalRails#35

Closed

feat(gltf): Changed obj meshes to gltf Terasology/Rails#50

Closed

feat(gltf): Changed obj meshes to gltf Terasology/AdvancedRails#4

Closed

casals mentioned this pull request Apr 18, 2020

Added Chicken Terasology/WildAnimals#11

Closed

skaldarnar mentioned this pull request Apr 19, 2020

Added good and bad robots assets Terasology/MetalRenegades#43

Closed

Qwertygiy mentioned this pull request Aug 8, 2020

GLTF Support 2020-08-08 #4120

Closed

pollend mentioned this pull request Sep 16, 2020

GLTF Support 2020-09-14 #4150

Merged

Merge branch 'develop' into gltf-support

66e7062

Cervator mentioned this pull request Sep 21, 2020

Cleanup after glTF model format change #4156

Closed

32 tasks

Cervator added this to the v4.1.0 milestone Sep 21, 2020

Cervator closed this Sep 21, 2020

Cervator deleted the gltf-support branch September 21, 2020 04:46

skaldarnar added Topic: UI/UX Requests, Issues and Changes related to screens, artwork, sound and overall user experience and removed Artwork labels May 15, 2021

		@@ -527,7 +527,7 @@ public String spawnPrefab(@Sender EntityRef sender, @CommandParam("prefabId") St

		Optional<Prefab> prefab = Assets.getPrefab(prefabName);
		if (prefab.isPresent() && prefab.get().getComponent(LocationComponent.class) != null) {

Gltf support #3785

Gltf support #3785

Conversation

immortius commented Nov 10, 2019

Contains

How to test

Outstanding before merging

GooeyHub commented Nov 10, 2019

skaldarnar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

immortius Nov 13, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skaldarnar left a comment

Choose a reason for hiding this comment

Cervator commented Nov 24, 2019

GooeyHub commented Nov 24, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brylie left a comment

Choose a reason for hiding this comment

casals left a comment

Choose a reason for hiding this comment

GooeyHub commented Nov 25, 2019

Cervator commented Nov 26, 2019 • edited Loading

Cervator commented Dec 18, 2019 • edited Loading

GooeyHub commented Dec 22, 2019

casals commented Dec 22, 2019 • edited Loading

PAndaContron commented Dec 22, 2019

PAndaContron commented Dec 23, 2019

PAndaContron commented Dec 24, 2019

Cervator commented May 14, 2020

brylie commented May 17, 2020

Cervator commented May 17, 2020

Cervator commented Sep 21, 2020

immortius Nov 13, 2019 •

edited

Loading

Cervator commented Nov 26, 2019 •

edited

Loading

Cervator commented Dec 18, 2019 •

edited

Loading

casals commented Dec 22, 2019 •

edited

Loading