@pixiv/three-vrm 0.6.8 → 0.6.9

package/types/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from './GLTFSchema';
-export * from './VRMSchema';
-export * from './types';
+export * from './GLTFSchema';
+export * from './VRMSchema';
+export * from './types';

package/types/types/types.d.ts

@@ -1,64 +1,64 @@
-import * as THREE from 'three';
-/**
- * A single node of GLTFs, represented as a Three.js object.
- *
- * See: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#nodes-and-hierarchy
- */
-export declare type GLTFNode = THREE.Object3D;
-/**
- * A single primitive of GLTFs, represented as a Three.js object.
- *
- * See: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#meshes
- */
-export declare type GLTFPrimitive = THREE.Mesh | THREE.SkinnedMesh;
-/**
- * A single mesh of GLTFs, represented as a Three.js object;
- *
- * See: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#meshes
- */
-export declare type GLTFMesh = THREE.Group | THREE.Mesh | THREE.SkinnedMesh;
-/**
- * Represents a transform of a single bone of [[VRMPose]].
- * Both `position` and `rotation` are optional.
- */
-export interface VRMPoseTransform {
-    /**
-     * Position of the transform.
-     */
-    position?: RawVector3;
-    /**
-     * Rotation of the transform.
-     * Note that it's a quaternion.
-     */
-    rotation?: RawVector4;
-}
-/**
- * Represents a pose that VRM can do.
- *
- * See [[HumanBone]] for complete list of bone names.
- * Note that certain VRM models might not have every bones defined in [[HumanBone]].
- *
- * @example An example of VRMPose interface
- * ```js
- * {
- *   [HumanBone.LeftUpperLeg] : {
- *     rotation: [  0.000,  0.000, -0.454,  0.891 ],
- *     position: [  0.000,  0.000,  0.000 ] // position is not required though
- *   },
- *   [HumanBone.LeftLowerLeg] : {
- *     rotation: [ -0.454,  0.000,  0.000,  0.891 ]
- *   },
- * }
- * ```
- */
-export interface VRMPose {
-    [boneName: string]: VRMPoseTransform | undefined;
-}
-/**
- * Vector3 but it's a raw array.
- */
-export declare type RawVector3 = [number, number, number];
-/**
- * Vector4 but it's a raw array.
- */
-export declare type RawVector4 = [number, number, number, number];
+import * as THREE from 'three';
+/**
+ * A single node of GLTFs, represented as a Three.js object.
+ *
+ * See: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#nodes-and-hierarchy
+ */
+export declare type GLTFNode = THREE.Object3D;
+/**
+ * A single primitive of GLTFs, represented as a Three.js object.
+ *
+ * See: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#meshes
+ */
+export declare type GLTFPrimitive = THREE.Mesh | THREE.SkinnedMesh;
+/**
+ * A single mesh of GLTFs, represented as a Three.js object;
+ *
+ * See: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#meshes
+ */
+export declare type GLTFMesh = THREE.Group | THREE.Mesh | THREE.SkinnedMesh;
+/**
+ * Represents a transform of a single bone of [[VRMPose]].
+ * Both `position` and `rotation` are optional.
+ */
+export interface VRMPoseTransform {
+    /**
+     * Position of the transform.
+     */
+    position?: RawVector3;
+    /**
+     * Rotation of the transform.
+     * Note that it's a quaternion.
+     */
+    rotation?: RawVector4;
+}
+/**
+ * Represents a pose that VRM can do.
+ *
+ * See [[HumanBone]] for complete list of bone names.
+ * Note that certain VRM models might not have every bones defined in [[HumanBone]].
+ *
+ * @example An example of VRMPose interface
+ * ```js
+ * {
+ *   [HumanBone.LeftUpperLeg] : {
+ *     rotation: [  0.000,  0.000, -0.454,  0.891 ],
+ *     position: [  0.000,  0.000,  0.000 ] // position is not required though
+ *   },
+ *   [HumanBone.LeftLowerLeg] : {
+ *     rotation: [ -0.454,  0.000,  0.000,  0.891 ]
+ *   },
+ * }
+ * ```
+ */
+export interface VRMPose {
+    [boneName: string]: VRMPoseTransform | undefined;
+}
+/**
+ * Vector3 but it's a raw array.
+ */
+export declare type RawVector3 = [number, number, number];
+/**
+ * Vector4 but it's a raw array.
+ */
+export declare type RawVector4 = [number, number, number, number];

package/types/utils/Matrix4InverseCache.d.ts

@@ -1,28 +1,28 @@
-import * as THREE from 'three';
-export declare class Matrix4InverseCache {
-    /**
-     * The target matrix.
-     */
-    readonly matrix: THREE.Matrix4;
-    /**
-     * A cache of inverse of current matrix.
-     */
-    private readonly _inverseCache;
-    /**
-     * A flag that makes it want to recalculate its {@link _inverseCache}.
-     * Will be set `true` when `elements` are mutated and be used in `getInverse`.
-     */
-    private _shouldUpdateInverse;
-    /**
-     * The original of `matrix.elements`
-     */
-    private readonly _originalElements;
-    /**
-     * Inverse of given matrix.
-     * Note that it will return its internal private instance.
-     * Make sure copying this before mutate this.
-     */
-    get inverse(): THREE.Matrix4;
-    constructor(matrix: THREE.Matrix4);
-    revert(): void;
-}
+import * as THREE from 'three';
+export declare class Matrix4InverseCache {
+    /**
+     * The target matrix.
+     */
+    readonly matrix: THREE.Matrix4;
+    /**
+     * A cache of inverse of current matrix.
+     */
+    private readonly _inverseCache;
+    /**
+     * A flag that makes it want to recalculate its {@link _inverseCache}.
+     * Will be set `true` when `elements` are mutated and be used in `getInverse`.
+     */
+    private _shouldUpdateInverse;
+    /**
+     * The original of `matrix.elements`
+     */
+    private readonly _originalElements;
+    /**
+     * Inverse of given matrix.
+     * Note that it will return its internal private instance.
+     * Make sure copying this before mutate this.
+     */
+    get inverse(): THREE.Matrix4;
+    constructor(matrix: THREE.Matrix4);
+    revert(): void;
+}

package/types/utils/disposer.d.ts

@@ -1,2 +1,2 @@
-import * as THREE from 'three';
-export declare function deepDispose(object3D: THREE.Object3D): void;
+import * as THREE from 'three';
+export declare function deepDispose(object3D: THREE.Object3D): void;

package/types/utils/gltfExtractPrimitivesFromNode.d.ts

@@ -1,22 +1,22 @@
-import type { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
-import type { GLTFPrimitive } from '../types';
-/**
- * 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.
- *
- * It utilizes the behavior that GLTFLoader adds mesh primitives to the node object ( `THREE.Group` ) first then adds its children.
- *
- * @param gltf A GLTF object taken from GLTFLoader
- * @param nodeIndex The index of the node
- */
-export declare function gltfExtractPrimitivesFromNode(gltf: GLTF, nodeIndex: number): Promise<GLTFPrimitive[] | null>;
-/**
- * Extract primitives ( `THREE.Mesh[]` ) of nodes from a loaded GLTF.
- * See {@link gltfExtractPrimitivesFromNode} for more details.
- *
- * It returns a map from node index to extraction result.
- * If a node does not have a mesh, the entry for the node will not be put in the returning map.
- *
- * @param gltf A GLTF object taken from GLTFLoader
- */
-export declare function gltfExtractPrimitivesFromNodes(gltf: GLTF): Promise<Map<number, GLTFPrimitive[]>>;
+import type { GLTF } from 'three/examples/jsm/loaders/GLTFLoader.js';
+import type { GLTFPrimitive } from '../types';
+/**
+ * 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.
+ *
+ * It utilizes the behavior that GLTFLoader adds mesh primitives to the node object ( `THREE.Group` ) first then adds its children.
+ *
+ * @param gltf A GLTF object taken from GLTFLoader
+ * @param nodeIndex The index of the node
+ */
+export declare function gltfExtractPrimitivesFromNode(gltf: GLTF, nodeIndex: number): Promise<GLTFPrimitive[] | null>;
+/**
+ * Extract primitives ( `THREE.Mesh[]` ) of nodes from a loaded GLTF.
+ * See {@link gltfExtractPrimitivesFromNode} for more details.
+ *
+ * It returns a map from node index to extraction result.
+ * If a node does not have a mesh, the entry for the node will not be put in the returning map.
+ *
+ * @param gltf A GLTF object taken from GLTFLoader
+ */
+export declare function gltfExtractPrimitivesFromNodes(gltf: GLTF): Promise<Map<number, GLTFPrimitive[]>>;

package/types/utils/mat4InvertCompat.d.ts

@@ -1,8 +1,8 @@
-import * as THREE from 'three';
-/**
- * A compat function for `Matrix4.invert()` / `Matrix4.getInverse()`.
- * `Matrix4.invert()` is introduced in r123 and `Matrix4.getInverse()` emits a warning.
- * We are going to use this compat for a while.
- * @param target A target matrix
- */
-export declare function mat4InvertCompat<T extends THREE.Matrix4>(target: T): T;
+import * as THREE from 'three';
+/**
+ * A compat function for `Matrix4.invert()` / `Matrix4.getInverse()`.
+ * `Matrix4.invert()` is introduced in r123 and `Matrix4.getInverse()` emits a warning.
+ * We are going to use this compat for a while.
+ * @param target A target matrix
+ */
+export declare function mat4InvertCompat<T extends THREE.Matrix4>(target: T): T;

package/types/utils/math.d.ts

@@ -1,40 +1,40 @@
-import * as THREE from 'three';
-/**
- * Clamp an input number within [ `0.0` - `1.0` ].
- *
- * @param value The input value
- */
-export declare function saturate(value: number): number;
-/**
- * Map the range of an input value from [ `min` - `max` ] to [ `0.0` - `1.0` ].
- * If input value is less than `min` , it returns `0.0`.
- * If input value is greater than `max` , it returns `1.0`.
- *
- * See also: https://threejs.org/docs/#api/en/math/Math.smoothstep
- *
- * @param x The value that will be mapped into the specified range
- * @param min Minimum value of the range
- * @param max Maximum value of the range
- */
-export declare function linstep(x: number, min: number, max: number): number;
-/**
- * Extract world position of an object from its world space matrix, in cheaper way.
- *
- * @param object The object
- * @param out Target vector
- */
-export declare function getWorldPositionLite(object: THREE.Object3D, out: THREE.Vector3): THREE.Vector3;
-/**
- * Extract world scale of an object from its world space matrix, in cheaper way.
- *
- * @param object The object
- * @param out Target vector
- */
-export declare function getWorldScaleLite(object: THREE.Object3D, out: THREE.Vector3): THREE.Vector3;
-/**
- * Extract world rotation of an object from its world space matrix, in cheaper way.
- *
- * @param object The object
- * @param out Target vector
- */
-export declare function getWorldQuaternionLite(object: THREE.Object3D, out: THREE.Quaternion): THREE.Quaternion;
+import * as THREE from 'three';
+/**
+ * Clamp an input number within [ `0.0` - `1.0` ].
+ *
+ * @param value The input value
+ */
+export declare function saturate(value: number): number;
+/**
+ * Map the range of an input value from [ `min` - `max` ] to [ `0.0` - `1.0` ].
+ * If input value is less than `min` , it returns `0.0`.
+ * If input value is greater than `max` , it returns `1.0`.
+ *
+ * See also: https://threejs.org/docs/#api/en/math/Math.smoothstep
+ *
+ * @param x The value that will be mapped into the specified range
+ * @param min Minimum value of the range
+ * @param max Maximum value of the range
+ */
+export declare function linstep(x: number, min: number, max: number): number;
+/**
+ * Extract world position of an object from its world space matrix, in cheaper way.
+ *
+ * @param object The object
+ * @param out Target vector
+ */
+export declare function getWorldPositionLite(object: THREE.Object3D, out: THREE.Vector3): THREE.Vector3;
+/**
+ * Extract world scale of an object from its world space matrix, in cheaper way.
+ *
+ * @param object The object
+ * @param out Target vector
+ */
+export declare function getWorldScaleLite(object: THREE.Object3D, out: THREE.Vector3): THREE.Vector3;
+/**
+ * Extract world rotation of an object from its world space matrix, in cheaper way.
+ *
+ * @param object The object
+ * @param out Target vector
+ */
+export declare function getWorldQuaternionLite(object: THREE.Object3D, out: THREE.Quaternion): THREE.Quaternion;

package/types/utils/quatInvertCompat.d.ts

@@ -1,8 +1,8 @@
-import * as THREE from 'three';
-/**
- * A compat function for `Quaternion.invert()` / `Quaternion.inverse()`.
- * `Quaternion.invert()` is introduced in r123 and `Quaternion.inverse()` emits a warning.
- * We are going to use this compat for a while.
- * @param target A target quaternion
- */
-export declare function quatInvertCompat<T extends THREE.Quaternion>(target: T): T;
+import * as THREE from 'three';
+/**
+ * A compat function for `Quaternion.invert()` / `Quaternion.inverse()`.
+ * `Quaternion.invert()` is introduced in r123 and `Quaternion.inverse()` emits a warning.
+ * We are going to use this compat for a while.
+ * @param target A target quaternion
+ */
+export declare function quatInvertCompat<T extends THREE.Quaternion>(target: T): T;

package/types/utils/renameMaterialProperty.d.ts

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