three-zoo 0.9.0 → 0.9.2

package/dist/index.d.ts

@@ -1,7 +1,9 @@
-export * from "./DualFovCamera";
-export * from "./SceneTraversal";
-export * from "./SkinnedMeshBaker";
-export * from "./StandardToBasicConverter";
-export * from "./StandardToLambertConverter";
-export * from "./StandardToPhongConverter";
-export * from "./Sun";
+export { DualFovCamera } from "./DualFovCamera";
+export { SceneTraversal } from "./SceneTraversal";
+export { SkinnedMeshBaker } from "./SkinnedMeshBaker";
+export { StandardToBasicConverter } from "./StandardToBasicConverter";
+export { StandardToLambertConverter } from "./StandardToLambertConverter";
+export { StandardToPhongConverter } from "./StandardToPhongConverter";
+export { StandardToPhysicalConverter } from "./StandardToPhysicalConverter";
+export { StandardToToonConverter } from "./StandardToToonConverter";
+export { Sun } from "./Sun";

package/dist/index.js

@@ -1,4 +1,4 @@
-import { PerspectiveCamera, MathUtils, Vector3, Mesh, BufferAttribute, AnimationMixer, MeshBasicMaterial, MeshLambertMaterial, MeshPhongMaterial, Color, DirectionalLight, Box3, Spherical, RGBAFormat } from 'three';
+import { PerspectiveCamera, MathUtils, Vector3, Mesh, BufferAttribute, AnimationMixer, MeshBasicMaterial, MeshLambertMaterial, MeshPhongMaterial, Color, MeshPhysicalMaterial, MeshToonMaterial, DirectionalLight, Box3, Spherical, RGBAFormat } from 'three';
 
 /** Default horizontal field of view in degrees */
 const DEFAULT_HORIZONTAL_FOV = 90;
@@ -1022,6 +1022,345 @@ class StandardToPhongConverter {
     }
 }
 
+/**
+ * Converts MeshStandardMaterial to MeshPhysicalMaterial.
+ *
+ * MeshPhysicalMaterial extends MeshStandardMaterial with additional
+ * physically-based properties like clearcoat, sheen, and transmission.
+ * This converter copies all Standard properties and allows setting
+ * Physical-specific defaults.
+ */
+class StandardToPhysicalConverter {
+    /**
+     * Converts MeshStandardMaterial to MeshPhysicalMaterial.
+     *
+     * @param material - Source material to convert
+     * @param options - Conversion options
+     * @returns New MeshPhysicalMaterial with mapped properties
+     */
+    static convert(material, options = {}) {
+        const config = {
+            preserveName: true,
+            copyUserData: true,
+            disposeOriginal: false,
+            clearcoat: 0,
+            clearcoatRoughness: 0,
+            sheen: 0,
+            transmission: 0,
+            ior: 1.5,
+            ...options,
+        };
+        // Create new Physical material
+        const physicalMaterial = new MeshPhysicalMaterial();
+        // Copy basic material properties
+        this.copyBasicProperties(material, physicalMaterial, config);
+        // Copy Standard material properties (Physical extends Standard)
+        this.copyStandardProperties(material, physicalMaterial);
+        // Handle texture maps
+        this.convertTextureMaps(material, physicalMaterial);
+        // Handle transparency and alpha
+        this.convertTransparencyProperties(material, physicalMaterial);
+        // Apply Physical-specific properties from config
+        this.applyPhysicalProperties(physicalMaterial, config);
+        // Cleanup if requested
+        if (config.disposeOriginal) {
+            material.dispose();
+        }
+        physicalMaterial.needsUpdate = true;
+        return physicalMaterial;
+    }
+    /**
+     * Copies basic material properties.
+     *
+     * @param source - Source material
+     * @param target - Target material
+     * @param config - Configuration options
+     * @internal
+     */
+    static copyBasicProperties(source, target, config) {
+        if (config.preserveName) {
+            target.name = source.name;
+        }
+        target.side = source.side;
+        target.visible = source.visible;
+        target.fog = source.fog;
+        target.wireframe = source.wireframe;
+        target.wireframeLinewidth = source.wireframeLinewidth;
+        target.vertexColors = source.vertexColors;
+        target.flatShading = source.flatShading;
+        if (config.copyUserData) {
+            target.userData = { ...source.userData };
+        }
+    }
+    /**
+     * Copies MeshStandardMaterial-specific properties.
+     *
+     * @param source - Source material
+     * @param target - Target material
+     * @internal
+     */
+    static copyStandardProperties(source, target) {
+        // Color properties
+        target.color = source.color.clone();
+        target.emissive = source.emissive.clone();
+        target.emissiveIntensity = source.emissiveIntensity;
+        // PBR properties
+        target.metalness = source.metalness;
+        target.roughness = source.roughness;
+        // Environment map properties
+        target.envMapIntensity = source.envMapIntensity;
+    }
+    /**
+     * Converts texture properties from Standard to Physical material.
+     *
+     * @param source - Source material
+     * @param target - Target material
+     * @internal
+     */
+    static convertTextureMaps(source, target) {
+        // Diffuse/Albedo map
+        if (source.map) {
+            target.map = source.map;
+        }
+        // Emissive map
+        if (source.emissiveMap) {
+            target.emissiveMap = source.emissiveMap;
+        }
+        // Normal map
+        if (source.normalMap) {
+            target.normalMap = source.normalMap;
+            target.normalMapType = source.normalMapType;
+            target.normalScale = source.normalScale.clone();
+        }
+        // Bump map
+        if (source.bumpMap) {
+            target.bumpMap = source.bumpMap;
+            target.bumpScale = source.bumpScale;
+        }
+        // Displacement map
+        if (source.displacementMap) {
+            target.displacementMap = source.displacementMap;
+            target.displacementScale = source.displacementScale;
+            target.displacementBias = source.displacementBias;
+        }
+        // Roughness map
+        if (source.roughnessMap) {
+            target.roughnessMap = source.roughnessMap;
+        }
+        // Metalness map
+        if (source.metalnessMap) {
+            target.metalnessMap = source.metalnessMap;
+        }
+        // Light map
+        if (source.lightMap) {
+            target.lightMap = source.lightMap;
+            target.lightMapIntensity = source.lightMapIntensity;
+        }
+        // AO map
+        if (source.aoMap) {
+            target.aoMap = source.aoMap;
+            target.aoMapIntensity = source.aoMapIntensity;
+        }
+        // Environment map
+        if (source.envMap) {
+            target.envMap = source.envMap;
+        }
+        // Alpha map
+        if (source.alphaMap) {
+            target.alphaMap = source.alphaMap;
+        }
+    }
+    /**
+     * Converts transparency and rendering properties.
+     *
+     * @param source - Source material
+     * @param target - Target material
+     * @internal
+     */
+    static convertTransparencyProperties(source, target) {
+        target.transparent = source.transparent;
+        target.opacity = source.opacity;
+        target.alphaTest = source.alphaTest;
+        target.depthTest = source.depthTest;
+        target.depthWrite = source.depthWrite;
+        target.blending = source.blending;
+    }
+    /**
+     * Applies Physical-specific properties from configuration.
+     *
+     * @param target - Target material
+     * @param config - Configuration options
+     * @internal
+     */
+    static applyPhysicalProperties(target, config) {
+        target.clearcoat = config.clearcoat;
+        target.clearcoatRoughness = config.clearcoatRoughness;
+        target.sheen = config.sheen;
+        target.transmission = config.transmission;
+        target.ior = config.ior;
+    }
+}
+
+/**
+ * Converts MeshStandardMaterial to MeshToonMaterial.
+ *
+ * MeshToonMaterial provides a cel-shaded/cartoon appearance with
+ * discrete lighting steps. This converter maps Standard material
+ * properties to Toon material, preserving color and texture information
+ * while applying toon shading characteristics.
+ *
+ * Note: Some PBR properties (metalness, roughness) are not supported
+ * by MeshToonMaterial and will be ignored.
+ */
+class StandardToToonConverter {
+    /**
+     * Converts MeshStandardMaterial to MeshToonMaterial.
+     *
+     * @param material - Source material to convert
+     * @param options - Conversion options
+     * @returns New MeshToonMaterial with mapped properties
+     */
+    static convert(material, options = {}) {
+        const config = {
+            preserveName: true,
+            copyUserData: true,
+            disposeOriginal: false,
+            gradientMap: null,
+            ...options,
+        };
+        // Create new Toon material
+        const toonMaterial = new MeshToonMaterial();
+        // Copy basic material properties
+        this.copyBasicProperties(material, toonMaterial, config);
+        // Handle color properties
+        this.convertColorProperties(material, toonMaterial);
+        // Handle texture maps
+        this.convertTextureMaps(material, toonMaterial);
+        // Handle transparency and alpha
+        this.convertTransparencyProperties(material, toonMaterial);
+        // Apply toon-specific properties
+        this.applyToonProperties(toonMaterial, config);
+        // Cleanup if requested
+        if (config.disposeOriginal) {
+            material.dispose();
+        }
+        toonMaterial.needsUpdate = true;
+        return toonMaterial;
+    }
+    /**
+     * Copies basic material properties.
+     *
+     * @param source - Source material
+     * @param target - Target material
+     * @param config - Configuration options
+     * @internal
+     */
+    static copyBasicProperties(source, target, config) {
+        if (config.preserveName) {
+            target.name = source.name;
+        }
+        target.side = source.side;
+        target.visible = source.visible;
+        target.fog = source.fog;
+        target.wireframe = source.wireframe;
+        target.wireframeLinewidth = source.wireframeLinewidth;
+        target.vertexColors = source.vertexColors;
+        if (config.copyUserData) {
+            target.userData = { ...source.userData };
+        }
+    }
+    /**
+     * Converts color properties from Standard to Toon material.
+     *
+     * @param source - Source material
+     * @param target - Target material
+     * @internal
+     */
+    static convertColorProperties(source, target) {
+        target.color = source.color.clone();
+        target.emissive = source.emissive.clone();
+        target.emissiveIntensity = source.emissiveIntensity;
+    }
+    /**
+     * Converts texture properties from Standard to Toon material.
+     *
+     * Note: MeshToonMaterial does not support roughnessMap, metalnessMap,
+     * or envMap. These properties are intentionally skipped.
+     *
+     * @param source - Source material
+     * @param target - Target material
+     * @internal
+     */
+    static convertTextureMaps(source, target) {
+        // Diffuse/Albedo map
+        if (source.map) {
+            target.map = source.map;
+        }
+        // Emissive map
+        if (source.emissiveMap) {
+            target.emissiveMap = source.emissiveMap;
+        }
+        // Normal map
+        if (source.normalMap) {
+            target.normalMap = source.normalMap;
+            target.normalMapType = source.normalMapType;
+            target.normalScale = source.normalScale.clone();
+        }
+        // Bump map
+        if (source.bumpMap) {
+            target.bumpMap = source.bumpMap;
+            target.bumpScale = source.bumpScale;
+        }
+        // Displacement map
+        if (source.displacementMap) {
+            target.displacementMap = source.displacementMap;
+            target.displacementScale = source.displacementScale;
+            target.displacementBias = source.displacementBias;
+        }
+        // Light map
+        if (source.lightMap) {
+            target.lightMap = source.lightMap;
+            target.lightMapIntensity = source.lightMapIntensity;
+        }
+        // AO map
+        if (source.aoMap) {
+            target.aoMap = source.aoMap;
+            target.aoMapIntensity = source.aoMapIntensity;
+        }
+        // Alpha map
+        if (source.alphaMap) {
+            target.alphaMap = source.alphaMap;
+        }
+    }
+    /**
+     * Converts transparency and rendering properties.
+     *
+     * @param source - Source material
+     * @param target - Target material
+     * @internal
+     */
+    static convertTransparencyProperties(source, target) {
+        target.transparent = source.transparent;
+        target.opacity = source.opacity;
+        target.alphaTest = source.alphaTest;
+        target.depthTest = source.depthTest;
+        target.depthWrite = source.depthWrite;
+        target.blending = source.blending;
+    }
+    /**
+     * Applies Toon-specific properties from configuration.
+     *
+     * @param target - Target material
+     * @param config - Configuration options
+     * @internal
+     */
+    static applyToonProperties(target, config) {
+        if (config.gradientMap) {
+            target.gradientMap = config.gradientMap;
+        }
+    }
+}
+
 /** Number of color channels in RGBA format */
 const RGBA_CHANNEL_COUNT = 4;
 /** Number of color channels in RGB format */
@@ -1159,5 +1498,5 @@ class Sun extends DirectionalLight {
     }
 }
 
-export { DualFovCamera, SceneTraversal, SkinnedMeshBaker, StandardToBasicConverter, StandardToLambertConverter, StandardToPhongConverter, Sun };
+export { DualFovCamera, SceneTraversal, SkinnedMeshBaker, StandardToBasicConverter, StandardToLambertConverter, StandardToPhongConverter, StandardToPhysicalConverter, StandardToToonConverter, Sun };
 //# sourceMappingURL=index.js.map