@pixiv/three-vrm-core 1.0.0-beta.9 → 1.0.1

package/types/VRMCoreParameters.d.ts

@@ -1,16 +1,16 @@
-import type { VRMExpressionManager } from './expressions/VRMExpressionManager';
-import type { VRMFirstPerson } from './firstPerson/VRMFirstPerson';
-import type { VRMHumanoid } from './humanoid/VRMHumanoid';
-import type { VRMLookAt } from './lookAt/VRMLookAt';
-import type { VRMMeta } from './meta/VRMMeta';
-/**
- * Parameters for a {@link VRMCore} class.
- */
-export interface VRMCoreParameters {
-    scene: THREE.Group;
-    humanoid?: VRMHumanoid;
-    expressionManager?: VRMExpressionManager;
-    firstPerson?: VRMFirstPerson;
-    lookAt?: VRMLookAt;
-    meta?: VRMMeta;
-}
+import type { VRMExpressionManager } from './expressions/VRMExpressionManager';
+import type { VRMFirstPerson } from './firstPerson/VRMFirstPerson';
+import type { VRMHumanoid } from './humanoid/VRMHumanoid';
+import type { VRMLookAt } from './lookAt/VRMLookAt';
+import type { VRMMeta } from './meta/VRMMeta';
+/**
+ * Parameters for a {@link VRMCore} class.
+ */
+export interface VRMCoreParameters {
+    scene: THREE.Group;
+    meta: VRMMeta;
+    humanoid: VRMHumanoid;
+    expressionManager?: VRMExpressionManager;
+    firstPerson?: VRMFirstPerson;
+    lookAt?: VRMLookAt;
+}

package/types/expressions/VRMExpression.d.ts

@@ -1,64 +1,64 @@
-import * as THREE from 'three';
-import { VRMExpressionBind } from './VRMExpressionBind';
-import type { VRMExpressionOverrideType } from './VRMExpressionOverrideType';
-export declare class VRMExpression extends THREE.Object3D {
-    /**
-     * Name of this expression.
-     * Distinguished with `name` since `name` will be conflicted with Object3D.
-     */
-    expressionName: string;
-    /**
-     * The current weight of the expression.
-     */
-    weight: number;
-    /**
-     * Interpret non-zero values as 1.
-     */
-    isBinary: boolean;
-    /**
-     * Specify how the expression overrides blink expressions.
-     */
-    overrideBlink: VRMExpressionOverrideType;
-    /**
-     * Specify how the expression overrides lookAt expressions.
-     */
-    overrideLookAt: VRMExpressionOverrideType;
-    /**
-     * Specify how the expression overrides mouth expressions.
-     */
-    overrideMouth: VRMExpressionOverrideType;
-    private _binds;
-    /**
-     * A value represents how much it should override blink expressions.
-     * `0.0` == no override at all, `1.0` == completely block the expressions.
-     */
-    get overrideBlinkAmount(): number;
-    /**
-     * A value represents how much it should override lookAt expressions.
-     * `0.0` == no override at all, `1.0` == completely block the expressions.
-     */
-    get overrideLookAtAmount(): number;
-    /**
-     * A value represents how much it should override mouth expressions.
-     * `0.0` == no override at all, `1.0` == completely block the expressions.
-     */
-    get overrideMouthAmount(): number;
-    constructor(expressionName: string);
-    addBind(bind: VRMExpressionBind): void;
-    /**
-     * Apply weight to every assigned blend shapes.
-     * Should be called every frame.
-     */
-    applyWeight(options?: {
-        /**
-         * Multiplies a value to its weight to apply.
-         * Intended to be used for overriding an expression weight by another expression.
-         * See also: {@link overrideBlink}, {@link overrideLookAt}, {@link overrideMouth}
-         */
-        multiplier?: number;
-    }): void;
-    /**
-     * Clear previously assigned blend shapes.
-     */
-    clearAppliedWeight(): void;
-}
+import * as THREE from 'three';
+import { VRMExpressionBind } from './VRMExpressionBind';
+import type { VRMExpressionOverrideType } from './VRMExpressionOverrideType';
+export declare class VRMExpression extends THREE.Object3D {
+    /**
+     * Name of this expression.
+     * Distinguished with `name` since `name` will be conflicted with Object3D.
+     */
+    expressionName: string;
+    /**
+     * The current weight of the expression.
+     */
+    weight: number;
+    /**
+     * Interpret values greater than 0.5 as 1.0, ortherwise 0.0.
+     */
+    isBinary: boolean;
+    /**
+     * Specify how the expression overrides blink expressions.
+     */
+    overrideBlink: VRMExpressionOverrideType;
+    /**
+     * Specify how the expression overrides lookAt expressions.
+     */
+    overrideLookAt: VRMExpressionOverrideType;
+    /**
+     * Specify how the expression overrides mouth expressions.
+     */
+    overrideMouth: VRMExpressionOverrideType;
+    private _binds;
+    /**
+     * A value represents how much it should override blink expressions.
+     * `0.0` == no override at all, `1.0` == completely block the expressions.
+     */
+    get overrideBlinkAmount(): number;
+    /**
+     * A value represents how much it should override lookAt expressions.
+     * `0.0` == no override at all, `1.0` == completely block the expressions.
+     */
+    get overrideLookAtAmount(): number;
+    /**
+     * A value represents how much it should override mouth expressions.
+     * `0.0` == no override at all, `1.0` == completely block the expressions.
+     */
+    get overrideMouthAmount(): number;
+    constructor(expressionName: string);
+    addBind(bind: VRMExpressionBind): void;
+    /**
+     * Apply weight to every assigned blend shapes.
+     * Should be called every frame.
+     */
+    applyWeight(options?: {
+        /**
+         * Multiplies a value to its weight to apply.
+         * Intended to be used for overriding an expression weight by another expression.
+         * See also: {@link overrideBlink}, {@link overrideLookAt}, {@link overrideMouth}
+         */
+        multiplier?: number;
+    }): void;
+    /**
+     * Clear previously assigned blend shapes.
+     */
+    clearAppliedWeight(): void;
+}

package/types/expressions/VRMExpressionBind.d.ts

@@ -1,11 +1,11 @@
-export interface VRMExpressionBind {
-    /**
-     * Apply a weight to this bind.
-     * Applied weights will be accumulated until {@link clearAppliedWeight} is called.
-     */
-    applyWeight(weight: number): void;
-    /**
-     * Clear previously applied weights.
-     */
-    clearAppliedWeight(): void;
-}
+export interface VRMExpressionBind {
+    /**
+     * Apply a weight to this bind.
+     * Applied weights will be accumulated until {@link clearAppliedWeight} is called.
+     */
+    applyWeight(weight: number): void;
+    /**
+     * Clear previously applied weights.
+     */
+    clearAppliedWeight(): void;
+}

package/types/expressions/VRMExpressionLoaderPlugin.d.ts

@@ -1,23 +1,23 @@
-import type * as V0VRM from '@pixiv/types-vrm-0.0';
-import { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
-import { VRMExpressionPresetName } from './VRMExpressionPresetName';
-/**
- * A plugin of GLTFLoader that imports a {@link VRMExpressionManager} from a VRM extension of a GLTF.
- */
-export declare class VRMExpressionLoaderPlugin implements GLTFLoaderPlugin {
-    static readonly v0v1PresetNameMap: {
-        [v0Name in V0VRM.BlendShapePresetName]?: VRMExpressionPresetName;
-    };
-    readonly parser: GLTFParser;
-    get name(): string;
-    constructor(parser: GLTFParser);
-    afterRoot(gltf: GLTF): Promise<void>;
-    /**
-     * Import a {@link VRMExpressionManager} from a VRM.
-     *
-     * @param gltf A parsed result of GLTF taken from GLTFLoader
-     */
-    private _import;
-    private _v1Import;
-    private _v0Import;
-}
+import type * as V0VRM from '@pixiv/types-vrm-0.0';
+import { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
+import { VRMExpressionPresetName } from './VRMExpressionPresetName';
+/**
+ * A plugin of GLTFLoader that imports a {@link VRMExpressionManager} from a VRM extension of a GLTF.
+ */
+export declare class VRMExpressionLoaderPlugin implements GLTFLoaderPlugin {
+    static readonly v0v1PresetNameMap: {
+        [v0Name in V0VRM.BlendShapePresetName]?: VRMExpressionPresetName;
+    };
+    readonly parser: GLTFParser;
+    get name(): string;
+    constructor(parser: GLTFParser);
+    afterRoot(gltf: GLTF): Promise<void>;
+    /**
+     * Import a {@link VRMExpressionManager} from a VRM.
+     *
+     * @param gltf A parsed result of GLTF taken from GLTFLoader
+     */
+    private _import;
+    private _v1Import;
+    private _v0Import;
+}

package/types/expressions/VRMExpressionManager.d.ts

@@ -1,124 +1,124 @@
-import { VRMExpressionPresetName } from './VRMExpressionPresetName';
-import type { VRMExpression } from './VRMExpression';
-export declare class VRMExpressionManager {
-    /**
-     * A set of name or preset name of expressions that will be overridden by {@link VRMExpression.overrideBlink}.
-     */
-    blinkExpressionNames: string[];
-    /**
-     * A set of name or preset name of expressions that will be overridden by {@link VRMExpression.overrideLookAt}.
-     */
-    lookAtExpressionNames: string[];
-    /**
-     * A set of name or preset name of expressions that will be overridden by {@link VRMExpression.overrideMouth}.
-     */
-    mouthExpressionNames: string[];
-    /**
-     * A set of {@link VRMExpression}.
-     * When you want to register expressions, use {@link registerExpression}
-     */
-    private _expressions;
-    get expressions(): VRMExpression[];
-    /**
-     * A map from name to expression.
-     */
-    private _expressionMap;
-    get expressionMap(): {
-        [name: string]: VRMExpression;
-    };
-    /**
-     * A map from name to expression, but excluding custom expressions.
-     */
-    get presetExpressionMap(): {
-        [name in VRMExpressionPresetName]?: VRMExpression;
-    };
-    /**
-     * A map from name to expression, but excluding preset expressions.
-     */
-    get customExpressionMap(): {
-        [name: string]: VRMExpression;
-    };
-    /**
-     * Create a new {@link VRMExpressionManager}.
-     */
-    constructor();
-    /**
-     * Copy the given {@link VRMExpressionManager} into this one.
-     * @param source The {@link VRMExpressionManager} you want to copy
-     * @returns this
-     */
-    copy(source: VRMExpressionManager): this;
-    /**
-     * Returns a clone of this {@link VRMExpressionManager}.
-     * @returns Copied {@link VRMExpressionManager}
-     */
-    clone(): VRMExpressionManager;
-    /**
-     * Return a registered expression.
-     * If it cannot find an expression, it will return `null` instead.
-     *
-     * @param name Name or preset name of the expression
-     */
-    getExpression(name: VRMExpressionPresetName | string): VRMExpression | null;
-    /**
-     * Register an expression.
-     *
-     * @param expression {@link VRMExpression} that describes the expression
-     */
-    registerExpression(expression: VRMExpression): void;
-    /**
-     * Unregister an expression.
-     *
-     * @param expression The expression you want to unregister
-     */
-    unregisterExpression(expression: VRMExpression): void;
-    /**
-     * Get the current weight of the specified expression.
-     * If it doesn't have an expression of given name, it will return `null` instead.
-     *
-     * @param name Name of the expression
-     */
-    getValue(name: VRMExpressionPresetName | string): number | null;
-    /**
-     * Set a weight to the specified expression.
-     *
-     * @param name Name of the expression
-     * @param weight Weight
-     */
-    setValue(name: VRMExpressionPresetName | string, weight: number): void;
-    /**
-     * Get a track name of specified expression.
-     * This track name is needed to manipulate its expression via keyframe animations.
-     *
-     * @example Manipulate an expression using keyframe animation
-     * ```js
-     * const trackName = vrm.expressionManager.getExpressionTrackName( 'blink' );
-     * const track = new THREE.NumberKeyframeTrack(
-     *   name,
-     *   [ 0.0, 0.5, 1.0 ], // times
-     *   [ 0.0, 1.0, 0.0 ] // values
-     * );
-     *
-     * const clip = new THREE.AnimationClip(
-     *   'blink', // name
-     *   1.0, // duration
-     *   [ track ] // tracks
-     * );
-     *
-     * const mixer = new THREE.AnimationMixer( vrm.scene );
-     * const action = mixer.clipAction( clip );
-     * action.play();
-     * ```
-     *
-     * @param name Name of the expression
-     */
-    getExpressionTrackName(name: VRMExpressionPresetName | string): string | null;
-    /**
-     * Update every expressions.
-     */
-    update(): void;
-    /**
-     * Calculate sum of override amounts to see how much we should multiply weights of certain expressions.
-     */
-    private _calculateWeightMultipliers;
-}
+import { VRMExpressionPresetName } from './VRMExpressionPresetName';
+import type { VRMExpression } from './VRMExpression';
+export declare class VRMExpressionManager {
+    /**
+     * A set of name or preset name of expressions that will be overridden by {@link VRMExpression.overrideBlink}.
+     */
+    blinkExpressionNames: string[];
+    /**
+     * A set of name or preset name of expressions that will be overridden by {@link VRMExpression.overrideLookAt}.
+     */
+    lookAtExpressionNames: string[];
+    /**
+     * A set of name or preset name of expressions that will be overridden by {@link VRMExpression.overrideMouth}.
+     */
+    mouthExpressionNames: string[];
+    /**
+     * A set of {@link VRMExpression}.
+     * When you want to register expressions, use {@link registerExpression}
+     */
+    private _expressions;
+    get expressions(): VRMExpression[];
+    /**
+     * A map from name to expression.
+     */
+    private _expressionMap;
+    get expressionMap(): {
+        [name: string]: VRMExpression;
+    };
+    /**
+     * A map from name to expression, but excluding custom expressions.
+     */
+    get presetExpressionMap(): {
+        [name in VRMExpressionPresetName]?: VRMExpression;
+    };
+    /**
+     * A map from name to expression, but excluding preset expressions.
+     */
+    get customExpressionMap(): {
+        [name: string]: VRMExpression;
+    };
+    /**
+     * Create a new {@link VRMExpressionManager}.
+     */
+    constructor();
+    /**
+     * Copy the given {@link VRMExpressionManager} into this one.
+     * @param source The {@link VRMExpressionManager} you want to copy
+     * @returns this
+     */
+    copy(source: VRMExpressionManager): this;
+    /**
+     * Returns a clone of this {@link VRMExpressionManager}.
+     * @returns Copied {@link VRMExpressionManager}
+     */
+    clone(): VRMExpressionManager;
+    /**
+     * Return a registered expression.
+     * If it cannot find an expression, it will return `null` instead.
+     *
+     * @param name Name or preset name of the expression
+     */
+    getExpression(name: VRMExpressionPresetName | string): VRMExpression | null;
+    /**
+     * Register an expression.
+     *
+     * @param expression {@link VRMExpression} that describes the expression
+     */
+    registerExpression(expression: VRMExpression): void;
+    /**
+     * Unregister an expression.
+     *
+     * @param expression The expression you want to unregister
+     */
+    unregisterExpression(expression: VRMExpression): void;
+    /**
+     * Get the current weight of the specified expression.
+     * If it doesn't have an expression of given name, it will return `null` instead.
+     *
+     * @param name Name of the expression
+     */
+    getValue(name: VRMExpressionPresetName | string): number | null;
+    /**
+     * Set a weight to the specified expression.
+     *
+     * @param name Name of the expression
+     * @param weight Weight
+     */
+    setValue(name: VRMExpressionPresetName | string, weight: number): void;
+    /**
+     * Get a track name of specified expression.
+     * This track name is needed to manipulate its expression via keyframe animations.
+     *
+     * @example Manipulate an expression using keyframe animation
+     * ```js
+     * const trackName = vrm.expressionManager.getExpressionTrackName( 'blink' );
+     * const track = new THREE.NumberKeyframeTrack(
+     *   name,
+     *   [ 0.0, 0.5, 1.0 ], // times
+     *   [ 0.0, 1.0, 0.0 ] // values
+     * );
+     *
+     * const clip = new THREE.AnimationClip(
+     *   'blink', // name
+     *   1.0, // duration
+     *   [ track ] // tracks
+     * );
+     *
+     * const mixer = new THREE.AnimationMixer( vrm.scene );
+     * const action = mixer.clipAction( clip );
+     * action.play();
+     * ```
+     *
+     * @param name Name of the expression
+     */
+    getExpressionTrackName(name: VRMExpressionPresetName | string): string | null;
+    /**
+     * Update every expressions.
+     */
+    update(): void;
+    /**
+     * Calculate sum of override amounts to see how much we should multiply weights of certain expressions.
+     */
+    private _calculateWeightMultipliers;
+}

package/types/expressions/VRMExpressionMaterialColorBind.d.ts

@@ -1,42 +1,45 @@
-import * as THREE from 'three';
-import type { VRMExpressionBind } from './VRMExpressionBind';
-import type { VRMExpressionMaterialColorType } from './VRMExpressionMaterialColorType';
-/**
- * A bind of expression influences to a material color.
- */
-export declare class VRMExpressionMaterialColorBind implements VRMExpressionBind {
-    private static _propertyNameMapMap;
-    /**
-     * The target material.
-     */
-    readonly material: THREE.Material;
-    /**
-     * The type of the target property of the material.
-     */
-    readonly type: VRMExpressionMaterialColorType;
-    /**
-     * The target color.
-     */
-    readonly targetValue: THREE.Color;
-    /**
-     * Its state.
-     * If it cannot find the target property in constructor, it will be null instead.
-     */
-    private _state;
-    constructor({ material, type, targetValue, }: {
-        /**
-         * The target material.
-         */
-        material: THREE.Material;
-        /**
-         * The type of the target property of the material.
-         */
-        type: VRMExpressionMaterialColorType;
-        /**
-         * The target color.
-         */
-        targetValue: THREE.Color;
-    });
-    applyWeight(weight: number): void;
-    clearAppliedWeight(): void;
-}
+import * as THREE from 'three';
+import type { VRMExpressionBind } from './VRMExpressionBind';
+import type { VRMExpressionMaterialColorType } from './VRMExpressionMaterialColorType';
+/**
+ * A bind of expression influences to a material color.
+ */
+export declare class VRMExpressionMaterialColorBind implements VRMExpressionBind {
+    /**
+     * Mapping of property names from VRMC/materialColorBinds.type to three.js/Material.
+     */
+    private static _propertyNameMapMap;
+    /**
+     * The target material.
+     */
+    readonly material: THREE.Material;
+    /**
+     * The type of the target property of the material.
+     */
+    readonly type: VRMExpressionMaterialColorType;
+    /**
+     * The target color.
+     */
+    readonly targetValue: THREE.Color;
+    /**
+     * Its state.
+     * If it cannot find the target property in constructor, it will be null instead.
+     */
+    private _state;
+    constructor({ material, type, targetValue, }: {
+        /**
+         * The target material.
+         */
+        material: THREE.Material;
+        /**
+         * The type of the target property of the material.
+         */
+        type: VRMExpressionMaterialColorType;
+        /**
+         * The target color.
+         */
+        targetValue: THREE.Color;
+    });
+    applyWeight(weight: number): void;
+    clearAppliedWeight(): void;
+}

package/types/expressions/VRMExpressionMaterialColorType.d.ts

@@ -1,8 +1,12 @@
-export declare const VRMExpressionMaterialColorType: {
-    readonly Color: "color";
-    readonly EmissionColor: "emissionColor";
-    readonly ShadeColor: "shadeColor";
-    readonly RimColor: "rimColor";
-    readonly OutlineColor: "outlineColor";
-};
-export declare type VRMExpressionMaterialColorType = typeof VRMExpressionMaterialColorType[keyof typeof VRMExpressionMaterialColorType];
+export declare const VRMExpressionMaterialColorType: {
+    readonly Color: "color";
+    readonly EmissionColor: "emissionColor";
+    readonly ShadeColor: "shadeColor";
+    readonly MatcapColor: "matcapColor";
+    readonly RimColor: "rimColor";
+    readonly OutlineColor: "outlineColor";
+};
+export declare type VRMExpressionMaterialColorType = typeof VRMExpressionMaterialColorType[keyof typeof VRMExpressionMaterialColorType];
+export declare const v0ExpressionMaterialColorMap: {
+    [key: string]: VRMExpressionMaterialColorType | undefined;
+};

package/types/expressions/VRMExpressionMorphTargetBind.d.ts

@@ -1,35 +1,35 @@
-import type * as THREE from 'three';
-import type { VRMExpressionBind } from './VRMExpressionBind';
-/**
- * A bind of {@link VRMExpression} influences to morph targets.
- */
-export declare class VRMExpressionMorphTargetBind implements VRMExpressionBind {
-    /**
-     * The mesh primitives that attached to target mesh.
-     */
-    readonly primitives: THREE.Mesh[];
-    /**
-     * The index of the morph target in the mesh.
-     */
-    readonly index: number;
-    /**
-     * The weight value of target morph target. Ranging in [0.0 - 1.0].
-     */
-    readonly weight: number;
-    constructor({ primitives, index, weight, }: {
-        /**
-         * The mesh primitives that attached to target mesh.
-         */
-        primitives: THREE.Mesh[];
-        /**
-         * The index of the morph target in the mesh.
-         */
-        index: number;
-        /**
-         * The weight value of target morph target. Ranging in [0.0 - 1.0].
-         */
-        weight: number;
-    });
-    applyWeight(weight: number): void;
-    clearAppliedWeight(): void;
-}
+import type * as THREE from 'three';
+import type { VRMExpressionBind } from './VRMExpressionBind';
+/**
+ * A bind of {@link VRMExpression} influences to morph targets.
+ */
+export declare class VRMExpressionMorphTargetBind implements VRMExpressionBind {
+    /**
+     * The mesh primitives that attached to target mesh.
+     */
+    readonly primitives: THREE.Mesh[];
+    /**
+     * The index of the morph target in the mesh.
+     */
+    readonly index: number;
+    /**
+     * The weight value of target morph target. Ranging in [0.0 - 1.0].
+     */
+    readonly weight: number;
+    constructor({ primitives, index, weight, }: {
+        /**
+         * The mesh primitives that attached to target mesh.
+         */
+        primitives: THREE.Mesh[];
+        /**
+         * The index of the morph target in the mesh.
+         */
+        index: number;
+        /**
+         * The weight value of target morph target. Ranging in [0.0 - 1.0].
+         */
+        weight: number;
+    });
+    applyWeight(weight: number): void;
+    clearAppliedWeight(): void;
+}