Document better which matrix properties imply which other properties

JOML-CI · Jul 3, 2023 · afb0e79 · afb0e79
1 parent 22d6fc1
commit afb0e79
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/src/main/java/org/joml/Matrix4dc.java b/src/main/java/org/joml/Matrix4dc.java
@@ -122,15 +122,17 @@ public interface Matrix4dc {
     byte PROPERTY_AFFINE = 1<<1;
     /**
      * Bit returned by {@link #properties()} to indicate that the matrix represents the identity transformation.
+     * This implies {@link #PROPERTY_AFFINE}, {@link #PROPERTY_TRANSLATION} and {@link #PROPERTY_ORTHONORMAL}.
      */
     byte PROPERTY_IDENTITY = 1<<2;
     /**
      * Bit returned by {@link #properties()} to indicate that the matrix represents a pure translation transformation.
+     * This implies {@link #PROPERTY_AFFINE} and {@link #PROPERTY_ORTHONORMAL}.
      */
     byte PROPERTY_TRANSLATION = 1<<3;
     /**
      * Bit returned by {@link #properties()} to indicate that the upper-left 3x3 submatrix represents an orthogonal
-     * matrix (i.e. orthonormal basis). For practical reasons, this property also always implies 
+     * matrix (i.e. orthonormal basis). For practical reasons, this property also always implies
      * {@link #PROPERTY_AFFINE} in this implementation.
      */
     byte PROPERTY_ORTHONORMAL = 1<<4;

diff --git a/src/main/java/org/joml/Matrix4fc.java b/src/main/java/org/joml/Matrix4fc.java
@@ -121,15 +121,17 @@ public interface Matrix4fc {
     byte PROPERTY_AFFINE = 1<<1;
     /**
      * Bit returned by {@link #properties()} to indicate that the matrix represents the identity transformation.
+     * This implies {@link #PROPERTY_AFFINE}, {@link #PROPERTY_TRANSLATION} and {@link #PROPERTY_ORTHONORMAL}.
      */
     byte PROPERTY_IDENTITY = 1<<2;
     /**
      * Bit returned by {@link #properties()} to indicate that the matrix represents a pure translation transformation.
+     * This implies {@link #PROPERTY_AFFINE} and {@link #PROPERTY_ORTHONORMAL}.
      */
     byte PROPERTY_TRANSLATION = 1<<3;
     /**
      * Bit returned by {@link #properties()} to indicate that the upper-left 3x3 submatrix represents an orthogonal
-     * matrix (i.e. orthonormal basis). For practical reasons, this property also always implies 
+     * matrix (i.e. orthonormal basis). For practical reasons, this property also always implies
      * {@link #PROPERTY_AFFINE} in this implementation.
      */
     byte PROPERTY_ORTHONORMAL = 1<<4;

diff --git a/src/main/java/org/joml/Matrix4x3dc.java b/src/main/java/org/joml/Matrix4x3dc.java
@@ -74,10 +74,12 @@ public interface Matrix4x3dc {
     byte PROPERTY_UNKNOWN = 0;
     /**
      * Bit returned by {@link #properties()} to indicate that the matrix represents the identity transformation.
+     * This implies {@link #PROPERTY_TRANSLATION} and {@link #PROPERTY_ORTHONORMAL}.
      */
     byte PROPERTY_IDENTITY = 1<<2;
     /**
      * Bit returned by {@link #properties()} to indicate that the matrix represents a pure translation transformation.
+     * This implies {@link #PROPERTY_ORTHONORMAL}.
      */
     byte PROPERTY_TRANSLATION = 1<<3;
     /**

diff --git a/src/main/java/org/joml/Matrix4x3fc.java b/src/main/java/org/joml/Matrix4x3fc.java
@@ -73,10 +73,12 @@ public interface Matrix4x3fc {
     byte PROPERTY_UNKNOWN = 0;
     /**
      * Bit returned by {@link #properties()} to indicate that the matrix represents the identity transformation.
+     * This implies {@link #PROPERTY_TRANSLATION} and {@link #PROPERTY_ORTHONORMAL}.
      */
     byte PROPERTY_IDENTITY = 1<<2;
     /**
      * Bit returned by {@link #properties()} to indicate that the matrix represents a pure translation transformation.
+     * This implies {@link #PROPERTY_ORTHONORMAL}.
      */
     byte PROPERTY_TRANSLATION = 1<<3;
     /**