소스 검색

Merge pull request #8997 from reimund/skeletonviewer-display-options-docs

SkeletonViewer: Updated docs for changeDisplayOptions.
David Catuhe 4 년 전
부모
커밋
ec6194cea9
1개의 변경된 파일7개의 추가작업 그리고 3개의 파일을 삭제
  1. 7 3
      src/Debug/skeletonViewer.ts

+ 7 - 3
src/Debug/skeletonViewer.ts

@@ -864,12 +864,16 @@ export class SkeletonViewer {
     }
 
     /** Sets a display option of the skeleton viewer
-     *
+	 *
      * | Option          | Type    | Default | Description |
      * | --------------- | ------- | ------- | ----------- |
+     * | midStep         | float   | 0.235   | A percentage between a bone and its child that determines the widest part of a spur. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
+     * | midStepFactor   | float   | 0.15    | Mid step width expressed as a factor of the length. A value of 0.5 makes the spur width half of the spur length. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
+     * | sphereBaseSize  | float   | 2       | Sphere base size. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
+     * | sphereScaleUnit | float   | 0.865   | Sphere scale factor used to scale spheres in relation to the longest bone. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
      * | showLocalAxes   | boolean | false   | Displays local axes on all bones. |
-     * | localAxesSize   | float   | 0.075   | Determines the length of each local axis. |
-     *
+	 * | localAxesSize   | float   | 0.075   | Determines the length of each local axis. |
+	 *
      * @param option String of the option name
      * @param value The numerical option value
      */