@pixiv/three-vrm-core 1.0.0-beta.8 → 1.0.0

package/types/lookAt/VRMLookAtBoneApplier.d.ts

@@ -31,6 +31,28 @@ export declare class VRMLookAtBoneApplier implements VRMLookAtApplier {
      * A {@link VRMLookAtRangeMap} for vertical upward movement. Both eyes move downwards.
      */
     rangeMapVerticalUp: VRMLookAtRangeMap;
+    /**
+     * The front direction of the face.
+     * Intended to be used for VRM 0.0 compat (VRM 0.0 models are facing Z- instead of Z+).
+     * You usually don't want to touch this.
+     */
+    faceFront: THREE.Vector3;
+    /**
+     * The rest quaternion of LeftEye bone.
+     */
+    private _restQuatLeftEye;
+    /**
+     * The rest quaternion of RightEye bone.
+     */
+    private _restQuatRightEye;
+    /**
+     * The world-space rest quaternion of the parent of the humanoid LeftEye.
+     */
+    private _restLeftEyeParentWorldQuat;
+    /**
+     * The world-space rest quaternion of the parent of the humanoid RightEye.
+     */
+    private _restRightEyeParentWorldQuat;
     /**
      * Create a new {@link VRMLookAtBoneApplier}.
      *
@@ -44,7 +66,18 @@ export declare class VRMLookAtBoneApplier implements VRMLookAtApplier {
     /**
      * Apply the input angle to its associated VRM model.
      *
-     * @param angle An input angle
+     * @param yaw Rotation around Y axis, in degree
+     * @param pitch Rotation around X axis, in degree
+     */
+    applyYawPitch(yaw: number, pitch: number): void;
+    /**
+     * @deprecated Use {@link applyYawPitch} instead.
+     */
+    lookAt(euler: THREE.Euler): void;
+    /**
+     * Get a quaternion that rotates the world-space +Z unit vector to the {@link faceFront} direction.
+     *
+     * @param target A target `THREE.Quaternion`
      */
-    lookAt(angle: THREE.Euler): void;
+    private _getWorldFaceFrontQuat;
 }

package/types/lookAt/VRMLookAtExpressionApplier.d.ts

@@ -45,7 +45,12 @@ export declare class VRMLookAtExpressionApplier implements VRMLookAtApplier {
     /**
      * Apply the input angle to its associated VRM model.
      *
-     * @param angle An input angle
+     * @param yaw Rotation around Y axis, in degree
+     * @param pitch Rotation around X axis, in degree
      */
-    lookAt(angle: THREE.Euler): void;
+    applyYawPitch(yaw: number, pitch: number): void;
+    /**
+     * @deprecated Use {@link applyYawPitch} instead.
+     */
+    lookAt(euler: THREE.Euler): void;
 }

package/types/lookAt/VRMLookAtLoaderPlugin.d.ts

@@ -1,4 +1,4 @@
-import type { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader';
+import type { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
 import type { VRMLookAtLoaderPluginOptions } from './VRMLookAtLoaderPluginOptions';
 /**
  * A plugin of GLTFLoader that imports a {@link VRMLookAt} from a VRM extension of a GLTF.

package/types/lookAt/tests/VRMLookAt.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/lookAt/tests/VRMLookAtBoneApplier.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/lookAt/utils/calcAzimuthAltitude.d.ts

@@ -0,0 +1,13 @@
+import * as THREE from 'three';
+/**
+ * Calculate azimuth / altitude angles from a vector.
+ *
+ * This returns a difference of angles from (1, 0, 0).
+ * Azimuth represents an angle around Y axis.
+ * Altitude represents an angle around Z axis.
+ * It is rotated in intrinsic Y-Z order.
+ *
+ * @param vector The vector
+ * @returns A tuple contains two angles, `[ azimuth, altitude ]`
+ */
+export declare function calcAzimuthAltitude(vector: THREE.Vector3): [azimuth: number, altitude: number];

package/types/lookAt/utils/sanitizeAngle.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Make sure the angle is within -PI to PI.
+ *
+ * @example
+ * ```js
+ * sanitizeAngle(1.5 * Math.PI) // -0.5 * PI
+ * ```
+ *
+ * @param angle An input angle
+ */
+export declare function sanitizeAngle(angle: number): number;

package/types/lookAt/utils/tests/calcAzimuthAltitude.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/lookAt/utils/tests/sanitizeAngle.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/meta/VRMMetaLoaderPlugin.d.ts

@@ -1,4 +1,4 @@
-import type { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader';
+import type { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
 import type { VRMMetaLoaderPluginOptions } from './VRMMetaLoaderPluginOptions';
 /**
  * A plugin of GLTFLoader that imports a {@link VRM1Meta} from a VRM extension of a GLTF.
@@ -17,7 +17,7 @@ export declare class VRMMetaLoaderPlugin implements GLTFLoaderPlugin {
      */
     acceptLicenseUrls: string[];
     /**
-     * Whether it should accept VRM0.X meta or not.
+     * Whether it should accept VRM0.0 meta or not.
      * Note that it might load {@link VRM0Meta} instead of {@link VRM1Meta} when this is `true`.
      * `true` by default.
      */

package/types/meta/VRMMetaLoaderPluginOptions.d.ts

@@ -14,7 +14,7 @@ export interface VRMMetaLoaderPluginOptions {
      */
     acceptLicenseUrls?: string[];
     /**
-     * Whether it should accept VRM0.X meta or not.
+     * Whether it should accept VRM0.0 meta or not.
      * Note that it might load {@link VRM0Meta} instead of {@link VRM1Meta} when this is `true`.
      * `true` by default.
      */

package/types/tests/matchers/toBeCloseToQuaternion.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="jest" />
+import * as THREE from 'three';
+export declare function toBeCloseToQuaternion(received: THREE.Quaternion, expected: THREE.Quaternion, precision?: number): jest.CustomMatcherResult;
+declare global {
+    namespace jest {
+        interface Matchers<R> {
+            toBeCloseToQuaternion(expected: THREE.Quaternion, precision?: number): R;
+        }
+    }
+}

package/types/tests/matchers/toBeCloseToVector3.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="jest" />
+import * as THREE from 'three';
+export declare function toBeCloseToVector3(received: THREE.Vector3, expected: THREE.Vector3, precision?: number): jest.CustomMatcherResult;
+declare global {
+    namespace jest {
+        interface Matchers<R> {
+            toBeCloseToVector3(expected: THREE.Vector3, precision?: number): R;
+        }
+    }
+}

package/types/utils/gltfExtractPrimitivesFromNode.d.ts

@@ -1,4 +1,4 @@
-import type { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
+import type { GLTF } from 'three/examples/jsm/loaders/GLTFLoader.js';
 /**
  * Extract primitives ( `THREE.Mesh[]` ) of a node from a loaded GLTF.
  * The main purpose of this function is to distinguish primitives and children from a node that has both meshes and children.

package/types/utils/gltfGetAssociatedMaterialIndex.d.ts

@@ -1,5 +1,5 @@
 import * as THREE from 'three';
-import { GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader';
+import { GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
 /**
  * Get a material definition index of glTF from associated material.
  * It's basically a comat code between Three.js r133 or above and previous versions.

package/types/utils/renameMaterialProperty.d.ts

@@ -0,0 +1 @@
+export declare function renameMaterialProperty(name: string): string;