diff --git a/gradle.properties b/gradle.properties index 549826a8..2ab4daa9 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,7 +2,7 @@ jjVersion = 0.9.7-SNAPSHOT -## default artifact name (used if -Partifact= isn't specified on the command line) +## default artifact ID (used when -Partifact= isn't specified on the command line) artifact = jolt-jni #artifact = jolt-jni-Android #artifact = jolt-jni-Linux64 @@ -33,7 +33,7 @@ artifact = jolt-jni #target = MacOSX_ARM64 #target = Windows64 -## options to specify the preferred native toolchain +## options to specify the preferred native toolchain (used when -Ptool= isn't specified on the command line) ## These options affect desktop builds but not Android builds. #tool = clang #tool = gcc diff --git a/src/main/java/com/github/stephengold/joltjni/Mat44.java b/src/main/java/com/github/stephengold/joltjni/Mat44.java index b430d94c..6f3e621c 100644 --- a/src/main/java/com/github/stephengold/joltjni/Mat44.java +++ b/src/main/java/com/github/stephengold/joltjni/Mat44.java @@ -107,7 +107,7 @@ public Mat44(RMat44Arg rMatrix) { * @param c1 the desired first/leftmost column (not null, unaffected) * @param c2 the desired 2nd column (not null, unaffected) * @param c3 the desired 3rd column (not null, unaffected) - * @param c4 the desired last/rightmost column (not null, unaffected) + * @param c4 the desired 4th/rightmost column (not null, unaffected) */ public Mat44(Vec4Arg c1, Vec4Arg c2, Vec4Arg c3, Vec4Arg c4) { this(c1.getX(), c1.getY(), c1.getZ(), c1.getW(), @@ -220,9 +220,9 @@ public void setElement(int row, int column, float value) { } /** - * Set the last/rightmost column to the specified vector. + * Alter the translation component. * - * @param vec the vector to use (not null, unaffected) + * @param vec the desired translation (not null, unaffected) */ public void setTranslation(Vec3Arg vec) { long matrixVa = va(); @@ -655,7 +655,7 @@ public Vec3 multiply3x3Transposed(Vec3Arg vec3Arg) { } /** - * Multiply the 3x4 matrix by the specified column vector, with the last + * Multiply the 3x4 matrix by the specified column vector, with the 4th * component of the right factor implied to be one. The matrix is * unaffected. * diff --git a/src/main/java/com/github/stephengold/joltjni/RMat44.java b/src/main/java/com/github/stephengold/joltjni/RMat44.java index 7b98133e..a5d8eda9 100644 --- a/src/main/java/com/github/stephengold/joltjni/RMat44.java +++ b/src/main/java/com/github/stephengold/joltjni/RMat44.java @@ -70,7 +70,7 @@ public RMat44(Mat44Arg spMatrix) { } /** - * Instantiate from 4 column vectors. + * Instantiate a matrix with the specified columns. * * @param c1 the desired first/leftmost column (not null, unaffected) * @param c2 the desired 2nd column (not null, unaffected) diff --git a/src/main/java/com/github/stephengold/joltjni/readonly/Mat44Arg.java b/src/main/java/com/github/stephengold/joltjni/readonly/Mat44Arg.java index c0d8c2bd..964190f8 100644 --- a/src/main/java/com/github/stephengold/joltjni/readonly/Mat44Arg.java +++ b/src/main/java/com/github/stephengold/joltjni/readonly/Mat44Arg.java @@ -105,13 +105,12 @@ public interface Mat44Arg extends ConstJoltPhysicsObject { * Test whether the current matrix is an identity matrix. The matrix is * unaffected. * - * @return {@code true} if equal, {@code false} if unequal + * @return {@code true} if exactly equal, otherwise {@code false} */ boolean isIdentity(); /** - * Multiply the current matrix by the specified matrix. The current matrix - * is unaffected. + * Multiply the current matrix by the argument. The matrix is unaffected. * * @param m2 the right factor (not null, unaffected) * @return a new matrix @@ -128,7 +127,7 @@ public interface Mat44Arg extends ConstJoltPhysicsObject { Mat44 multiply3x3(Mat44Arg arg); /** - * Multiply the 3x3 matrix by the specified vector. The matrix is + * Multiply the 3x3 matrix by the specified column vector. The matrix is * unaffected. * * @param vec3Arg the right factor (not null, unaffected) @@ -137,8 +136,8 @@ public interface Mat44Arg extends ConstJoltPhysicsObject { Vec3 multiply3x3(Vec3Arg vec3Arg); /** - * Multiply the transpose of the 3x3 matrix by the specified vector. The - * matrix is unaffected. + * Multiply the transpose of the 3x3 matrix by the specified column vector. + * The matrix is unaffected. * * @param vec3Arg the right factor (not null, unaffected) * @return a new vector diff --git a/src/main/java/com/github/stephengold/joltjni/readonly/RMat44Arg.java b/src/main/java/com/github/stephengold/joltjni/readonly/RMat44Arg.java index 4f5987c1..fcb90b6a 100644 --- a/src/main/java/com/github/stephengold/joltjni/readonly/RMat44Arg.java +++ b/src/main/java/com/github/stephengold/joltjni/readonly/RMat44Arg.java @@ -1,5 +1,5 @@ /* -Copyright (c) 2024 Stephen Gold +Copyright (c) 2024-2025 Stephen Gold Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -100,7 +100,7 @@ public interface RMat44Arg extends ConstJoltPhysicsObject { * Multiply the current matrix by the argument. The matrix is unaffected. * * @param m2 the right factor (not null, unaffected) - * @return a new vector + * @return a new matrix */ RMat44 multiply(RMat44Arg m2);