@pixiv/three-vrm-materials-mtoon 2.1.0-beta.3 → 2.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2019-2024 pixiv Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/three-vrm-materials-mtoon.js

@@ -1,5 +1,5 @@
 /*!
- * @pixiv/three-vrm-materials-mtoon v2.1.0-beta.3
+ * @pixiv/three-vrm-materials-mtoon v2.1.0
  * MToon (toon material) module for @pixiv/three-vrm
  *
  * Copyright (c) 2020-2024 pixiv Inc.

package/lib/three-vrm-materials-mtoon.module.js

@@ -1,5 +1,5 @@
 /*!
- * @pixiv/three-vrm-materials-mtoon v2.1.0-beta.3
+ * @pixiv/three-vrm-materials-mtoon v2.1.0
  * MToon (toon material) module for @pixiv/three-vrm
  *
  * Copyright (c) 2020-2024 pixiv Inc.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixiv/three-vrm-materials-mtoon",
-  "version": "2.1.0-beta.3",
+  "version": "2.1.0",
   "description": "MToon (toon material) module for @pixiv/three-vrm",
   "license": "MIT",
   "author": "pixiv",
@@ -49,8 +49,8 @@
     ]
   },
   "dependencies": {
-    "@pixiv/types-vrm-0.0": "2.1.0-beta.3",
-    "@pixiv/types-vrmc-materials-mtoon-1.0": "2.1.0-beta.3"
+    "@pixiv/types-vrm-0.0": "2.1.0",
+    "@pixiv/types-vrmc-materials-mtoon-1.0": "2.1.0"
   },
   "devDependencies": {
     "@types/three": "^0.160.0",
@@ -59,5 +59,6 @@
   "peerDependencies": {
     "@types/three": "^0.160.0",
     "three": "^0.160.0"
-  }
+  },
+  "gitHead": "0d96aeaa6e20baa8158658652179df20a162d8a3"
 }

package/ts3.4/types/GLTFMToonMaterialParamsAssignHelper.d.ts

@@ -0,0 +1,20 @@
+import { GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
+import { MToonMaterialParameters } from './MToonMaterialParameters';
+/**
+ * MaterialParameters hates `undefined`. This helper automatically rejects assign of these `undefined`.
+ * It also handles asynchronous process of textures.
+ * Make sure await for {@link GLTFMToonMaterialParamsAssignHelper.pending}.
+ */
+export declare class GLTFMToonMaterialParamsAssignHelper {
+    private readonly _parser;
+    private _materialParams;
+    private _pendings;
+    readonly pending: Promise<unknown>;
+    constructor(parser: GLTFParser, materialParams: MToonMaterialParameters);
+    assignPrimitive<T extends keyof MToonMaterialParameters>(key: T, value: MToonMaterialParameters[T]): void;
+    assignColor<T extends keyof MToonMaterialParameters>(key: T, value: number[] | undefined, convertSRGBToLinear?: boolean): void;
+    assignTexture<T extends keyof MToonMaterialParameters>(key: T, texture: {
+        index: number;
+    } | undefined, isColorTexture: boolean): Promise<void>;
+    assignTextureByIndex<T extends keyof MToonMaterialParameters>(key: T, textureIndex: number | undefined, isColorTexture: boolean): Promise<void>;
+}

package/ts3.4/types/MToonMaterial.d.ts

@@ -0,0 +1,167 @@
+import * as THREE from 'three';
+import { MToonMaterialDebugMode } from './MToonMaterialDebugMode';
+import { MToonMaterialOutlineWidthMode } from './MToonMaterialOutlineWidthMode';
+import { MToonMaterialParameters } from './MToonMaterialParameters';
+/**
+ * MToon is a material specification that has various features.
+ * The spec and implementation are originally founded for Unity engine and this is a port of the material.
+ *
+ * See: https://github.com/Santarh/MToon
+ */
+export declare class MToonMaterial extends THREE.ShaderMaterial {
+    uniforms: {
+        litFactor: THREE.IUniform<THREE.Color>;
+        alphaTest: THREE.IUniform<number>;
+        opacity: THREE.IUniform<number>;
+        map: THREE.IUniform<THREE.Texture | null>;
+        mapUvTransform: THREE.IUniform<THREE.Matrix3>;
+        normalMap: THREE.IUniform<THREE.Texture | null>;
+        normalMapUvTransform: THREE.IUniform<THREE.Matrix3>;
+        normalScale: THREE.IUniform<THREE.Vector2>;
+        emissive: THREE.IUniform<THREE.Color>;
+        emissiveIntensity: THREE.IUniform<number>;
+        emissiveMap: THREE.IUniform<THREE.Texture | null>;
+        emissiveMapUvTransform: THREE.IUniform<THREE.Matrix3>;
+        shadeColorFactor: THREE.IUniform<THREE.Color>;
+        shadeMultiplyTexture: THREE.IUniform<THREE.Texture | null>;
+        shadeMultiplyTextureUvTransform: THREE.IUniform<THREE.Matrix3>;
+        shadingShiftFactor: THREE.IUniform<number>;
+        shadingShiftTexture: THREE.IUniform<THREE.Texture | null>;
+        shadingShiftTextureUvTransform: THREE.IUniform<THREE.Matrix3>;
+        shadingShiftTextureScale: THREE.IUniform<number>;
+        shadingToonyFactor: THREE.IUniform<number>;
+        giEqualizationFactor: THREE.IUniform<number>;
+        matcapFactor: THREE.IUniform<THREE.Color>;
+        matcapTexture: THREE.IUniform<THREE.Texture | null>;
+        matcapTextureUvTransform: THREE.IUniform<THREE.Matrix3>;
+        parametricRimColorFactor: THREE.IUniform<THREE.Color>;
+        rimMultiplyTexture: THREE.IUniform<THREE.Texture | null>;
+        rimMultiplyTextureUvTransform: THREE.IUniform<THREE.Matrix3>;
+        rimLightingMixFactor: THREE.IUniform<number>;
+        parametricRimFresnelPowerFactor: THREE.IUniform<number>;
+        parametricRimLiftFactor: THREE.IUniform<number>;
+        outlineWidthMultiplyTexture: THREE.IUniform<THREE.Texture | null>;
+        outlineWidthMultiplyTextureUvTransform: THREE.IUniform<THREE.Matrix3>;
+        outlineWidthFactor: THREE.IUniform<number>;
+        outlineColorFactor: THREE.IUniform<THREE.Color>;
+        outlineLightingMixFactor: THREE.IUniform<number>;
+        uvAnimationMaskTexture: THREE.IUniform<THREE.Texture | null>;
+        uvAnimationMaskTextureUvTransform: THREE.IUniform<THREE.Matrix3>;
+        uvAnimationScrollXOffset: THREE.IUniform<number>;
+        uvAnimationScrollYOffset: THREE.IUniform<number>;
+        uvAnimationRotationPhase: THREE.IUniform<number>;
+    };
+    color: THREE.Color;
+    map: THREE.Texture | null;
+    normalMap: THREE.Texture | null;
+    normalScale: THREE.Vector2;
+    emissive: THREE.Color;
+    emissiveIntensity: number;
+    emissiveMap: THREE.Texture | null;
+    shadeColorFactor: THREE.Color;
+    shadeMultiplyTexture: THREE.Texture | null;
+    shadingShiftFactor: number;
+    shadingShiftTexture: THREE.Texture | null;
+    shadingShiftTextureScale: number;
+    shadingToonyFactor: number;
+    giEqualizationFactor: number;
+    matcapFactor: THREE.Color;
+    matcapTexture: THREE.Texture | null;
+    parametricRimColorFactor: THREE.Color;
+    rimMultiplyTexture: THREE.Texture | null;
+    rimLightingMixFactor: number;
+    parametricRimFresnelPowerFactor: number;
+    parametricRimLiftFactor: number;
+    outlineWidthMultiplyTexture: THREE.Texture | null;
+    outlineWidthFactor: number;
+    outlineColorFactor: THREE.Color;
+    outlineLightingMixFactor: number;
+    uvAnimationMaskTexture: THREE.Texture | null;
+    uvAnimationScrollXOffset: number;
+    uvAnimationScrollYOffset: number;
+    uvAnimationRotationPhase: number;
+    uvAnimationScrollXSpeedFactor: number;
+    uvAnimationScrollYSpeedFactor: number;
+    uvAnimationRotationSpeedFactor: number;
+    /**
+     * Whether the material is affected by fog.
+     * `true` by default.
+     */
+    fog: boolean;
+    /**
+     * Will be read in WebGLPrograms
+     *
+     * See: https://github.com/mrdoob/three.js/blob/4f5236ac3d6f41d904aa58401b40554e8fbdcb15/src/renderers/webgl/WebGLPrograms.js#L190-L191
+     */
+    normalMapType: 0;
+    /**
+     * When this is `true`, vertex colors will be ignored.
+     * `true` by default.
+     */
+    private _ignoreVertexColor;
+    /*
+    * When this is `true`, vertex colors will be ignored.
+    * `true` by default.
+    */
+    ignoreVertexColor: boolean;
+    private _v0CompatShade;
+    /*
+    * There is a line of the shader called "comment out if you want to PBR absolutely" in VRM0.0 MToon.
+    * When this is true, the material enables the line to make it compatible with the legacy rendering of VRM.
+    * Usually not recommended to turn this on.
+    * `false` by default.
+    
+    
+    * There is a line of the shader called "comment out if you want to PBR absolutely" in VRM0.0 MToon.
+    * When this is true, the material enables the line to make it compatible with the legacy rendering of VRM.
+    * Usually not recommended to turn this on.
+    * `false` by default.
+    */
+    v0CompatShade: boolean;
+    private _debugMode;
+    /*
+    * Debug mode for the material.
+    * You can visualize several components for diagnosis using debug mode.
+    *
+    * See: {@link MToonMaterialDebugMode}
+    
+    
+    * Debug mode for the material.
+    * You can visualize several components for diagnosis using debug mode.
+    *
+    * See: {@link MToonMaterialDebugMode}
+    */
+    debugMode: MToonMaterialDebugMode;
+    private _outlineWidthMode;
+    outlineWidthMode: MToonMaterialOutlineWidthMode;
+    private _isOutline;
+    isOutline: boolean;
+    /*
+    * Readonly boolean that indicates this is a [[MToonMaterial]].
+    */
+    readonly isMToonMaterial: true;
+    constructor(parameters?: MToonMaterialParameters);
+    /**
+     * Update this material.
+     *
+     * @param delta deltaTime since last update
+     */
+    update(delta: number): void;
+    copy(source: this): this;
+    /**
+     * Update UV animation state.
+     * Intended to be called via {@link update}.
+     * @param delta deltaTime
+     */
+    private _updateUVAnimation;
+    /**
+     * Upload uniforms that need to upload but doesn't automatically because of reasons.
+     * Intended to be called via {@link constructor} and {@link update}.
+     */
+    private _uploadUniformsWorkaround;
+    /**
+     * Returns a map object of preprocessor token and macro of the shader program.
+     */
+    private _generateDefines;
+    private _updateTextureMatrix;
+}

package/ts3.4/types/MToonMaterialDebugMode.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Specifiers of debug mode of {@link MToonMaterial}.
+ *
+ * See: {@link MToonMaterial.debugMode}
+ */
+export declare const MToonMaterialDebugMode: {
+    /**
+     * Render normally.
+     */
+    readonly None: "none";
+    /**
+     * Visualize normals of the surface.
+     */
+    readonly Normal: "normal";
+    /**
+     * Visualize lit/shade of the surface.
+     */
+    readonly LitShadeRate: "litShadeRate";
+    /**
+     * Visualize UV of the surface.
+     */
+    readonly UV: "uv";
+};
+export type MToonMaterialDebugMode = typeof MToonMaterialDebugMode[keyof typeof MToonMaterialDebugMode];

package/ts3.4/types/MToonMaterialLoaderPlugin.d.ts

@@ -0,0 +1,68 @@
+import * as THREE from 'three';
+import { GLTF, GLTFLoaderPlugin, GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader.js';
+import { MToonMaterialParameters } from './MToonMaterialParameters';
+import { MToonMaterialLoaderPluginOptions } from './MToonMaterialLoaderPluginOptions';
+import { MToonMaterialDebugMode } from './MToonMaterialDebugMode';
+export declare class MToonMaterialLoaderPlugin implements GLTFLoaderPlugin {
+    static EXTENSION_NAME: string;
+    /**
+     * This value will be added to `renderOrder` of every meshes who have MaterialsMToon.
+     * The final renderOrder will be sum of this `renderOrderOffset` and `renderQueueOffsetNumber` for each materials.
+     * `0` by default.
+     */
+    renderOrderOffset: number;
+    /**
+     * There is a line of the shader called "comment out if you want to PBR absolutely" in VRM0.0 MToon.
+     * When this is true, the material enables the line to make it compatible with the legacy rendering of VRM.
+     * Usually not recommended to turn this on.
+     * `false` by default.
+     */
+    v0CompatShade: boolean;
+    /**
+     * Debug mode for the material.
+     * You can visualize several components for diagnosis using debug mode.
+     *
+     * See: {@link MToonMaterialDebugMode}
+     */
+    debugMode: MToonMaterialDebugMode;
+    readonly parser: GLTFParser;
+    /**
+     * Loaded materials will be stored in this set.
+     * Will be transferred into `gltf.userData.vrmMToonMaterials` in {@link afterRoot}.
+     */
+    private readonly _mToonMaterialSet;
+    readonly name: string;
+    constructor(parser: GLTFParser, options?: MToonMaterialLoaderPluginOptions);
+    beforeRoot(): Promise<void>;
+    afterRoot(gltf: GLTF): Promise<void>;
+    getMaterialType(materialIndex: number): typeof THREE.Material | null;
+    extendMaterialParams(materialIndex: number, materialParams: MToonMaterialParameters): Promise<any> | null;
+    loadMesh(meshIndex: number): Promise<THREE.Group | THREE.Mesh | THREE.SkinnedMesh>;
+    /**
+     * Delete use of `KHR_materials_unlit` from its `materials` if the material is using MToon.
+     *
+     * Since GLTFLoader have so many hardcoded procedure related to `KHR_materials_unlit`
+     * we have to delete the extension before we start to parse the glTF.
+     */
+    private _removeUnlitExtensionIfMToonExists;
+    private _getMToonExtension;
+    private _extendMaterialParams;
+    /**
+     * This will do two processes that is required to render MToon properly.
+     *
+     * - Set render order
+     * - Generate outline
+     *
+     * @param mesh A target GLTF primitive
+     * @param materialIndex The material index of the primitive
+     */
+    private _setupPrimitive;
+    /**
+     * Generate outline for the given mesh, if it needs.
+     *
+     * @param mesh The target mesh
+     */
+    private _generateOutline;
+    private _addToMaterialSet;
+    private _parseRenderOrder;
+}

package/ts3.4/types/MToonMaterialLoaderPluginOptions.d.ts

@@ -0,0 +1,23 @@
+import { MToonMaterialDebugMode } from './MToonMaterialDebugMode';
+export interface MToonMaterialLoaderPluginOptions {
+    /**
+     * This value will be added to every meshes who have MaterialsMToon.
+     * The final renderOrder will be sum of this `renderOrderOffset` and `renderQueueOffsetNumber` for each materials.
+     * `0` by default.
+     */
+    renderOrderOffset?: number;
+    /**
+     * There is a line of the shader called "comment out if you want to PBR absolutely" in VRM0.0 MToon.
+     * When this is true, the material enables the line to make it compatible with the legacy rendering of VRM.
+     * Usually not recommended to turn this on.
+     * `false` by default.
+     */
+    v0CompatShade?: boolean;
+    /**
+     * Debug mode for the material.
+     * You can visualize several components for diagnosis using debug mode.
+     *
+     * See: {@link MToonMaterialDebugMode}
+     */
+    debugMode?: MToonMaterialDebugMode;
+}

package/ts3.4/types/MToonMaterialOutlineWidthMode.d.ts

@@ -0,0 +1,6 @@
+export declare const MToonMaterialOutlineWidthMode: {
+    readonly None: "none";
+    readonly WorldCoordinates: "worldCoordinates";
+    readonly ScreenCoordinates: "screenCoordinates";
+};
+export type MToonMaterialOutlineWidthMode = typeof MToonMaterialOutlineWidthMode[keyof typeof MToonMaterialOutlineWidthMode];

package/ts3.4/types/MToonMaterialParameters.d.ts

@@ -0,0 +1,67 @@
+import { MToonMaterialDebugMode } from './MToonMaterialDebugMode';
+import { MToonMaterialOutlineWidthMode } from './MToonMaterialOutlineWidthMode';
+export interface MToonMaterialParameters extends THREE.ShaderMaterialParameters {
+    /**
+     * Enable depth buffer when renderMode is transparent.
+     * Will be processed in the constructor.
+     */
+    transparentWithZWrite?: boolean;
+    color?: THREE.Color;
+    map?: THREE.Texture;
+    normalMap?: THREE.Texture;
+    normalScale?: THREE.Vector2;
+    emissive?: THREE.Color;
+    emissiveIntensity?: number;
+    emissiveMap?: THREE.Texture;
+    shadeColorFactor?: THREE.Color;
+    shadeMultiplyTexture?: THREE.Texture;
+    shadingShiftFactor?: number;
+    shadingShiftTexture?: THREE.Texture;
+    shadingShiftTextureScale?: number;
+    shadingToonyFactor?: number;
+    giEqualizationFactor?: number;
+    matcapFactor?: THREE.Color;
+    matcapTexture?: THREE.Texture;
+    parametricRimColorFactor?: THREE.Color;
+    rimMultiplyTexture?: THREE.Texture;
+    rimLightingMixFactor?: number;
+    parametricRimFresnelPowerFactor?: number;
+    parametricRimLiftFactor?: number;
+    outlineWidthMode?: MToonMaterialOutlineWidthMode;
+    outlineWidthFactor?: number;
+    outlineWidthMultiplyTexture?: THREE.Texture;
+    outlineColorFactor?: THREE.Color;
+    outlineLightingMixFactor?: number;
+    uvAnimationMaskTexture?: THREE.Texture;
+    uvAnimationScrollXSpeedFactor?: number;
+    uvAnimationScrollYSpeedFactor?: number;
+    uvAnimationRotationSpeedFactor?: number;
+    /**
+     * Whether the material is affected by fog.
+     * `true` by default.
+     */
+    fog?: boolean;
+    /**
+     * When this is `true`, vertex colors will be ignored.
+     * `true` by default.
+     */
+    ignoreVertexColor?: boolean;
+    /**
+     * Debug mode for the material.
+     * You can visualize several components for diagnosis using debug mode.
+     *
+     * See: {@link MToonMaterialDebugMode}
+     */
+    debugMode?: MToonMaterialDebugMode;
+    /**
+     * There is a line of the shader called "comment out if you want to PBR absolutely" in VRM0.0 MToon.
+     * When this is true, the material enables the line to make it compatible with the legacy rendering of VRM.
+     * Usually not recommended to turn this on.
+     * `false` by default.
+     */
+    v0CompatShade?: boolean;
+    /**
+     * It will draw its outline instead when it's `true`.
+     */
+    isOutline?: boolean;
+}

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

@@ -0,0 +1,6 @@
+export { MToonMaterialLoaderPlugin } from './MToonMaterialLoaderPlugin';
+export { MToonMaterialLoaderPluginOptions } from './MToonMaterialLoaderPluginOptions';
+export { MToonMaterial } from './MToonMaterial';
+export { MToonMaterialDebugMode } from './MToonMaterialDebugMode';
+export { MToonMaterialOutlineWidthMode } from './MToonMaterialOutlineWidthMode';
+export { MToonMaterialParameters } from './MToonMaterialParameters';

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

@@ -0,0 +1,11 @@
+import * as THREE from 'three';
+/**
+ * A compat function to get texture color space.
+ *
+ * COMPAT: pre-r152
+ * Starting from Three.js r152, `texture.encoding` is renamed to `texture.colorSpace`.
+ * This function will handle the comapt.
+ *
+ * @param texture The texture you want to get the color space from
+ */
+export declare function getTextureColorSpace(texture: THREE.Texture): '' | 'srgb';

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

@@ -0,0 +1,12 @@
+import * as THREE from 'three';
+/**
+ * A compat function to set texture color space.
+ *
+ * COMPAT: pre-r152
+ * Starting from Three.js r152, `texture.encoding` is renamed to `texture.colorSpace`.
+ * This function will handle the comapt.
+ *
+ * @param texture The texture you want to set the color space to
+ * @param colorSpace The color space you want to set to the texture
+ */
+export declare function setTextureColorSpace(texture: THREE.Texture, colorSpace: '' | 'srgb'): void;