@pixiv/three-vrm 0.6.7 → 0.6.8

package/types/VRM.d.ts

@@ -1,110 +1,110 @@
-import * as THREE from 'three';
-import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
-import { VRMBlendShapeProxy } from './blendshape';
-import { VRMFirstPerson } from './firstperson';
-import { VRMHumanoid } from './humanoid';
-import { VRMLookAtHead } from './lookat';
-import { VRMMeta } from './meta/VRMMeta';
-import { VRMSpringBoneManager } from './springbone';
-import { VRMImporterOptions } from './VRMImporter';
-/**
- * Parameters for a [[VRM]] class.
- */
-export interface VRMParameters {
-    scene: THREE.Scene | THREE.Group;
-    humanoid?: VRMHumanoid;
-    blendShapeProxy?: VRMBlendShapeProxy;
-    firstPerson?: VRMFirstPerson;
-    lookAt?: VRMLookAtHead;
-    materials?: THREE.Material[];
-    springBoneManager?: VRMSpringBoneManager;
-    meta?: VRMMeta;
-}
-/**
- * A class that represents a single VRM model.
- * See the documentation of [[VRM.from]] for the most basic use of VRM.
- */
-export declare class VRM {
-    /**
-     * Create a new VRM from a parsed result of GLTF taken from GLTFLoader.
-     * It's probably a thing what you want to get started with VRMs.
-     *
-     * @example Most basic use of VRM
-     * ```
-     * const scene = new THREE.Scene();
-     *
-     * new THREE.GLTFLoader().load( 'models/three-vrm-girl.vrm', ( gltf ) => {
-     *
-     *   THREE.VRM.from( gltf ).then( ( vrm ) => {
-     *
-     *     scene.add( vrm.scene );
-     *
-     *   } );
-     *
-     * } );
-     * ```
-     *
-     * @param gltf A parsed GLTF object taken from GLTFLoader
-     * @param options Options that will be used in importer
-     */
-    static from(gltf: GLTF, options?: VRMImporterOptions): Promise<VRM>;
-    /**
-     * `THREE.Scene` or `THREE.Group` (depends on your three.js revision) that contains the entire VRM.
-     */
-    readonly scene: THREE.Scene | THREE.Group;
-    /**
-     * Contains [[VRMHumanoid]] of the VRM.
-     * You can control each bones using [[VRMHumanoid.getBoneNode]].
-     *
-     * @TODO Add a link to VRM spec
-     */
-    readonly humanoid?: VRMHumanoid;
-    /**
-     * Contains [[VRMBlendShapeProxy]] of the VRM.
-     * You might want to control these facial expressions via [[VRMBlendShapeProxy.setValue]].
-     */
-    readonly blendShapeProxy?: VRMBlendShapeProxy;
-    /**
-     * Contains [[VRMFirstPerson]] of the VRM.
-     * You can use various feature of the firstPerson field.
-     */
-    readonly firstPerson?: VRMFirstPerson;
-    /**
-     * Contains [[VRMLookAtHead]] of the VRM.
-     * You might want to use [[VRMLookAtHead.target]] to control the eye direction of your VRMs.
-     */
-    readonly lookAt?: VRMLookAtHead;
-    /**
-     * Contains materials of the VRM.
-     * `updateVRMMaterials` method of these materials will be called via its [[VRM.update]] method.
-     */
-    readonly materials?: THREE.Material[];
-    /**
-     * Contains meta fields of the VRM.
-     * You might want to refer these license fields before use your VRMs.
-     */
-    readonly meta?: VRMMeta;
-    /**
-     * A [[VRMSpringBoneManager]] manipulates all spring bones attached on the VRM.
-     * Usually you don't have to care about this property.
-     */
-    readonly springBoneManager?: VRMSpringBoneManager;
-    /**
-     * Create a new VRM instance.
-     *
-     * @param params [[VRMParameters]] that represents components of the VRM
-     */
-    constructor(params: VRMParameters);
-    /**
-     * **You need to call this on your update loop.**
-     *
-     * This function updates every VRM components.
-     *
-     * @param delta deltaTime
-     */
-    update(delta: number): void;
-    /**
-     * Dispose everything about the VRM instance.
-     */
-    dispose(): void;
-}
+import * as THREE from 'three';
+import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
+import { VRMBlendShapeProxy } from './blendshape';
+import { VRMFirstPerson } from './firstperson';
+import { VRMHumanoid } from './humanoid';
+import { VRMLookAtHead } from './lookat';
+import { VRMMeta } from './meta/VRMMeta';
+import { VRMSpringBoneManager } from './springbone';
+import { VRMImporterOptions } from './VRMImporter';
+/**
+ * Parameters for a [[VRM]] class.
+ */
+export interface VRMParameters {
+    scene: THREE.Scene | THREE.Group;
+    humanoid?: VRMHumanoid;
+    blendShapeProxy?: VRMBlendShapeProxy;
+    firstPerson?: VRMFirstPerson;
+    lookAt?: VRMLookAtHead;
+    materials?: THREE.Material[];
+    springBoneManager?: VRMSpringBoneManager;
+    meta?: VRMMeta;
+}
+/**
+ * A class that represents a single VRM model.
+ * See the documentation of [[VRM.from]] for the most basic use of VRM.
+ */
+export declare class VRM {
+    /**
+     * Create a new VRM from a parsed result of GLTF taken from GLTFLoader.
+     * It's probably a thing what you want to get started with VRMs.
+     *
+     * @example Most basic use of VRM
+     * ```
+     * const scene = new THREE.Scene();
+     *
+     * new THREE.GLTFLoader().load( 'models/three-vrm-girl.vrm', ( gltf ) => {
+     *
+     *   THREE.VRM.from( gltf ).then( ( vrm ) => {
+     *
+     *     scene.add( vrm.scene );
+     *
+     *   } );
+     *
+     * } );
+     * ```
+     *
+     * @param gltf A parsed GLTF object taken from GLTFLoader
+     * @param options Options that will be used in importer
+     */
+    static from(gltf: GLTF, options?: VRMImporterOptions): Promise<VRM>;
+    /**
+     * `THREE.Scene` or `THREE.Group` (depends on your three.js revision) that contains the entire VRM.
+     */
+    readonly scene: THREE.Scene | THREE.Group;
+    /**
+     * Contains [[VRMHumanoid]] of the VRM.
+     * You can control each bones using [[VRMHumanoid.getBoneNode]].
+     *
+     * @TODO Add a link to VRM spec
+     */
+    readonly humanoid?: VRMHumanoid;
+    /**
+     * Contains [[VRMBlendShapeProxy]] of the VRM.
+     * You might want to control these facial expressions via [[VRMBlendShapeProxy.setValue]].
+     */
+    readonly blendShapeProxy?: VRMBlendShapeProxy;
+    /**
+     * Contains [[VRMFirstPerson]] of the VRM.
+     * You can use various feature of the firstPerson field.
+     */
+    readonly firstPerson?: VRMFirstPerson;
+    /**
+     * Contains [[VRMLookAtHead]] of the VRM.
+     * You might want to use [[VRMLookAtHead.target]] to control the eye direction of your VRMs.
+     */
+    readonly lookAt?: VRMLookAtHead;
+    /**
+     * Contains materials of the VRM.
+     * `updateVRMMaterials` method of these materials will be called via its [[VRM.update]] method.
+     */
+    readonly materials?: THREE.Material[];
+    /**
+     * Contains meta fields of the VRM.
+     * You might want to refer these license fields before use your VRMs.
+     */
+    readonly meta?: VRMMeta;
+    /**
+     * A [[VRMSpringBoneManager]] manipulates all spring bones attached on the VRM.
+     * Usually you don't have to care about this property.
+     */
+    readonly springBoneManager?: VRMSpringBoneManager;
+    /**
+     * Create a new VRM instance.
+     *
+     * @param params [[VRMParameters]] that represents components of the VRM
+     */
+    constructor(params: VRMParameters);
+    /**
+     * **You need to call this on your update loop.**
+     *
+     * This function updates every VRM components.
+     *
+     * @param delta deltaTime
+     */
+    update(delta: number): void;
+    /**
+     * Dispose everything about the VRM instance.
+     */
+    dispose(): void;
+}

package/types/VRMImporter.d.ts

@@ -1,42 +1,42 @@
-import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
-import { VRMBlendShapeImporter } from './blendshape';
-import { VRMFirstPersonImporter } from './firstperson';
-import { VRMHumanoidImporter } from './humanoid/VRMHumanoidImporter';
-import { VRMLookAtImporter } from './lookat/VRMLookAtImporter';
-import { VRMMaterialImporter } from './material';
-import { VRMMetaImporter } from './meta/VRMMetaImporter';
-import { VRMSpringBoneImporter } from './springbone/VRMSpringBoneImporter';
-import { VRM } from './VRM';
-export interface VRMImporterOptions {
-    metaImporter?: VRMMetaImporter;
-    lookAtImporter?: VRMLookAtImporter;
-    humanoidImporter?: VRMHumanoidImporter;
-    blendShapeImporter?: VRMBlendShapeImporter;
-    firstPersonImporter?: VRMFirstPersonImporter;
-    materialImporter?: VRMMaterialImporter;
-    springBoneImporter?: VRMSpringBoneImporter;
-}
-/**
- * An importer that imports a [[VRM]] from a VRM extension of a GLTF.
- */
-export declare class VRMImporter {
-    protected readonly _metaImporter: VRMMetaImporter;
-    protected readonly _blendShapeImporter: VRMBlendShapeImporter;
-    protected readonly _lookAtImporter: VRMLookAtImporter;
-    protected readonly _humanoidImporter: VRMHumanoidImporter;
-    protected readonly _firstPersonImporter: VRMFirstPersonImporter;
-    protected readonly _materialImporter: VRMMaterialImporter;
-    protected readonly _springBoneImporter: VRMSpringBoneImporter;
-    /**
-     * Create a new VRMImporter.
-     *
-     * @param options [[VRMImporterOptions]], optionally contains importers for each component
-     */
-    constructor(options?: VRMImporterOptions);
-    /**
-     * Receive a GLTF object retrieved from `THREE.GLTFLoader` and create a new [[VRM]] instance.
-     *
-     * @param gltf A parsed result of GLTF taken from GLTFLoader
-     */
-    import(gltf: GLTF): Promise<VRM>;
-}
+import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
+import { VRMBlendShapeImporter } from './blendshape';
+import { VRMFirstPersonImporter } from './firstperson';
+import { VRMHumanoidImporter } from './humanoid/VRMHumanoidImporter';
+import { VRMLookAtImporter } from './lookat/VRMLookAtImporter';
+import { VRMMaterialImporter } from './material';
+import { VRMMetaImporter } from './meta/VRMMetaImporter';
+import { VRMSpringBoneImporter } from './springbone/VRMSpringBoneImporter';
+import { VRM } from './VRM';
+export interface VRMImporterOptions {
+    metaImporter?: VRMMetaImporter;
+    lookAtImporter?: VRMLookAtImporter;
+    humanoidImporter?: VRMHumanoidImporter;
+    blendShapeImporter?: VRMBlendShapeImporter;
+    firstPersonImporter?: VRMFirstPersonImporter;
+    materialImporter?: VRMMaterialImporter;
+    springBoneImporter?: VRMSpringBoneImporter;
+}
+/**
+ * An importer that imports a [[VRM]] from a VRM extension of a GLTF.
+ */
+export declare class VRMImporter {
+    protected readonly _metaImporter: VRMMetaImporter;
+    protected readonly _blendShapeImporter: VRMBlendShapeImporter;
+    protected readonly _lookAtImporter: VRMLookAtImporter;
+    protected readonly _humanoidImporter: VRMHumanoidImporter;
+    protected readonly _firstPersonImporter: VRMFirstPersonImporter;
+    protected readonly _materialImporter: VRMMaterialImporter;
+    protected readonly _springBoneImporter: VRMSpringBoneImporter;
+    /**
+     * Create a new VRMImporter.
+     *
+     * @param options [[VRMImporterOptions]], optionally contains importers for each component
+     */
+    constructor(options?: VRMImporterOptions);
+    /**
+     * Receive a GLTF object retrieved from `THREE.GLTFLoader` and create a new [[VRM]] instance.
+     *
+     * @param gltf A parsed result of GLTF taken from GLTFLoader
+     */
+    import(gltf: GLTF): Promise<VRM>;
+}

package/types/VRMUtils/extractThumbnailBlob.d.ts

@@ -1,10 +1,10 @@
-import * as THREE from 'three';
-import { VRM } from '../VRM';
-/**
- * Extract a thumbnail image blob from a {@link VRM}.
- * If the vrm does not have a thumbnail, it will throw an error.
- * @param renderer Renderer
- * @param vrm VRM with a thumbnail
- * @param size width / height of the image
- */
-export declare function extractThumbnailBlob(renderer: THREE.WebGLRenderer, vrm: VRM, size?: number): Promise<Blob>;
+import * as THREE from 'three';
+import { VRM } from '../VRM';
+/**
+ * Extract a thumbnail image blob from a {@link VRM}.
+ * If the vrm does not have a thumbnail, it will throw an error.
+ * @param renderer Renderer
+ * @param vrm VRM with a thumbnail
+ * @param size width / height of the image
+ */
+export declare function extractThumbnailBlob(renderer: THREE.WebGLRenderer, vrm: VRM, size?: number): Promise<Blob>;

package/types/VRMUtils/index.d.ts

@@ -1,7 +1,9 @@
-import { extractThumbnailBlob } from './extractThumbnailBlob';
-import { removeUnnecessaryJoints } from './removeUnnecessaryJoints';
-export declare class VRMUtils {
-    private constructor();
-    static extractThumbnailBlob: typeof extractThumbnailBlob;
-    static removeUnnecessaryJoints: typeof removeUnnecessaryJoints;
-}
+import { extractThumbnailBlob } from './extractThumbnailBlob';
+import { removeUnnecessaryJoints } from './removeUnnecessaryJoints';
+import { removeUnnecessaryVertices } from './removeUnnecessaryVertices';
+export declare class VRMUtils {
+    private constructor();
+    static extractThumbnailBlob: typeof extractThumbnailBlob;
+    static removeUnnecessaryJoints: typeof removeUnnecessaryJoints;
+    static removeUnnecessaryVertices: typeof removeUnnecessaryVertices;
+}

package/types/VRMUtils/removeUnnecessaryJoints.d.ts

@@ -1,9 +1,9 @@
-import * as THREE from 'three';
-/**
- * Traverse given object and remove unnecessarily bound joints from every `THREE.SkinnedMesh`.
- * Some environments like mobile devices have a lower limit of bones and might be unable to perform mesh skinning, this function might resolve such an issue.
- * Also this function might greatly improve the performance of mesh skinning.
- *
- * @param root Root object that will be traversed
- */
-export declare function removeUnnecessaryJoints(root: THREE.Object3D): void;
+import * as THREE from 'three';
+/**
+ * Traverse given object and remove unnecessarily bound joints from every `THREE.SkinnedMesh`.
+ * Some environments like mobile devices have a lower limit of bones and might be unable to perform mesh skinning, this function might resolve such an issue.
+ * Also this function might greatly improve the performance of mesh skinning.
+ *
+ * @param root Root object that will be traversed
+ */
+export declare function removeUnnecessaryJoints(root: THREE.Object3D): void;

package/types/VRMUtils/removeUnnecessaryVertices.d.ts

@@ -0,0 +1,12 @@
+import * as THREE from 'three';
+/**
+ * Traverse given object and remove unnecessary vertices from every BufferGeometries.
+ * This only processes buffer geometries with index buffer.
+ *
+ * Three.js creates morph textures for each geometries and it sometimes consumes unnecessary amount of VRAM for certain models.
+ * This function will optimize geometries to reduce the size of morph texture.
+ * See: https://github.com/mrdoob/three.js/issues/23095
+ *
+ * @param root Root object that will be traversed
+ */
+export declare function removeUnnecessaryVertices(root: THREE.Object3D): void;

package/types/blendshape/VRMBlendShapeGroup.d.ts

@@ -1,50 +1,50 @@
-import * as THREE from 'three';
-import { GLTFPrimitive } from '../types';
-export interface VRMBlendShapeBind {
-    meshes: GLTFPrimitive[];
-    morphTargetIndex: number;
-    weight: number;
-}
-declare enum VRMBlendShapeMaterialValueType {
-    NUMBER = 0,
-    VECTOR2 = 1,
-    VECTOR3 = 2,
-    VECTOR4 = 3,
-    COLOR = 4
-}
-export interface VRMBlendShapeMaterialValue {
-    material: THREE.Material;
-    propertyName: string;
-    defaultValue: number | THREE.Vector2 | THREE.Vector3 | THREE.Vector4 | THREE.Color;
-    targetValue: number | THREE.Vector2 | THREE.Vector3 | THREE.Vector4 | THREE.Color;
-    deltaValue: number | THREE.Vector2 | THREE.Vector3 | THREE.Vector4 | THREE.Color;
-    type: VRMBlendShapeMaterialValueType;
-}
-export declare class VRMBlendShapeGroup extends THREE.Object3D {
-    weight: number;
-    isBinary: boolean;
-    private _binds;
-    private _materialValues;
-    constructor(expressionName: string);
-    addBind(args: {
-        meshes: GLTFPrimitive[];
-        morphTargetIndex: number;
-        weight: number;
-    }): void;
-    addMaterialValue(args: {
-        material: THREE.Material;
-        propertyName: string;
-        targetValue: number[];
-        defaultValue?: number | THREE.Vector2 | THREE.Vector3 | THREE.Vector4 | THREE.Color;
-    }): void;
-    /**
-     * Apply weight to every assigned blend shapes.
-     * Should be called via {@link BlendShapeMaster#update}.
-     */
-    applyWeight(): void;
-    /**
-     * Clear previously assigned blend shapes.
-     */
-    clearAppliedWeight(): void;
-}
-export {};
+import * as THREE from 'three';
+import { GLTFPrimitive } from '../types';
+export interface VRMBlendShapeBind {
+    meshes: GLTFPrimitive[];
+    morphTargetIndex: number;
+    weight: number;
+}
+declare enum VRMBlendShapeMaterialValueType {
+    NUMBER = 0,
+    VECTOR2 = 1,
+    VECTOR3 = 2,
+    VECTOR4 = 3,
+    COLOR = 4
+}
+export interface VRMBlendShapeMaterialValue {
+    material: THREE.Material;
+    propertyName: string;
+    defaultValue: number | THREE.Vector2 | THREE.Vector3 | THREE.Vector4 | THREE.Color;
+    targetValue: number | THREE.Vector2 | THREE.Vector3 | THREE.Vector4 | THREE.Color;
+    deltaValue: number | THREE.Vector2 | THREE.Vector3 | THREE.Vector4 | THREE.Color;
+    type: VRMBlendShapeMaterialValueType;
+}
+export declare class VRMBlendShapeGroup extends THREE.Object3D {
+    weight: number;
+    isBinary: boolean;
+    private _binds;
+    private _materialValues;
+    constructor(expressionName: string);
+    addBind(args: {
+        meshes: GLTFPrimitive[];
+        morphTargetIndex: number;
+        weight: number;
+    }): void;
+    addMaterialValue(args: {
+        material: THREE.Material;
+        propertyName: string;
+        targetValue: number[];
+        defaultValue?: number | THREE.Vector2 | THREE.Vector3 | THREE.Vector4 | THREE.Color;
+    }): void;
+    /**
+     * Apply weight to every assigned blend shapes.
+     * Should be called via {@link BlendShapeMaster#update}.
+     */
+    applyWeight(): void;
+    /**
+     * Clear previously assigned blend shapes.
+     */
+    clearAppliedWeight(): void;
+}
+export {};

package/types/blendshape/VRMBlendShapeImporter.d.ts

@@ -1,13 +1,13 @@
-import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
-import { VRMBlendShapeProxy } from './VRMBlendShapeProxy';
-/**
- * An importer that imports a [[VRMBlendShape]] from a VRM extension of a GLTF.
- */
-export declare class VRMBlendShapeImporter {
-    /**
-     * Import a [[VRMBlendShape]] from a VRM.
-     *
-     * @param gltf A parsed result of GLTF taken from GLTFLoader
-     */
-    import(gltf: GLTF): Promise<VRMBlendShapeProxy | null>;
-}
+import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
+import { VRMBlendShapeProxy } from './VRMBlendShapeProxy';
+/**
+ * An importer that imports a [[VRMBlendShape]] from a VRM extension of a GLTF.
+ */
+export declare class VRMBlendShapeImporter {
+    /**
+     * Import a [[VRMBlendShape]] from a VRM.
+     *
+     * @param gltf A parsed result of GLTF taken from GLTFLoader
+     */
+    import(gltf: GLTF): Promise<VRMBlendShapeProxy | null>;
+}