@pixiv/three-vrm-core 2.1.0-beta.3 → 2.1.0

package/ts3.4/types/meta/VRMMetaLoaderPluginOptions.d.ts

@@ -0,0 +1,22 @@
+/**
+ * A set of options for a {@link VRMMetaLoaderPlugin} instance.
+ */
+export interface VRMMetaLoaderPluginOptions {
+    /**
+     * If `false`, it won't load its thumbnail image ({@link VRM1Meta.thumbnailImage}).
+     * `true` by default.
+     */
+    needThumbnailImage?: boolean;
+    /**
+     * A list of license urls.
+     * This meta loader will accept these `licenseUrl`s.
+     * Otherwise it will throw an error.
+     */
+    acceptLicenseUrls?: string[];
+    /**
+     * 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.
+     */
+    acceptV0Meta?: boolean;
+}

package/ts3.4/types/meta/index.d.ts

@@ -0,0 +1,5 @@
+export { VRM0Meta } from './VRM0Meta';
+export { VRM1Meta } from './VRM1Meta';
+export { VRMMeta } from './VRMMeta';
+export { VRMMetaLoaderPluginOptions as VRMMetaImporterOptions } from './VRMMetaLoaderPluginOptions';
+export { VRMMetaLoaderPlugin } from './VRMMetaLoaderPlugin';

package/ts3.4/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/ts3.4/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/ts3.4/types/utils/getWorldQuaternionLite.d.ts

@@ -0,0 +1,10 @@
+import * as THREE from 'three';
+/**
+ * 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 A target quaternion
+ */
+export declare function getWorldQuaternionLite(object: THREE.Object3D, out: THREE.Quaternion): THREE.Quaternion;

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

@@ -0,0 +1,21 @@
+import { 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.
+ *
+ * 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<THREE.Mesh[] | 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, THREE.Mesh[]>>;

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

@@ -0,0 +1,10 @@
+import * as THREE from 'three';
+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.
+ * @param parser GLTFParser
+ * @param material A material of gltf
+ * @returns Material definition index of glTF
+ */
+export declare function gltfGetAssociatedMaterialIndex(parser: GLTFParser, material: THREE.Material): number | null;

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

@@ -0,0 +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;

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * Yoinked from https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/GLTFLoader.js
+ */
+export declare function resolveURL(url: string, path: string): string;

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

@@ -0,0 +1,6 @@
+/**
+ * Clamp the input value within [0.0 - 1.0].
+ *
+ * @param value The input value
+ */
+export declare function saturate(value: number): number;