@pixiv/three-vrm 0.6.4 → 0.6.8

package/types/material/VRMMaterialImporter.d.ts

@@ -1,50 +1,50 @@
-import * as THREE from 'three';
-import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
-import { VRMSchema } from '../types';
-/**
- * Options for a [[VRMMaterialImporter]] instance.
- */
-export interface VRMMaterialImporterOptions {
-    /**
-     * Specify the encoding of input uniform colors and textures.
-     *
-     * When your `renderer.outputEncoding` is `THREE.LinearEncoding`, use `THREE.LinearEncoding`.
-     * When your `renderer.outputEncoding` is `THREE.sRGBEncoding`, use `THREE.sRGBEncoding`.
-     *
-     * The importer will use `THREE.LinearEncoding` if this option isn't specified.
-     *
-     * See also: https://threejs.org/docs/#api/en/renderers/WebGLRenderer.outputEncoding
-     */
-    encoding?: THREE.TextureEncoding;
-    /**
-     * A function that returns a `Promise` of environment map texture.
-     * The importer will attempt to call this function when it have to use an envmap.
-     */
-    requestEnvMap?: () => Promise<THREE.Texture | null>;
-}
-/**
- * An importer that imports VRM materials from a VRM extension of a GLTF.
- */
-export declare class VRMMaterialImporter {
-    private readonly _encoding;
-    private readonly _requestEnvMap?;
-    /**
-     * Create a new VRMMaterialImporter.
-     *
-     * @param options Options of the VRMMaterialImporter
-     */
-    constructor(options?: VRMMaterialImporterOptions);
-    /**
-     * Convert all the materials of given GLTF based on VRM extension field `materialProperties`.
-     *
-     * @param gltf A parsed result of GLTF taken from GLTFLoader
-     */
-    convertGLTFMaterials(gltf: GLTF): Promise<THREE.Material[] | null>;
-    createVRMMaterials(originalMaterial: THREE.Material, vrmProps: VRMSchema.Material, gltf: GLTF): Promise<{
-        surface: THREE.Material;
-        outline?: THREE.Material;
-    }>;
-    private _renameMaterialProperty;
-    private _convertGLTFMaterial;
-    private _extractMaterialProperties;
-}
+import * as THREE from 'three';
+import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
+import { VRMSchema } from '../types';
+/**
+ * Options for a [[VRMMaterialImporter]] instance.
+ */
+export interface VRMMaterialImporterOptions {
+    /**
+     * Specify the encoding of input uniform colors and textures.
+     *
+     * When your `renderer.outputEncoding` is `THREE.LinearEncoding`, use `THREE.LinearEncoding`.
+     * When your `renderer.outputEncoding` is `THREE.sRGBEncoding`, use `THREE.sRGBEncoding`.
+     *
+     * The importer will use `THREE.LinearEncoding` if this option isn't specified.
+     *
+     * See also: https://threejs.org/docs/#api/en/renderers/WebGLRenderer.outputEncoding
+     */
+    encoding?: THREE.TextureEncoding;
+    /**
+     * A function that returns a `Promise` of environment map texture.
+     * The importer will attempt to call this function when it have to use an envmap.
+     */
+    requestEnvMap?: () => Promise<THREE.Texture | null>;
+}
+/**
+ * An importer that imports VRM materials from a VRM extension of a GLTF.
+ */
+export declare class VRMMaterialImporter {
+    private readonly _encoding;
+    private readonly _requestEnvMap?;
+    /**
+     * Create a new VRMMaterialImporter.
+     *
+     * @param options Options of the VRMMaterialImporter
+     */
+    constructor(options?: VRMMaterialImporterOptions);
+    /**
+     * Convert all the materials of given GLTF based on VRM extension field `materialProperties`.
+     *
+     * @param gltf A parsed result of GLTF taken from GLTFLoader
+     */
+    convertGLTFMaterials(gltf: GLTF): Promise<THREE.Material[] | null>;
+    createVRMMaterials(originalMaterial: THREE.Material, vrmProps: VRMSchema.Material, gltf: GLTF): Promise<{
+        surface: THREE.Material;
+        outline?: THREE.Material;
+    }>;
+    private _renameMaterialProperty;
+    private _convertGLTFMaterial;
+    private _extractMaterialProperties;
+}

package/types/material/VRMUnlitMaterial.d.ts

@@ -1,46 +1,46 @@
-import * as THREE from 'three';
-export interface VRMUnlitMaterialParameters extends THREE.ShaderMaterialParameters {
-    cutoff?: number;
-    map?: THREE.Texture;
-    mainTex?: THREE.Texture;
-    mainTex_ST?: THREE.Vector4;
-    renderType?: VRMUnlitMaterialRenderType | number;
-}
-export declare enum VRMUnlitMaterialRenderType {
-    Opaque = 0,
-    Cutout = 1,
-    Transparent = 2,
-    TransparentWithZWrite = 3
-}
-/**
- * This is a material that is an equivalent of "VRM/Unlit***" on VRM spec, those materials are already kinda deprecated though...
- */
-export declare class VRMUnlitMaterial extends THREE.ShaderMaterial {
-    /**
-     * Readonly boolean that indicates this is a [[VRMUnlitMaterial]].
-     */
-    readonly isVRMUnlitMaterial: boolean;
-    cutoff: number;
-    map: THREE.Texture | null;
-    mainTex_ST: THREE.Vector4;
-    private _renderType;
-    shouldApplyUniforms: boolean;
-    constructor(parameters?: VRMUnlitMaterialParameters);
-    get mainTex(): THREE.Texture | null;
-    set mainTex(t: THREE.Texture | null);
-    get renderType(): VRMUnlitMaterialRenderType;
-    set renderType(t: VRMUnlitMaterialRenderType);
-    /**
-     * Update this material.
-     * Usually this will be called via [[VRM.update]] so you don't have to call this manually.
-     *
-     * @param delta deltaTime since last update
-     */
-    updateVRMMaterials(delta: number): void;
-    copy(source: this): this;
-    /**
-     * Apply updated uniform variables.
-     */
-    private _applyUniforms;
-    private _updateShaderCode;
-}
+import * as THREE from 'three';
+export interface VRMUnlitMaterialParameters extends THREE.ShaderMaterialParameters {
+    cutoff?: number;
+    map?: THREE.Texture;
+    mainTex?: THREE.Texture;
+    mainTex_ST?: THREE.Vector4;
+    renderType?: VRMUnlitMaterialRenderType | number;
+}
+export declare enum VRMUnlitMaterialRenderType {
+    Opaque = 0,
+    Cutout = 1,
+    Transparent = 2,
+    TransparentWithZWrite = 3
+}
+/**
+ * This is a material that is an equivalent of "VRM/Unlit***" on VRM spec, those materials are already kinda deprecated though...
+ */
+export declare class VRMUnlitMaterial extends THREE.ShaderMaterial {
+    /**
+     * Readonly boolean that indicates this is a [[VRMUnlitMaterial]].
+     */
+    readonly isVRMUnlitMaterial: boolean;
+    cutoff: number;
+    map: THREE.Texture | null;
+    mainTex_ST: THREE.Vector4;
+    private _renderType;
+    shouldApplyUniforms: boolean;
+    constructor(parameters?: VRMUnlitMaterialParameters);
+    get mainTex(): THREE.Texture | null;
+    set mainTex(t: THREE.Texture | null);
+    get renderType(): VRMUnlitMaterialRenderType;
+    set renderType(t: VRMUnlitMaterialRenderType);
+    /**
+     * Update this material.
+     * Usually this will be called via [[VRM.update]] so you don't have to call this manually.
+     *
+     * @param delta deltaTime since last update
+     */
+    updateVRMMaterials(delta: number): void;
+    copy(source: this): this;
+    /**
+     * Apply updated uniform variables.
+     */
+    private _applyUniforms;
+    private _updateShaderCode;
+}

package/types/material/getTexelDecodingFunction.d.ts

@@ -1,3 +1,9 @@
-import * as THREE from 'three';
-export declare const getEncodingComponents: (encoding: THREE.TextureEncoding) => [string, string];
-export declare const getTexelDecodingFunction: (functionName: string, encoding: THREE.TextureEncoding) => string;
+import * as THREE from 'three';
+/**
+ * Ref: https://github.com/mrdoob/three.js/blob/r136/src/renderers/webgl/WebGLProgram.js#L22
+ */
+export declare const getEncodingComponents: (encoding: THREE.TextureEncoding) => [string, string];
+/**
+ * https://github.com/mrdoob/three.js/blob/r136/src/renderers/webgl/WebGLProgram.js#L52
+ */
+export declare const getTexelDecodingFunction: (functionName: string, encoding: THREE.TextureEncoding) => string;

package/types/material/index.d.ts

@@ -1,3 +1,3 @@
-export * from './MToonMaterial';
-export * from './VRMMaterialImporter';
-export * from './VRMUnlitMaterial';
+export * from './MToonMaterial';
+export * from './VRMMaterialImporter';
+export * from './VRMUnlitMaterial';

package/types/meta/VRMMeta.d.ts

@@ -1,59 +1,59 @@
-import * as THREE from 'three';
-import { VRMSchema } from '../types';
-/**
- * Interface represents metadata of a VRM.
- */
-export interface VRMMeta {
-    /**
-     * Enum indicates a condition who can perform with this avatar.
-     */
-    allowedUserName?: VRMSchema.MetaAllowedUserName;
-    /**
-     * Author of the model.
-     */
-    author?: string;
-    /**
-     * Enum indicates allow or disallow commercial use.
-     */
-    commercialUssageName?: VRMSchema.MetaUssageName;
-    /**
-     * Contact Information of its author.
-     */
-    contactInformation?: string;
-    /**
-     * Enum indicates a license type.
-     */
-    licenseName?: VRMSchema.MetaLicenseName;
-    /**
-     * If `Other` is selected for {@link licenseName}, put the URL link of the license document here.
-     */
-    otherLicenseUrl?: string;
-    /**
-     * If there are any conditions not mentioned in {@link licenseName} or {@link otherLicenseUrl}, put the URL link of the license document here.
-     */
-    otherPermissionUrl?: string;
-    /**
-     * Reference of the model.
-     */
-    reference?: string;
-    /**
-     * Enum indicates allow or disallow sexual expressions.
-     */
-    sexualUssageName?: VRMSchema.MetaUssageName;
-    /**
-     * Thumbnail of the model.
-     */
-    texture?: THREE.Texture;
-    /**
-     * Title of the model.
-     */
-    title?: string;
-    /**
-     * Version of the model.
-     */
-    version?: string;
-    /**
-     * Enum indicates allow or disallow violent expressions.
-     */
-    violentUssageName?: VRMSchema.MetaUssageName;
-}
+import * as THREE from 'three';
+import { VRMSchema } from '../types';
+/**
+ * Interface represents metadata of a VRM.
+ */
+export interface VRMMeta {
+    /**
+     * Enum indicates a condition who can perform with this avatar.
+     */
+    allowedUserName?: VRMSchema.MetaAllowedUserName;
+    /**
+     * Author of the model.
+     */
+    author?: string;
+    /**
+     * Enum indicates allow or disallow commercial use.
+     */
+    commercialUssageName?: VRMSchema.MetaUssageName;
+    /**
+     * Contact Information of its author.
+     */
+    contactInformation?: string;
+    /**
+     * Enum indicates a license type.
+     */
+    licenseName?: VRMSchema.MetaLicenseName;
+    /**
+     * If `Other` is selected for {@link licenseName}, put the URL link of the license document here.
+     */
+    otherLicenseUrl?: string;
+    /**
+     * If there are any conditions not mentioned in {@link licenseName} or {@link otherLicenseUrl}, put the URL link of the license document here.
+     */
+    otherPermissionUrl?: string;
+    /**
+     * Reference of the model.
+     */
+    reference?: string;
+    /**
+     * Enum indicates allow or disallow sexual expressions.
+     */
+    sexualUssageName?: VRMSchema.MetaUssageName;
+    /**
+     * Thumbnail of the model.
+     */
+    texture?: THREE.Texture;
+    /**
+     * Title of the model.
+     */
+    title?: string;
+    /**
+     * Version of the model.
+     */
+    version?: string;
+    /**
+     * Enum indicates allow or disallow violent expressions.
+     */
+    violentUssageName?: VRMSchema.MetaUssageName;
+}

package/types/meta/VRMMetaImporter.d.ts

@@ -1,14 +1,14 @@
-import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
-import { VRMMeta } from './VRMMeta';
-import { VRMMetaImporterOptions } from './VRMMetaImporterOptions';
-/**
- * An importer that imports a {@link VRMMeta} from a VRM extension of a GLTF.
- */
-export declare class VRMMetaImporter {
-    /**
-     * If `true`, it won't load its thumbnail texture ({@link VRMMeta.texture}). `false` by default.
-     */
-    ignoreTexture: boolean;
-    constructor(options?: VRMMetaImporterOptions);
-    import(gltf: GLTF): Promise<VRMMeta | null>;
-}
+import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
+import { VRMMeta } from './VRMMeta';
+import { VRMMetaImporterOptions } from './VRMMetaImporterOptions';
+/**
+ * An importer that imports a {@link VRMMeta} from a VRM extension of a GLTF.
+ */
+export declare class VRMMetaImporter {
+    /**
+     * If `true`, it won't load its thumbnail texture ({@link VRMMeta.texture}). `false` by default.
+     */
+    ignoreTexture: boolean;
+    constructor(options?: VRMMetaImporterOptions);
+    import(gltf: GLTF): Promise<VRMMeta | null>;
+}

package/types/meta/VRMMetaImporterOptions.d.ts

@@ -1,9 +1,9 @@
-/**
- * Options for a {@link VRMMetaImporter} instance.
- */
-export interface VRMMetaImporterOptions {
-    /**
-     * If `true`, it won't load its thumbnail texture ({@link VRMMeta.texture}). `false` by default.
-     */
-    ignoreTexture?: boolean;
-}
+/**
+ * Options for a {@link VRMMetaImporter} instance.
+ */
+export interface VRMMetaImporterOptions {
+    /**
+     * If `true`, it won't load its thumbnail texture ({@link VRMMeta.texture}). `false` by default.
+     */
+    ignoreTexture?: boolean;
+}

package/types/meta/index.d.ts

@@ -1,3 +1,3 @@
-export { VRMMeta } from './VRMMeta';
-export { VRMMetaImporter } from './VRMMetaImporter';
-export { VRMMetaImporterOptions } from './VRMMetaImporterOptions';
+export { VRMMeta } from './VRMMeta';
+export { VRMMetaImporter } from './VRMMetaImporter';
+export { VRMMetaImporterOptions } from './VRMMetaImporterOptions';

package/types/springbone/VRMSpringBone.d.ts

@@ -1,130 +1,130 @@
-import * as THREE from 'three';
-import { VRMSpringBoneColliderMesh } from './VRMSpringBoneColliderGroup';
-import { VRMSpringBoneParameters } from './VRMSpringBoneParameters';
-/**
- * A class represents a single spring bone of a VRM.
- * It should be managed by a [[VRMSpringBoneManager]].
- */
-export declare class VRMSpringBone {
-    /**
-     * Radius of the bone, will be used for collision.
-     */
-    radius: number;
-    /**
-     * Stiffness force of the bone. Increasing the value = faster convergence (feels "harder").
-     * On UniVRM, its range on GUI is between `0.0` and `4.0` .
-     */
-    stiffnessForce: number;
-    /**
-     * Power of the gravity against this bone.
-     * The "power" used in here is very far from scientific physics term...
-     */
-    gravityPower: number;
-    /**
-     * Direction of the gravity against this bone.
-     * Usually it should be normalized.
-     */
-    gravityDir: THREE.Vector3;
-    /**
-     * Drag force of the bone. Increasing the value = less oscillation (feels "heavier").
-     * On UniVRM, its range on GUI is between `0.0` and `1.0` .
-     */
-    dragForce: number;
-    /**
-     * Collider groups attached to this bone.
-     */
-    colliders: VRMSpringBoneColliderMesh[];
-    /**
-     * An Object3D attached to this bone.
-     */
-    readonly bone: THREE.Object3D;
-    /**
-     * Current position of child tail, in world unit. Will be used for verlet integration.
-     */
-    protected _currentTail: THREE.Vector3;
-    /**
-     * Previous position of child tail, in world unit. Will be used for verlet integration.
-     */
-    protected _prevTail: THREE.Vector3;
-    /**
-     * Next position of child tail, in world unit. Will be used for verlet integration.
-     * Actually used only in [[update]] and it's kind of temporary variable.
-     */
-    protected _nextTail: THREE.Vector3;
-    /**
-     * Initial axis of the bone, in local unit.
-     */
-    protected _boneAxis: THREE.Vector3;
-    /**
-     * Length of the bone in relative space unit. Will be used for normalization in update loop.
-     * It's same as local unit length unless there are scale transformation in world matrix.
-     */
-    protected _centerSpaceBoneLength: number;
-    /**
-     * Position of this bone in relative space, kind of a temporary variable.
-     */
-    protected _centerSpacePosition: THREE.Vector3;
-    /**
-     * This springbone will be calculated based on the space relative from this object.
-     * If this is `null`, springbone will be calculated in world space.
-     */
-    protected _center: THREE.Object3D | null;
-    get center(): THREE.Object3D | null;
-    set center(center: THREE.Object3D | null);
-    /**
-     * Rotation of parent bone, in world unit.
-     * We should update this constantly in [[update]].
-     */
-    private _parentWorldRotation;
-    /**
-     * Initial state of the local matrix of the bone.
-     */
-    private _initialLocalMatrix;
-    /**
-     * Initial state of the rotation of the bone.
-     */
-    private _initialLocalRotation;
-    /**
-     * Initial state of the position of its child.
-     */
-    private _initialLocalChildPosition;
-    /**
-     * Create a new VRMSpringBone.
-     *
-     * @param bone An Object3D that will be attached to this bone
-     * @param params Several parameters related to behavior of the spring bone
-     */
-    constructor(bone: THREE.Object3D, params?: VRMSpringBoneParameters);
-    /**
-     * Reset the state of this bone.
-     * You might want to call [[VRMSpringBoneManager.reset]] instead.
-     */
-    reset(): void;
-    /**
-     * Update the state of this bone.
-     * You might want to call [[VRMSpringBoneManager.update]] instead.
-     *
-     * @param delta deltaTime
-     */
-    update(delta: number): void;
-    /**
-     * Do collision math against every colliders attached to this bone.
-     *
-     * @param tail The tail you want to process
-     */
-    private _collision;
-    /**
-     * Create a matrix that converts center space into world space.
-     * @param target Target matrix
-     */
-    private _getMatrixCenterToWorld;
-    /**
-     * Create a matrix that converts world space into center space.
-     * @param target Target matrix
-     */
-    private _getMatrixWorldToCenter;
-    /**
-     * Returns the world matrix of its parent object.
-     */
-    private _getParentMatrixWorld;
-}
+import * as THREE from 'three';
+import { VRMSpringBoneColliderMesh } from './VRMSpringBoneColliderGroup';
+import { VRMSpringBoneParameters } from './VRMSpringBoneParameters';
+/**
+ * A class represents a single spring bone of a VRM.
+ * It should be managed by a [[VRMSpringBoneManager]].
+ */
+export declare class VRMSpringBone {
+    /**
+     * Radius of the bone, will be used for collision.
+     */
+    radius: number;
+    /**
+     * Stiffness force of the bone. Increasing the value = faster convergence (feels "harder").
+     * On UniVRM, its range on GUI is between `0.0` and `4.0` .
+     */
+    stiffnessForce: number;
+    /**
+     * Power of the gravity against this bone.
+     * The "power" used in here is very far from scientific physics term...
+     */
+    gravityPower: number;
+    /**
+     * Direction of the gravity against this bone.
+     * Usually it should be normalized.
+     */
+    gravityDir: THREE.Vector3;
+    /**
+     * Drag force of the bone. Increasing the value = less oscillation (feels "heavier").
+     * On UniVRM, its range on GUI is between `0.0` and `1.0` .
+     */
+    dragForce: number;
+    /**
+     * Collider groups attached to this bone.
+     */
+    colliders: VRMSpringBoneColliderMesh[];
+    /**
+     * An Object3D attached to this bone.
+     */
+    readonly bone: THREE.Object3D;
+    /**
+     * Current position of child tail, in world unit. Will be used for verlet integration.
+     */
+    protected _currentTail: THREE.Vector3;
+    /**
+     * Previous position of child tail, in world unit. Will be used for verlet integration.
+     */
+    protected _prevTail: THREE.Vector3;
+    /**
+     * Next position of child tail, in world unit. Will be used for verlet integration.
+     * Actually used only in [[update]] and it's kind of temporary variable.
+     */
+    protected _nextTail: THREE.Vector3;
+    /**
+     * Initial axis of the bone, in local unit.
+     */
+    protected _boneAxis: THREE.Vector3;
+    /**
+     * Length of the bone in relative space unit. Will be used for normalization in update loop.
+     * It's same as local unit length unless there are scale transformation in world matrix.
+     */
+    protected _centerSpaceBoneLength: number;
+    /**
+     * Position of this bone in relative space, kind of a temporary variable.
+     */
+    protected _centerSpacePosition: THREE.Vector3;
+    /**
+     * This springbone will be calculated based on the space relative from this object.
+     * If this is `null`, springbone will be calculated in world space.
+     */
+    protected _center: THREE.Object3D | null;
+    get center(): THREE.Object3D | null;
+    set center(center: THREE.Object3D | null);
+    /**
+     * Rotation of parent bone, in world unit.
+     * We should update this constantly in [[update]].
+     */
+    private _parentWorldRotation;
+    /**
+     * Initial state of the local matrix of the bone.
+     */
+    private _initialLocalMatrix;
+    /**
+     * Initial state of the rotation of the bone.
+     */
+    private _initialLocalRotation;
+    /**
+     * Initial state of the position of its child.
+     */
+    private _initialLocalChildPosition;
+    /**
+     * Create a new VRMSpringBone.
+     *
+     * @param bone An Object3D that will be attached to this bone
+     * @param params Several parameters related to behavior of the spring bone
+     */
+    constructor(bone: THREE.Object3D, params?: VRMSpringBoneParameters);
+    /**
+     * Reset the state of this bone.
+     * You might want to call [[VRMSpringBoneManager.reset]] instead.
+     */
+    reset(): void;
+    /**
+     * Update the state of this bone.
+     * You might want to call [[VRMSpringBoneManager.update]] instead.
+     *
+     * @param delta deltaTime
+     */
+    update(delta: number): void;
+    /**
+     * Do collision math against every colliders attached to this bone.
+     *
+     * @param tail The tail you want to process
+     */
+    private _collision;
+    /**
+     * Create a matrix that converts center space into world space.
+     * @param target Target matrix
+     */
+    private _getMatrixCenterToWorld;
+    /**
+     * Create a matrix that converts world space into center space.
+     * @param target Target matrix
+     */
+    private _getMatrixWorldToCenter;
+    /**
+     * Returns the world matrix of its parent object.
+     */
+    private _getParentMatrixWorld;
+}