three-zoo 0.5.5 → 0.6.0

package/dist/DualFovCamera.d.ts

@@ -1,9 +1,7 @@
 import type { Box3, SkinnedMesh } from "three";
 import { PerspectiveCamera, Vector3 } from "three";
 /**
- * A camera that supports independent horizontal and vertical FOV settings.
- * Extends Three.js PerspectiveCamera to allow separate control over horizontal
- * and vertical fields of view.
+ * Camera with independent horizontal and vertical FOV settings.
  */
 export declare class DualFovCamera extends PerspectiveCamera {
     /** Internal storage for horizontal field of view in degrees */
@@ -11,130 +9,93 @@ export declare class DualFovCamera extends PerspectiveCamera {
     /** Internal storage for vertical field of view in degrees */
     private verticalFovInternal;
     /**
-     * Creates a new DualFovCamera instance.
-     *
-     * @param horizontalFov - Horizontal field of view in degrees. Clamped between 1° and 179°.
-     * @param verticalFov - Vertical field of view in degrees. Clamped between 1° and 179°.
-     * @param aspect - Camera aspect ratio (width/height).
-     * @param near - Near clipping plane distance.
-     * @param far - Far clipping plane distance.
+     * @param horizontalFov - Horizontal FOV in degrees (clamped 1-179°)
+     * @param verticalFov - Vertical FOV in degrees (clamped 1-179°)
+     * @param aspect - Aspect ratio (width/height)
+     * @param near - Near clipping plane distance
+     * @param far - Far clipping plane distance
      */
     constructor(horizontalFov?: number, verticalFov?: number, aspect?: number, near?: number, far?: number);
     /**
-     * Gets the horizontal field of view in degrees.
-     *
-     * @returns The horizontal FOV value
+     * @returns Horizontal FOV in degrees
      */
     get horizontalFov(): number;
     /**
-     * Gets the vertical field of view in degrees.
-     *
-     * @returns The vertical FOV value
+     * @returns Vertical FOV in degrees
      */
     get verticalFov(): number;
     /**
-     * Sets the horizontal field of view in degrees.
-     *
-     * @param value - The horizontal FOV value in degrees. Clamped between 1° and 179°.
+     * @param value - Horizontal FOV in degrees (clamped 1-179°)
      */
     set horizontalFov(value: number);
     /**
-     * Sets the vertical field of view in degrees.
-     *
-     * @param value - The vertical FOV value in degrees. Clamped between 1° and 179°.
+     * @param value - Vertical FOV in degrees (clamped 1-179°)
      */
     set verticalFov(value: number);
     /**
-     * Sets both horizontal and vertical field of view values.
+     * Sets both FOV values.
      *
-     * @param horizontal - Horizontal FOV in degrees. Clamped between 1° and 179°.
-     * @param vertical - Vertical FOV in degrees. Clamped between 1° and 179°.
+     * @param horizontal - Horizontal FOV in degrees (clamped 1-179°)
+     * @param vertical - Vertical FOV in degrees (clamped 1-179°)
      */
     setFov(horizontal: number, vertical: number): void;
     /**
-     * Copies the field of view settings from another DualFovCamera.
+     * Copies FOV settings from another DualFovCamera.
      *
-     * @param source - The DualFovCamera to copy FOV settings from.
+     * @param source - Source camera to copy from
      */
     copyFovSettings(source: DualFovCamera): void;
     /**
-     * Updates the projection matrix based on current FOV settings and aspect ratio.
-     *
-     * The behavior differs based on orientation:
-     * - **Landscape mode (aspect > 1)**: Preserves horizontal FOV, calculates vertical FOV
-     * - **Portrait mode (aspect ≤ 1)**: Preserves vertical FOV, calculates horizontal FOV
+     * Updates projection matrix based on FOV and aspect ratio.
      *
-     * Called when FOV values or aspect ratio changes.
+     * Landscape (aspect > 1): preserves horizontal FOV.
+     * Portrait (aspect ≤ 1): preserves vertical FOV.
      *
      * @override
      */
     updateProjectionMatrix(): void;
     /**
-     * Gets the horizontal field of view after aspect ratio adjustments.
-     *
-     * In landscape mode, returns the set horizontal FOV.
-     * In portrait mode, calculates the horizontal FOV from vertical FOV and aspect ratio.
+     * Gets actual horizontal FOV after aspect ratio adjustments.
      *
-     * @returns The horizontal FOV in degrees
+     * @returns Horizontal FOV in degrees
      */
     getActualHorizontalFov(): number;
     /**
-     * Gets the vertical field of view after aspect ratio adjustments.
+     * Gets actual vertical FOV after aspect ratio adjustments.
      *
-     * In portrait mode, returns the set vertical FOV.
-     * In landscape mode, calculates the vertical FOV from horizontal FOV and aspect ratio.
-     *
-     * @returns The vertical FOV in degrees
+     * @returns Vertical FOV in degrees
      */
     getActualVerticalFov(): number;
     /**
-     * Adjusts the vertical field of view to fit specified points within the camera's view.
-     *
-     * Calculates the required vertical FOV to ensure all provided vertices
-     * are visible within the vertical bounds of the camera's frustum.
+     * Adjusts vertical FOV to fit points within camera view.
      *
      * @param vertices - Array of 3D points in world coordinates
      */
     fitVerticalFovToPoints(vertices: Vector3[]): void;
     /**
-     * Adjusts the vertical field of view to fit a bounding box within the camera's view.
+     * Adjusts vertical FOV to fit bounding box within camera view.
      *
-     * Calculates the required vertical FOV to ensure the bounding box
-     * is visible within the vertical bounds of the camera's frustum.
-     *
-     * @param box - The 3D bounding box in world coordinates
+     * @param box - 3D bounding box in world coordinates
      */
     fitVerticalFovToBox(box: Box3): void;
     /**
-     * Adjusts the vertical field of view to fit a skinned mesh within the camera's view.
-     *
-     * Updates the mesh's skeleton, applies bone transformations to vertices,
-     * and calculates the required vertical FOV to fit the deformed mesh
-     * within the vertical bounds of the camera's frustum.
+     * Adjusts vertical FOV to fit skinned mesh within camera view.
+     * Updates skeleton and applies bone transformations.
      *
-     * @param skinnedMesh - The skinned mesh with active skeleton
+     * @param skinnedMesh - Skinned mesh with active skeleton
      */
     fitVerticalFovToMesh(skinnedMesh: SkinnedMesh): void;
     /**
-     * Points the camera to look at the center of mass of a skinned mesh.
+     * Points camera to look at skinned mesh center of mass.
+     * Uses iterative clustering to find main vertex concentration.
      *
-     * Updates the mesh's skeleton, applies bone transformations to vertices,
-     * calculates the center of mass using a clustering algorithm, and orients the camera
-     * to look at that point.
-     *
-     * The center of mass calculation uses iterative clustering to find the
-     * main concentration of vertices.
-     *
-     * @param skinnedMesh - The skinned mesh with active skeleton
+     * @param skinnedMesh - Skinned mesh with active skeleton
      */
     lookAtMeshCenterOfMass(skinnedMesh: SkinnedMesh): void;
     /**
-     * Creates a copy of this DualFovCamera.
-     *
-     * The cloned camera has identical FOV settings, position, rotation,
-     * and all other camera properties.
+     * Creates a copy of this camera with identical settings.
      *
-     * @returns A new DualFovCamera instance
+     * @returns New DualFovCamera instance
      * @override
      */
     clone(): this;

package/dist/SceneTraversal.d.ts

@@ -1,104 +1,103 @@
 import type { Material, Object3D } from "three";
 import { Mesh } from "three";
 /**
- * Constructor type for scene traversal operations.
- *
- * Represents a constructor function that creates instances of type T.
- * Used for runtime type checking when filtering objects by constructor type.
+ * Constructor type for runtime type checking.
  *
  * @template T - The type that the constructor creates
  */
 export type Constructor<T> = abstract new (...args: never[]) => T;
 /**
- * Utility class for finding and modifying objects in a Three.js scene graph.
- *
- * Provides static methods for traversing Three.js scene hierarchies,
- * searching for objects or materials, and performing batch operations.
+ * Static methods for traversing Three.js scene hierarchies.
  *
- * All methods perform depth-first traversal starting from the provided
- * root object and recursively processing all children.
+ * All methods use depth-first traversal.
  */
 export declare class SceneTraversal {
     /**
-     * Finds the first object in the scene hierarchy with an exact name match.
+     * Finds first object with exact name match.
      *
-     * Performs depth-first search through the scene graph starting from the
-     * root object. Returns the first object whose name property matches
-     * the search string.
-     *
-     * @param object - The root Object3D to start searching from
-     * @param name - The exact name to search for (case-sensitive)
-     * @returns The first matching Object3D, or null if no match is found
+     * @param object - Root object to start from
+     * @param name - Name to search for (case-sensitive)
+     * @returns First matching object or undefined
      */
-    static getObjectByName(object: Object3D, name: string): Object3D | null;
+    static getObjectByName(object: Object3D, name: string): Object3D | undefined;
     /**
-     * Finds the first material in the scene hierarchy with an exact name match.
-     *
-     * Performs depth-first search through the scene graph, examining materials
-     * attached to Mesh objects. Handles both single materials and material arrays.
-     * Returns the first material whose name property matches the search string.
+     * Finds first material with exact name match from mesh objects.
      *
-     * @param object - The root Object3D to start searching from
-     * @param name - The exact material name to search for (case-sensitive)
-     * @returns The first matching Material, or null if no match is found
+     * @param object - Root object to start from
+     * @param name - Material name to search for (case-sensitive)
+     * @returns First matching material or undefined
      */
-    static getMaterialByName(object: Object3D, name: string): Material | null;
+    static getMaterialByName(object: Object3D, name: string): Material | undefined;
     /**
-     * Processes all objects of a specific type in the scene hierarchy.
+     * Executes callback for all objects of specified type.
      *
-     * Performs depth-first traversal and executes the callback function
-     * for every object that is an instance of the specified type.
+     * @template T - Type of objects to process
+     * @param object - Root object to start from
+     * @param type - Constructor to filter by
+     * @param callback - Function to execute for each matching object
+     */
+    static enumerateObjectsByType<T extends Object3D>(object: Object3D, type: Constructor<T>, callback: (instance: T) => void): void;
+    /**
+     * Executes callback for all materials of specified type from mesh objects.
      *
-     * @template T - The type of objects to process
-     * @param object - The root Object3D to start searching from
-     * @param type - The constructor/class to filter by (e.g., DirectionalLight, Mesh)
-     * @param callback - Function to execute for each matching object instance
+     * @template T - Type of materials to process
+     * @param object - Root object to start from
+     * @param type - Constructor to filter by
+     * @param callback - Function to execute for each matching material
      */
-    static enumerateObjectsByType<T>(object: Object3D, type: Constructor<T>, callback: (instance: T) => void): void;
+    static enumerateMaterialsByType<T extends Material>(object: Object3D, type: Constructor<T>, callback: (material: T) => void): void;
     /**
-     * Processes all materials found in mesh objects within the scene hierarchy.
+     * Executes callback for all objects in hierarchy.
      *
-     * Performs depth-first traversal, finding all Mesh objects and executing
-     * the callback function for each material. Handles both single
-     * materials and material arrays.
+     * @param object - Root object to start from
+     * @param callback - Function to execute for each object
+     */
+    static enumerateObjects(object: Object3D, callback: (object: Object3D) => void): void;
+    /**
+     * Executes callback for all materials from mesh objects.
      *
-     * @param object - The root Object3D to start searching from
-     * @param callback - Function to execute for each material found
+     * @param object - Root object to start from
+     * @param callback - Function to execute for each material
      */
     static enumerateMaterials(object: Object3D, callback: (material: Material) => void): void;
     /**
-     * Finds all objects in the scene hierarchy that match filter criteria.
-     *
-     * Performs depth-first search and collects all objects that either match
-     * a regular expression pattern (applied to object names) or satisfy
-     * a predicate function.
+     * Returns all objects matching filter criteria.
      *
-     * @param object - The root Object3D to start searching from
-     * @param filter - Either a RegExp to test against object names, or a predicate function
-     * @returns Array of all matching Object3D instances
+     * @param object - Root object to start from
+     * @param filter - RegExp for object names or predicate function
+     * @returns Array of matching objects
      */
     static filterObjects(object: Object3D, filter: RegExp | ((object: Object3D) => boolean)): Object3D[];
     /**
-     * Finds all materials in the scene hierarchy whose names match a pattern.
+     * Returns all materials matching filter criteria from mesh objects.
      *
-     * Performs depth-first search through all Mesh objects and collects materials
-     * whose name property matches the regular expression. Handles both
-     * single materials and material arrays.
+     * @param object - Root object to start from
+     * @param filter - RegExp for material names or predicate function
+     * @returns Array of matching materials
+     */
+    static filterMaterials(object: Object3D, filter: RegExp | ((object: Material) => boolean)): Material[];
+    /**
+     * Returns all mesh objects that use any of the specified materials.
      *
-     * @param object - The root Object3D to start searching from
-     * @param name - Regular expression pattern to test against material names
-     * @returns Array of all matching Material instances
+     * @param object - Root object to start from
+     * @param materials - Array of materials to search for
+     * @returns Array of mesh objects using the materials
      */
-    static filterMaterials(object: Object3D, name: RegExp): Material[];
+    static findMaterialUsers(object: Object3D, materials: Material[]): Mesh[];
     /**
-     * Finds all mesh objects that use materials with names matching a pattern.
+     * Clones material by name and replaces all instances with the clone.
      *
-     * Performs depth-first search through all Mesh objects and collects mesh objects
-     * whose materials have names that match the regular expression.
+     * @param object - Root object to start from
+     * @param name - Material name to search for (case-sensitive)
+     * @returns Cloned material or undefined if not found
+     */
+    static cloneMaterialByName(object: Object3D, name: string): Material | undefined;
+    /**
+     * Replaces all instances of a material with another material.
      *
-     * @param object - The root Object3D to start searching from
-     * @param materialName - Regular expression pattern to test against material names
-     * @returns Array of all Mesh objects that use materials with matching names
+     * @param object - Root object to start from
+     * @param oldMaterial - Material to replace
+     * @param newMaterial - Material to use as replacement
      */
-    static findMaterialUsers(object: Object3D, materialName: RegExp): Mesh[];
+    private static replaceMaterial;
 }

package/dist/SkinnedMeshBaker.d.ts

@@ -1,23 +1,22 @@
 import type { AnimationClip, Object3D, SkinnedMesh } from "three";
 import { Mesh } from "three";
-/** Converts skinned meshes to static meshes */
+/** Converts skinned meshes to static meshes. */
 export declare class SkinnedMeshBaker {
     /**
-     * Converts a skinned mesh to a static mesh in its current pose.
-     * The resulting mesh has no bones but looks identical.
+     * Converts skinned mesh to static mesh in current pose.
      *
      * @param skinnedMesh - Mesh to convert
-     * @returns Static mesh with baked vertex positions
+     * @returns Static mesh with baked positions
      */
     static bakePose(skinnedMesh: SkinnedMesh): Mesh;
     /**
-     * Bakes a single frame from an animation into a static mesh.
+     * Bakes animation frame to static mesh.
      *
      * @param armature - Root object with bones
      * @param skinnedMesh - Mesh to convert
-     * @param timeOffset - Time in seconds within the animation
-     * @param clip - Animation to get the pose from
-     * @returns Static mesh with baked vertex positions
+     * @param timeOffset - Time in seconds within animation
+     * @param clip - Animation clip for pose
+     * @returns Static mesh with baked positions
      */
     static bakeAnimationFrame(armature: Object3D, skinnedMesh: SkinnedMesh, timeOffset: number, clip: AnimationClip): Mesh;
 }

package/dist/StandardToBasicConverter.d.ts

@@ -1,67 +1,45 @@
 import type { MeshStandardMaterial } from "three";
 import { MeshBasicMaterial } from "three";
 /**
- * Configuration options for the StandardToBasicConverter.
+ * Configuration options for material conversion.
  */
 export interface StandardToBasicConverterOptions {
     /**
-     * Whether to preserve the original material's name
+     * Preserve original material name.
      * @defaultValue true
      */
     preserveName: boolean;
     /**
-     * Whether to copy user data from the original material
+     * Copy user data from original material.
      * @defaultValue true
      */
     copyUserData: boolean;
     /**
-     * Whether to dispose the original material after conversion
+     * Dispose original material after conversion.
      * @defaultValue false
      */
     disposeOriginal: boolean;
     /**
-     * Whether to apply emissive color to the base color for brightness compensation
+     * Apply emissive color to base color for brightness compensation.
      * @defaultValue true
      */
     combineEmissive: boolean;
     /**
-     * Factor for brightness adjustment to compensate for loss of lighting
+     * Brightness adjustment factor to compensate for loss of lighting.
      * @defaultValue 1.3
      */
     brightnessFactor: number;
 }
 /**
- * Converts Three.js MeshStandardMaterial to MeshBasicMaterial.
- *
- * Handles translation from PBR StandardMaterial to unlit BasicMaterial.
- * Since BasicMaterial doesn't respond to lighting, applies compensation
- * techniques including brightness adjustments and emissive color combination.
+ * Converts MeshStandardMaterial to MeshBasicMaterial with brightness compensation.
  */
 export declare class StandardToBasicConverter {
     /**
-     * Converts a MeshStandardMaterial to MeshBasicMaterial.
+     * Converts MeshStandardMaterial to MeshBasicMaterial.
      *
-     * Performs conversion from PBR StandardMaterial to unlit BasicMaterial
-     * with brightness compensation and property mapping.
-     *
-     * @param standardMaterial - The source MeshStandardMaterial to convert
-     * @param options - Configuration options for the conversion
-     * @returns A new MeshBasicMaterial with properties mapped from the standard material
-     *
-     * @example
-     * ```typescript
-     * const standardMaterial = new MeshStandardMaterial({
-     *   color: 0x00ff00,
-     *   metalness: 0.5,
-     *   emissive: 0x111111,
-     *   emissiveIntensity: 0.2
-     * });
-     *
-     * const basicMaterial = StandardToBasicConverter.convert(standardMaterial, {
-     *   brightnessFactor: 1.4,
-     *   combineEmissive: true
-     * });
-     * ```
+     * @param standardMaterial - Source material to convert
+     * @param options - Conversion options
+     * @returns New MeshBasicMaterial with mapped properties
      */
     static convert(standardMaterial: MeshStandardMaterial, options?: Partial<StandardToBasicConverterOptions>): MeshBasicMaterial;
 }

package/dist/StandardToLambertConverter.d.ts

@@ -1,58 +1,40 @@
 import type { MeshStandardMaterial } from "three";
 import { MeshLambertMaterial } from "three";
 /**
- * Configuration options for the StandardToLambertConverter.
+ * Configuration options for material conversion.
  */
 export interface StandardToLambertConverterOptions {
     /**
-     * Whether to preserve the original material's name
+     * Preserve original material name.
      * @defaultValue true
      */
     preserveName: boolean;
     /**
-     * Whether to copy user data from the original material
+     * Copy user data from original material.
      * @defaultValue true
      */
     copyUserData: boolean;
     /**
-     * Whether to dispose the original material after conversion
+     * Dispose original material after conversion.
      * @defaultValue false
      */
     disposeOriginal: boolean;
     /**
-     * Custom color adjustment factor for roughness compensation
+     * Color adjustment factor for roughness compensation.
      * @defaultValue 0.8
      */
     roughnessColorFactor: number;
 }
 /**
- * Converts Three.js MeshStandardMaterial to MeshLambertMaterial.
- *
- * Handles translation between PBR properties of StandardMaterial and
- * the Lambertian reflectance model used by LambertMaterial. Applies
- * color compensation based on metalness and roughness values.
+ * Converts MeshStandardMaterial to MeshLambertMaterial with PBR compensation.
  */
 export declare class StandardToLambertConverter {
     /**
-     * Converts a MeshStandardMaterial to MeshLambertMaterial.
+     * Converts MeshStandardMaterial to MeshLambertMaterial.
      *
-     * Performs conversion from PBR StandardMaterial to Lambert lighting model
-     * with color compensation based on metalness and roughness values.
-     *
-     * @param material - The source MeshStandardMaterial to convert
-     * @param options - Configuration options for the conversion
-     * @returns A new MeshLambertMaterial with properties mapped from the standard material
-     *
-     * @example
-     * ```typescript
-     * const standardMaterial = new MeshStandardMaterial({
-     *   color: 0xff0000,
-     *   metalness: 0.8,
-     *   roughness: 0.2
-     * });
-     *
-     * const lambertMaterial = StandardToLambertConverter.convert(standardMaterial);
-     * ```
+     * @param material - Source material to convert
+     * @param options - Conversion options
+     * @returns New MeshLambertMaterial with mapped properties
      */
     static convert(material: MeshStandardMaterial, options?: Partial<StandardToLambertConverterOptions>): MeshLambertMaterial;
 }

package/dist/Sun.d.ts

@@ -1,11 +1,7 @@
 import type { Texture } from "three";
 import { Box3, DirectionalLight } from "three";
 /**
- * A directional light with spherical positioning controls.
- *
- * Extends Three.js DirectionalLight to provide spherical coordinate control
- * (distance, elevation, azimuth) and shadow map configuration for bounding boxes.
- * Also supports sun direction calculation from HDR environment maps.
+ * Directional light with spherical positioning and HDR environment support.
  */
 export declare class Sun extends DirectionalLight {
     /** Internal vectors to avoid garbage collection during calculations */
@@ -20,59 +16,40 @@ export declare class Sun extends DirectionalLight {
     private readonly tempBox3;
     private readonly tempSpherical;
     /**
-     * Gets the distance from the light's position to the origin.
-     *
-     * @returns The distance in world units
+     * @returns Distance from light position to origin
      */
     get distance(): number;
     /**
-     * Gets the elevation angle from the spherical coordinates.
-     *
-     * @returns The elevation angle in radians (phi angle from Three.js Spherical coordinates)
+     * @returns Elevation angle in radians (phi angle)
      */
     get elevation(): number;
     /**
-     * Gets the azimuth angle from the spherical coordinates.
-     *
-     * @returns The azimuth angle in radians (theta angle from Three.js Spherical coordinates)
+     * @returns Azimuth angle in radians (theta angle)
      */
     get azimuth(): number;
     /**
-     * Sets the distance while preserving current elevation and azimuth angles.
-     *
-     * @param value - The new distance in world units
+     * @param value - New distance in world units
      */
     set distance(value: number);
     /**
-     * Sets the elevation angle while preserving current distance and azimuth.
-     *
-     * @param value - The new elevation angle in radians (phi angle for Three.js Spherical coordinates)
+     * @param value - New elevation angle in radians (phi angle)
      */
     set elevation(value: number);
     /**
-     * Sets the azimuth angle while preserving current distance and elevation.
-     *
-     * @param value - The new azimuth angle in radians (theta angle for Three.js Spherical coordinates)
+     * @param value - New azimuth angle in radians (theta angle)
      */
     set azimuth(value: number);
     /**
-     * Configures the shadow camera frustum to cover a bounding box.
+     * Configures shadow camera frustum to cover bounding box.
      *
-     * Adjusts the directional light's shadow camera frustum to encompass the
-     * provided bounding box by transforming box corners to light space and
-     * setting camera bounds accordingly.
-     *
-     * @param box3 - The 3D bounding box to cover with shadows
+     * @param box3 - 3D bounding box to cover with shadows
      */
     configureShadowsForBoundingBox(box3: Box3): void;
     /**
-     * Sets the sun's direction based on the brightest point in an HDR environment map.
-     *
-     * Analyzes an HDR texture to find the pixel with the highest luminance value
-     * and positions the sun to shine from that direction using spherical coordinates.
+     * Sets sun direction based on brightest point in HDR environment map.
      *
-     * @param texture - The HDR texture to analyze (must have image data available)
-     * @param distance - The distance to place the sun from the origin
+     * @param texture - HDR texture to analyze (must have image data)
+     * @param distance - Distance to place sun from origin
      */
     setDirectionFromHDRTexture(texture: Texture, distance?: number): void;
 }