add getConnections method and deprecate getSkeleton for bodyPose (

#227) * add getConnections method * rename example * remove deprecation comment
ml5js · Nov 1, 2024 · 5caa7a2 · 5caa7a2
1 parent 308b786
commit 5caa7a2
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/examples/bodyPose-skeleton/index.html → .../bodyPose-skeletal-connections/index.html b/examples/bodyPose-skeleton/index.html → .../bodyPose-skeletal-connections/index.html
diff --git a/examples/bodyPose-skeleton/sketch.js → ...s/bodyPose-skeletal-connections/sketch.js b/examples/bodyPose-skeleton/sketch.js → ...s/bodyPose-skeletal-connections/sketch.js
@@ -26,8 +26,8 @@ function setup() {
 
   // Start detecting poses in the webcam video
   bodyPose.detectStart(video, gotPoses);
-  // Get the skeleton connection information
-  connections = bodyPose.getSkeleton();
+  // Get the skeletal connection information
+  connections = bodyPose.getConnections();
 }
 
 function draw() {

diff --git a/src/BodyPose/index.js b/src/BodyPose/index.js
@@ -513,11 +513,11 @@ class BodyPose {
   }
 
   /**
-   * Returns the skeleton connections pairs for the model.
+   * Returns the skeletal connections pairs for the model.
    * @returns {number[][]} an array of pairs of indices containing the connected keypoints.
    * @public
    */
-  getSkeleton() {
+  getConnections() {
     if (this.modelName === "BlazePose") {
       return poseDetection.util.getAdjacentPairs(
         poseDetection.SupportedModels.BlazePose
@@ -528,6 +528,16 @@ class BodyPose {
       );
     }
   }
+
+  /**
+   * Returns the skeletal connections pairs for the model.
+   * An alias for `getConnections`.
+   * @returns {number[][]} an array of pairs of indices containing the connected keypoints.
+   * @public
+   */
+  getSkeleton() {
+    return this.getConnections();
+  }
 }
 
 /**