@pixiv/three-vrm-core 1.0.5 → 1.0.7-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixiv/three-vrm-core",
-  "version": "1.0.5",
+  "version": "1.0.7-alpha.0",
   "description": "The implementation of core features of VRM, for @pixiv/three-vrm",
   "license": "MIT",
   "author": "pixiv",
@@ -50,13 +50,13 @@
     "@pixiv/types-vrmc-vrm-1.0": "1.0.0"
   },
   "devDependencies": {
-    "@types/three": "^0.144.0",
+    "@types/three": "^0.146.0",
     "lint-staged": "13.0.3",
-    "three": "^0.144.0"
+    "three": "^0.146.0"
   },
   "peerDependencies": {
-    "@types/three": "^0.144.0",
-    "three": "^0.144.0"
+    "@types/three": "^0.146.0",
+    "three": "^0.146.0"
   },
-  "gitHead": "60373d967bf34fa5314c0fe8b40af023c6465f15"
+  "gitHead": "5f6f321c1138715aa099cdde40e6a21584151202"
 }

package/ts3.4/types/lookAt/VRMLookAt.d.ts

@@ -81,7 +81,7 @@ export declare class VRMLookAt {
     constructor(humanoid: VRMHumanoid, applier: VRMLookAtApplier);
     /**
      * Get its yaw-pitch angles as an `Euler`.
-     * Does NOT consider {@link faceFront}.
+     * Does NOT consider {@link faceFront}; it returns `Euler(0, 0, 0; "YXZ")` by default regardless of the faceFront value.
      *
      * @param target The target euler
      */
@@ -101,17 +101,17 @@ export declare class VRMLookAt {
      */
     clone(): VRMLookAt;
     /**
-     * Reset the lookAt direction to initial direction.
+     * Reset the lookAt direction (yaw and pitch) to the initial direction.
      */
     reset(): void;
     /**
-     * Get its head position in world coordinate.
+     * Get its lookAt position in world coordinate.
      *
      * @param target A target `THREE.Vector3`
      */
     getLookAtWorldPosition(target: THREE.Vector3): THREE.Vector3;
     /**
-     * Get its head rotation in world coordinate.
+     * Get its lookAt rotation in world coordinate.
      * Does NOT consider {@link faceFront}.
      *
      * @param target A target `THREE.Quaternion`
@@ -130,15 +130,18 @@ export declare class VRMLookAt {
      */
     getLookAtWorldDirection(target: THREE.Vector3): THREE.Vector3;
     /**
-     * Set its LookAt position.
+     * Set its lookAt target position.
+     *
      * Note that its result will be instantly overwritten if {@link VRMLookAtHead.autoUpdate} is enabled.
      *
+     * If you want to track an object continuously, you might want to use {@link target} instead.
+     *
      * @param position A target position, in world space
      */
     lookAt(position: THREE.Vector3): void;
     /**
      * Update the VRMLookAtHead.
-     * If {@link VRMLookAtHead.autoUpdate} is disabled, it will do nothing.
+     * If {@link autoUpdate} is enabled, this will make it look at the {@link target}.
      *
      * @param delta deltaTime, it isn't used though. You can use the parameter if you want to use this in your own extended {@link VRMLookAt}.
      */

package/ts3.4/types/utils/getWorldQuaternionLite.d.ts

@@ -1,8 +1,10 @@
 import * as THREE from 'three';
 /**
- * Extract world rotation of an object from its world space matrix, in cheaper way.
+ * A replacement of `Object3D.getWorldQuaternion`.
+ * Extract the world quaternion of an object from its world space matrix, without calling `Object3D.updateWorldMatrix`.
+ * Use this when you're sure that the world matrix is up-to-date.
  *
  * @param object The object
- * @param out Target vector
+ * @param out A target quaternion
  */
 export declare function getWorldQuaternionLite(object: THREE.Object3D, out: THREE.Quaternion): THREE.Quaternion;

package/types/lookAt/VRMLookAt.d.ts

@@ -83,7 +83,7 @@ export declare class VRMLookAt {
     constructor(humanoid: VRMHumanoid, applier: VRMLookAtApplier);
     /**
      * Get its yaw-pitch angles as an `Euler`.
-     * Does NOT consider {@link faceFront}.
+     * Does NOT consider {@link faceFront}; it returns `Euler(0, 0, 0; "YXZ")` by default regardless of the faceFront value.
      *
      * @param target The target euler
      */
@@ -103,17 +103,17 @@ export declare class VRMLookAt {
      */
     clone(): VRMLookAt;
     /**
-     * Reset the lookAt direction to initial direction.
+     * Reset the lookAt direction (yaw and pitch) to the initial direction.
      */
     reset(): void;
     /**
-     * Get its head position in world coordinate.
+     * Get its lookAt position in world coordinate.
      *
      * @param target A target `THREE.Vector3`
      */
     getLookAtWorldPosition(target: THREE.Vector3): THREE.Vector3;
     /**
-     * Get its head rotation in world coordinate.
+     * Get its lookAt rotation in world coordinate.
      * Does NOT consider {@link faceFront}.
      *
      * @param target A target `THREE.Quaternion`
@@ -132,15 +132,18 @@ export declare class VRMLookAt {
      */
     getLookAtWorldDirection(target: THREE.Vector3): THREE.Vector3;
     /**
-     * Set its LookAt position.
+     * Set its lookAt target position.
+     *
      * Note that its result will be instantly overwritten if {@link VRMLookAtHead.autoUpdate} is enabled.
      *
+     * If you want to track an object continuously, you might want to use {@link target} instead.
+     *
      * @param position A target position, in world space
      */
     lookAt(position: THREE.Vector3): void;
     /**
      * Update the VRMLookAtHead.
-     * If {@link VRMLookAtHead.autoUpdate} is disabled, it will do nothing.
+     * If {@link autoUpdate} is enabled, this will make it look at the {@link target}.
      *
      * @param delta deltaTime, it isn't used though. You can use the parameter if you want to use this in your own extended {@link VRMLookAt}.
      */

package/types/utils/getWorldQuaternionLite.d.ts

@@ -1,8 +1,10 @@
 import * as THREE from 'three';
 /**
- * Extract world rotation of an object from its world space matrix, in cheaper way.
+ * A replacement of `Object3D.getWorldQuaternion`.
+ * Extract the world quaternion of an object from its world space matrix, without calling `Object3D.updateWorldMatrix`.
+ * Use this when you're sure that the world matrix is up-to-date.
  *
  * @param object The object
- * @param out Target vector
+ * @param out A target quaternion
  */
 export declare function getWorldQuaternionLite(object: THREE.Object3D, out: THREE.Quaternion): THREE.Quaternion;