manim-web 0.16.0 → 0.18.0

package/dist/mobjects/three-d/marchingCubes.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Marching-cubes isosurface extraction for a 3D scalar field.
+ *
+ * The algorithm samples a scalar field `f(x, y, z)` on a regular grid and
+ * extracts the triangle mesh of the level set `f = iso`. This module uses the
+ * marching-tetrahedra variant: it splits every grid cube into six tetrahedra
+ * that share the cube's main diagonal, then polygonises each tetrahedron. The
+ * tetrahedral form needs no 256-entry lookup table, so it is compact and
+ * watertight, at the cost of more triangles than classic marching cubes.
+ *
+ * The output is a non-indexed triangle soup as a flat `Float32Array`. Three.js
+ * recomputes smooth normals from it, and manim-web renders the surface
+ * double-sided, so triangle winding does not affect the shaded result.
+ */
+/** A scalar field sampled at a point in space. */
+export type ScalarField3D = (x: number, y: number, z: number) => number;
+/** Options that control how the grid is sampled. */
+export interface MarchingCubesOptions {
+    /** The scalar field to polygonise. */
+    field: ScalarField3D;
+    /** X range as [min, max]. */
+    xRange: [number, number];
+    /** Y range as [min, max]. */
+    yRange: [number, number];
+    /** Z range as [min, max]. */
+    zRange: [number, number];
+    /** Grid cells per axis. A higher value gives a finer surface. */
+    resolution: number;
+    /** The iso level of the extracted surface. */
+    isoLevel: number;
+}
+/** The polygonised surface as a non-indexed triangle soup. */
+export interface MarchingCubesResult {
+    /** Flat vertex positions: `[x0, y0, z0, x1, y1, z1, ...]`. */
+    positions: Float32Array;
+    /** The number of triangles. */
+    triangleCount: number;
+}
+/**
+ * Extract the isosurface `field = isoLevel` over the sampled grid.
+ *
+ * The grid holds `resolution` cells per axis, so it samples
+ * `(resolution + 1)^3` points. Field values are evaluated once per grid point
+ * and cached, so the output is deterministic for a given input.
+ */
+export declare function marchingCubes(options: MarchingCubesOptions): MarchingCubesResult;
+//# sourceMappingURL=marchingCubes.d.ts.map

package/dist/mobjects/three-d/marchingCubes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"marchingCubes.d.ts","sourceRoot":"","sources":["../../../src/mobjects/three-d/marchingCubes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAExE,oDAAoD;AACpD,MAAM,WAAW,oBAAoB;IACnC,sCAAsC;IACtC,KAAK,EAAE,aAAa,CAAC;IACrB,6BAA6B;IAC7B,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzB,6BAA6B;IAC7B,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzB,6BAA6B;IAC7B,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,8DAA8D;AAC9D,MAAM,WAAW,mBAAmB;IAClC,8DAA8D;IAC9D,SAAS,EAAE,YAAY,CAAC;IACxB,+BAA+B;IAC/B,aAAa,EAAE,MAAM,CAAC;CACvB;AA8FD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,mBAAmB,CA8DhF"}

package/dist/mobjects/three-d/objMaterials.d.ts

@@ -0,0 +1,54 @@
+import { ModelLoader } from './ModelMobject';
+/** A preloaded MTL material set. Three.js MaterialCreator satisfies it. */
+export interface MtlMaterials {
+    preload(): void;
+}
+/**
+ * The minimal MTLLoader contract ModelMobject needs. Three.js MTLLoader
+ * satisfies it structurally. Tests implement it with a stub.
+ */
+export interface MtlLoader {
+    setPath(path: string): MtlLoader;
+    setResourcePath(path: string): MtlLoader;
+    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<MtlMaterials>;
+}
+/**
+ * The OBJLoader subset that accepts materials. OBJLoader.setMaterials applies
+ * the given materials to the meshes it then parses.
+ */
+export interface ObjMaterialSink {
+    setMaterials(materials: MtlMaterials): void;
+}
+/** Builds an MTLLoader. The DI seam set by `setMtlLoaderFactory`. */
+export type MtlLoaderFactory = () => MtlLoader | Promise<MtlLoader>;
+/** The options that drive OBJ material loading. A subset of ModelMobjectOptions. */
+export interface ObjMaterialOptions {
+    /** Explicit companion .mtl URL. Takes priority over `loadMaterials`. */
+    mtlUrl?: string;
+    /** Auto-derive the .mtl URL from the .obj URL and load it. Default: false. */
+    loadMaterials?: boolean;
+    /** Inject an MTLLoader directly (bypasses the factory and the network). */
+    mtlLoader?: MtlLoader;
+    /** Progress callback forwarded to the MTLLoader. */
+    onProgress?: (event: ProgressEvent) => void;
+}
+/**
+ * Inject an MTLLoader factory, replacing the lazy-loaded Three.js MTLLoader.
+ * Pass `null` to restore the default. Tests use this to avoid any real loader.
+ */
+export declare function setMtlLoaderFactory(factory: MtlLoaderFactory | null): void;
+/** The directory part of a URL, with its trailing slash; ignores query and fragment. */
+export declare function deriveBasePath(url: string): string;
+/** The companion .mtl URL for an .obj URL (same name, .mtl extension). */
+export declare function deriveMtlUrl(objUrl: string): string;
+/**
+ * Load the companion .mtl and hand its materials to the OBJ loader before it
+ * parses. Call this on the resolved OBJ loader before `loadAsync`.
+ *
+ * It is a no-op when neither `mtlUrl` nor `loadMaterials` is set (so an OBJ
+ * loads exactly as before), and when the loader cannot accept materials. The
+ * MTLLoader base path and resource path come from the .mtl URL, so texture maps
+ * named in the .mtl load from the same directory.
+ */
+export declare function applyObjMaterials(loader: ModelLoader, objUrl: string, options: ObjMaterialOptions): Promise<void>;
+//# sourceMappingURL=objMaterials.d.ts.map

package/dist/mobjects/three-d/objMaterials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objMaterials.d.ts","sourceRoot":"","sources":["../../../src/mobjects/three-d/objMaterials.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD,2EAA2E;AAC3E,MAAM,WAAW,YAAY;IAC3B,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC5F;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,SAAS,EAAE,YAAY,GAAG,IAAI,CAAC;CAC7C;AAED,qEAAqE;AACrE,MAAM,MAAM,gBAAgB,GAAG,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAEpE,oFAAoF;AACpF,MAAM,WAAW,kBAAkB;IACjC,wEAAwE;IACxE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,oDAAoD;IACpD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;CAC7C;AAKD;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,GAAG,IAAI,CAE1E;AAeD,wFAAwF;AACxF,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIlD;AASD,0EAA0E;AAC1E,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAGnD;AAcD;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAWf"}