Skip to content

solve issue #2076 (software skinning requires vertex normals) #2155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 7, 2023
Merged

solve issue #2076 (software skinning requires vertex normals) #2155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
924ea5d
SkinningControl: add null checks to solve issue #2076
stephengold Dec 3, 2023
c5f3377
SkeletonControl: add null checks to solve issue #2076
stephengold Dec 3, 2023
4bd027d
jme3-examples: add a test for issue #2076
stephengold Dec 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 25 additions & 15 deletions jme3-core/src/main/java/com/jme3/anim/SkinningControl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2021 jMonkeyEngine
* Copyright (c) 2009-2023 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -327,15 +327,20 @@ void resetToBind() {
VertexBuffer bindPos = mesh.getBuffer(Type.BindPosePosition);
VertexBuffer bindNorm = mesh.getBuffer(Type.BindPoseNormal);
VertexBuffer pos = mesh.getBuffer(Type.Position);
VertexBuffer norm = mesh.getBuffer(Type.Normal);
FloatBuffer pb = (FloatBuffer) pos.getData();
FloatBuffer nb = (FloatBuffer) norm.getData();
FloatBuffer bpb = (FloatBuffer) bindPos.getData();
FloatBuffer bnb = (FloatBuffer) bindNorm.getData();
pb.clear();
nb.clear();
bpb.clear();
bnb.clear();

// reset bind normals if there is a BindPoseNormal buffer
if (bindNorm != null) {
VertexBuffer norm = mesh.getBuffer(Type.Normal);
FloatBuffer nb = (FloatBuffer) norm.getData();
FloatBuffer bnb = (FloatBuffer) bindNorm.getData();
nb.clear();
bnb.clear();
nb.put(bnb).clear();
}

//resetting bind tangents if there is a bind tangent buffer
VertexBuffer bindTangents = mesh.getBuffer(Type.BindPoseTangent);
Expand All @@ -348,9 +353,7 @@ void resetToBind() {
tb.put(btb).clear();
}


pb.put(bpb).clear();
nb.put(bnb).clear();
}
}
}
Expand Down Expand Up @@ -583,9 +586,10 @@ private void applySkinningTangents(Mesh mesh, Matrix4f[] offsetMatrices, VertexB

VertexBuffer nb = mesh.getBuffer(Type.Normal);

FloatBuffer fnb = (FloatBuffer) nb.getData();
fnb.rewind();

FloatBuffer fnb = (nb == null) ? null : (FloatBuffer) nb.getData();
if (fnb != null) {
fnb.rewind();
}

FloatBuffer ftb = (FloatBuffer) tb.getData();
ftb.rewind();
Expand Down Expand Up @@ -615,7 +619,9 @@ private void applySkinningTangents(Mesh mesh, Matrix4f[] offsetMatrices, VertexB
bufLength = Math.min(posBuf.length, fvb.remaining());
tanLength = Math.min(tanBuf.length, ftb.remaining());
fvb.get(posBuf, 0, bufLength);
fnb.get(normBuf, 0, bufLength);
if (fnb != null) {
fnb.get(normBuf, 0, bufLength);
}
ftb.get(tanBuf, 0, tanLength);
int verts = bufLength / 3;
int idxPositions = 0;
Expand Down Expand Up @@ -688,16 +694,20 @@ private void applySkinningTangents(Mesh mesh, Matrix4f[] offsetMatrices, VertexB

fvb.position(fvb.position() - bufLength);
fvb.put(posBuf, 0, bufLength);
fnb.position(fnb.position() - bufLength);
fnb.put(normBuf, 0, bufLength);
if (fnb != null) {
fnb.position(fnb.position() - bufLength);
fnb.put(normBuf, 0, bufLength);
}
ftb.position(ftb.position() - tanLength);
ftb.put(tanBuf, 0, tanLength);
}

vars.release();

vb.updateData(fvb);
nb.updateData(fnb);
if (nb != null) {
nb.updateData(fnb);
}
tb.updateData(ftb);
}

Expand Down
38 changes: 25 additions & 13 deletions jme3-core/src/main/java/com/jme3/animation/SkeletonControl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2021 jMonkeyEngine
* Copyright (c) 2009-2023 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -321,15 +321,20 @@ void resetToBind() {
VertexBuffer bindPos = mesh.getBuffer(Type.BindPosePosition);
VertexBuffer bindNorm = mesh.getBuffer(Type.BindPoseNormal);
VertexBuffer pos = mesh.getBuffer(Type.Position);
VertexBuffer norm = mesh.getBuffer(Type.Normal);
FloatBuffer pb = (FloatBuffer) pos.getData();
FloatBuffer nb = (FloatBuffer) norm.getData();
FloatBuffer bpb = (FloatBuffer) bindPos.getData();
FloatBuffer bnb = (FloatBuffer) bindNorm.getData();
pb.clear();
nb.clear();
bpb.clear();
bnb.clear();

// reset bind normals if there is a BindPoseNormal buffer
if (bindNorm != null) {
VertexBuffer norm = mesh.getBuffer(Type.Normal);
FloatBuffer nb = (FloatBuffer) norm.getData();
FloatBuffer bnb = (FloatBuffer) bindNorm.getData();
nb.clear();
bnb.clear();
nb.put(bnb).clear();
}

//reset bind tangents if there is a bind tangent buffer
VertexBuffer bindTangents = mesh.getBuffer(Type.BindPoseTangent);
Expand All @@ -343,7 +348,6 @@ void resetToBind() {
}

pb.put(bpb).clear();
nb.put(bnb).clear();
}
}
}
Expand Down Expand Up @@ -574,8 +578,10 @@ private void applySkinningTangents(Mesh mesh, Matrix4f[] offsetMatrices, VertexB

VertexBuffer nb = mesh.getBuffer(Type.Normal);

FloatBuffer fnb = (FloatBuffer) nb.getData();
fnb.rewind();
FloatBuffer fnb = (nb == null) ? null : (FloatBuffer) nb.getData();
if (fnb != null) {
fnb.rewind();
}

FloatBuffer ftb = (FloatBuffer) tb.getData();
ftb.rewind();
Expand Down Expand Up @@ -603,7 +609,9 @@ private void applySkinningTangents(Mesh mesh, Matrix4f[] offsetMatrices, VertexB
bufLength = Math.min(posBuf.length, fvb.remaining());
tanLength = Math.min(tanBuf.length, ftb.remaining());
fvb.get(posBuf, 0, bufLength);
fnb.get(normBuf, 0, bufLength);
if (fnb != null) {
fnb.get(normBuf, 0, bufLength);
}
ftb.get(tanBuf, 0, tanLength);
int verts = bufLength / 3;
int idxPositions = 0;
Expand Down Expand Up @@ -676,16 +684,20 @@ private void applySkinningTangents(Mesh mesh, Matrix4f[] offsetMatrices, VertexB

fvb.position(fvb.position() - bufLength);
fvb.put(posBuf, 0, bufLength);
fnb.position(fnb.position() - bufLength);
fnb.put(normBuf, 0, bufLength);
if (fnb != null) {
fnb.position(fnb.position() - bufLength);
fnb.put(normBuf, 0, bufLength);
}
ftb.position(ftb.position() - tanLength);
ftb.put(tanBuf, 0, tanLength);
}

vars.release();

vb.updateData(fvb);
nb.updateData(fnb);
if (nb != null) {
nb.updateData(fnb);
}
tb.updateData(ftb);
}

Expand Down
132 changes: 132 additions & 0 deletions jme3-examples/src/main/java/jme3test/animation/TestIssue2076.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
/*
* Copyright (c) 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 jme3test.animation;

import com.jme3.anim.SkinningControl;
import com.jme3.anim.util.AnimMigrationUtils;
import com.jme3.animation.SkeletonControl;
import com.jme3.app.SimpleApplication;
import com.jme3.light.AmbientLight;
import com.jme3.math.ColorRGBA;
import com.jme3.scene.Geometry;
import com.jme3.scene.Mesh;
import com.jme3.scene.Node;
import com.jme3.scene.VertexBuffer;

/**
* Test for JMonkeyEngine issue #2076: software skinning requires vertex
* normals.
*
* <p>If the issue is resolved, 2 copies of the Jaime model will be rendered.
*
* <p>If the issue is present, then the application will immediately crash,
* typically with a {@code NullPointerException}.
*
* @author Stephen Gold
*/
public class TestIssue2076 extends SimpleApplication {
/**
* Main entry point for the TestIssue2076 application.
*
* @param args array of command-line arguments (not null)
*/
public static void main(String... argv) {
TestIssue2076 app = new TestIssue2076();
app.start();
}

/**
* Initialize this application.
*/
@Override
public void simpleInitApp() {
AmbientLight ambientLight = new AmbientLight();
ambientLight.setColor(new ColorRGBA(1f, 1f, 1f, 1f));
rootNode.addLight(ambientLight);
/*
* The original Jaime model was chosen for testing because it includes
* tangent buffers (needed to trigger issue #2076) and uses the old
* animation system (so it can be easily used to test both systems).
*/
String assetPath = "Models/Jaime/Jaime.j3o";

testOldAnimationSystem(assetPath);
testNewAnimationSystem(assetPath);
}

/**
* Attach the specified model (which uses the old animation system) to the
* scene graph, enable software skinning, and remove its vertex normals.
*
* @param assetPath the asset path of the test model (not null)
*/
private void testOldAnimationSystem(String assetPath) {
Node oldJaime = (Node) assetManager.loadModel(assetPath);
rootNode.attachChild(oldJaime);
oldJaime.setLocalTranslation(-1f, 0f, 0f);

// enable software skinning:
SkeletonControl skeletonControl
= oldJaime.getControl(SkeletonControl.class);
skeletonControl.setHardwareSkinningPreferred(false);

// remove its vertex normals:
Geometry oldGeometry = (Geometry) oldJaime.getChild(0);
Mesh oldMesh = oldGeometry.getMesh();
oldMesh.clearBuffer(VertexBuffer.Type.Normal);
oldMesh.clearBuffer(VertexBuffer.Type.BindPoseNormal);
}

/**
* Attach the specified model, converted to the new animation system, to the
* scene graph, enable software skinning, and remove its vertex normals.
*
* @param assetPath the asset path of the test model (not null)
*/
private void testNewAnimationSystem(String assetPath) {
Node newJaime = (Node) assetManager.loadModel(assetPath);
AnimMigrationUtils.migrate(newJaime);
rootNode.attachChild(newJaime);
newJaime.setLocalTranslation(1f, 0f, 0f);

// enable software skinning:
SkinningControl skinningControl
= newJaime.getControl(SkinningControl.class);
skinningControl.setHardwareSkinningPreferred(false);

// remove its vertex normals:
Geometry newGeometry = (Geometry) newJaime.getChild(0);
Mesh newMesh = newGeometry.getMesh();
newMesh.clearBuffer(VertexBuffer.Type.Normal);
newMesh.clearBuffer(VertexBuffer.Type.BindPoseNormal);
}
}