MyAnimation: rename 3 methods and correct their javadoc

stephengold · Nov 23, 2023 · 508ace7 · 508ace7
1 parent 95f035b
commit 508ace7
Showing 1 changed file with 88 additions and 51 deletions.
diff --git a/HeartLibrary/src/main/java/jme3utilities/MyAnimation.java b/HeartLibrary/src/main/java/jme3utilities/MyAnimation.java
@@ -77,6 +77,78 @@ private MyAnimation() {
     // *************************************************************************
     // new methods exposed
 
+    /**
+     * Copy the keyframe rotations for the specified bone/spatial track.
+     *
+     * @param track which Track (not null, unaffected)
+     * @return a new array or null
+     */
+    public static Quaternion[] copyRotations(Track track) {
+        Quaternion[] result;
+        if (track instanceof BoneTrack) {
+            BoneTrack boneTrack = (BoneTrack) track;
+            result = boneTrack.getRotations();
+
+        } else if (track instanceof SpatialTrack) {
+            SpatialTrack spatialTrack = (SpatialTrack) track;
+            result = spatialTrack.getRotations();
+
+        } else {
+            String className = track.getClass().getSimpleName();
+            throw new IllegalArgumentException(className);
+        }
+
+        return result;
+    }
+
+    /**
+     * Copy the keyframe scales for the specified bone/spatial track.
+     *
+     * @param track which Track (not null, unaffected)
+     * @return a new array or null
+     */
+    public static Vector3f[] copyScales(Track track) {
+        Vector3f[] result;
+        if (track instanceof BoneTrack) {
+            BoneTrack boneTrack = (BoneTrack) track;
+            result = boneTrack.getScales();
+
+        } else if (track instanceof SpatialTrack) {
+            SpatialTrack spatialTrack = (SpatialTrack) track;
+            result = spatialTrack.getScales();
+
+        } else {
+            String className = track.getClass().getSimpleName();
+            throw new IllegalArgumentException(className);
+        }
+
+        return result;
+    }
+
+    /**
+     * Copy the translations for the specified bone/spatial track.
+     *
+     * @param track which Track (not null, unaffected)
+     * @return a new array or null
+     */
+    public static Vector3f[] copyTranslations(Track track) {
+        Vector3f[] result;
+        if (track instanceof BoneTrack) {
+            BoneTrack boneTrack = (BoneTrack) track;
+            result = boneTrack.getTranslations();
+
+        } else if (track instanceof SpatialTrack) {
+            SpatialTrack spatialTrack = (SpatialTrack) track;
+            result = spatialTrack.getTranslations();
+
+        } else {
+            String className = track.getClass().getSimpleName();
+            throw new IllegalArgumentException(className);
+        }
+
+        return result;
+    }
+
     /**
      * Count all tracks of the specified type in the specified Animation.
      *
@@ -229,13 +301,13 @@ public static String describe(Track track, AnimControl animControl) {
             targetName = MyString.quote(targetName);
             builder.append(targetName);
 
-            if (getTranslations(track) != null) {
+            if (copyTranslations(track) != null) {
                 builder.append("T");
             }
-            if (getRotations(track) != null) {
+            if (copyRotations(track) != null) {
                 builder.append("R");
             }
-            if (getScales(track) != null) {
+            if (copyScales(track) != null) {
                 builder.append("S");
             }
         }
@@ -527,50 +599,27 @@ public static float[] getKeyFrameTimes(Object object) {
     }
 
     /**
-     * Access the keyframe rotations for the specified bone/spatial track.
+     * Copy the keyframe rotations for the specified bone/spatial track.
      *
      * @param track which Track (not null, unaffected)
-     * @return the pre-existing instance or null
+     * @return a new array or null
+     * @deprecated use {@link #copyRotations(com.jme3.animation.Track)}
      */
+    @Deprecated
     public static Quaternion[] getRotations(Track track) {
-        Quaternion[] result;
-        if (track instanceof BoneTrack) {
-            BoneTrack boneTrack = (BoneTrack) track;
-            result = boneTrack.getRotations();
-
-        } else if (track instanceof SpatialTrack) {
-            SpatialTrack spatialTrack = (SpatialTrack) track;
-            result = spatialTrack.getRotations();
-
-        } else {
-            String className = track.getClass().getSimpleName();
-            throw new IllegalArgumentException(className);
-        }
-
+        Quaternion[] result = copyRotations(track);
         return result;
     }
 
     /**
-     * Access the keyframe scales for the specified bone/spatial track.
+     * Copy the keyframe scales for the specified bone/spatial track.
      *
      * @param track which Track (not null, unaffected)
-     * @return the pre-existing instance or null
+     * @return a new array or null
+     * @deprecated use {@link #copyScales(com.jme3.animation.Track)}
      */
     public static Vector3f[] getScales(Track track) {
-        Vector3f[] result;
-        if (track instanceof BoneTrack) {
-            BoneTrack boneTrack = (BoneTrack) track;
-            result = boneTrack.getScales();
-
-        } else if (track instanceof SpatialTrack) {
-            SpatialTrack spatialTrack = (SpatialTrack) track;
-            result = spatialTrack.getScales();
-
-        } else {
-            String className = track.getClass().getSimpleName();
-            throw new IllegalArgumentException(className);
-        }
-
+        Vector3f[] result = copyScales(track);
         return result;
     }
 
@@ -635,26 +684,14 @@ public static String getTargetName(Track track, AnimControl animControl) {
     }
 
     /**
-     * Access the translations for the specified bone/spatial track.
+     * Copy the translations for the specified bone/spatial track.
      *
      * @param track which Track (not null, unaffected)
-     * @return the pre-existing instance or null
+     * @return a new array or null
+     * @deprecated use {@link #copyTranslations(com.jme3.animation.Track)}
      */
     public static Vector3f[] getTranslations(Track track) {
-        Vector3f[] result;
-        if (track instanceof BoneTrack) {
-            BoneTrack boneTrack = (BoneTrack) track;
-            result = boneTrack.getTranslations();
-
-        } else if (track instanceof SpatialTrack) {
-            SpatialTrack spatialTrack = (SpatialTrack) track;
-            result = spatialTrack.getTranslations();
-
-        } else {
-            String className = track.getClass().getSimpleName();
-            throw new IllegalArgumentException(className);
-        }
-
+        Vector3f[] result = copyTranslations(track);
         return result;
     }