manim-web 0.15.1 → 0.17.0

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

@@ -0,0 +1,122 @@
+import { Vector3Tuple } from '../../core/Mobject';
+import { Mobject3D } from './Mobject3D';
+import { ScalarField3D } from './marchingCubes';
+import * as THREE from 'three';
+/**
+ * Options for creating an ImplicitSurface.
+ */
+export interface ImplicitSurfaceOptions {
+    /** The scalar field f(x, y, z). The surface is the level set f = isoLevel. */
+    func: ScalarField3D;
+    /** X range [min, max]. Default: [-2, 2] */
+    xRange?: [number, number];
+    /** Y range [min, max]. Default: [-2, 2] */
+    yRange?: [number, number];
+    /** Z range [min, max]. Default: [-2, 2] */
+    zRange?: [number, number];
+    /** Grid cells per axis for the marching-cubes sampling. Default: 24 */
+    resolution?: number;
+    /** The iso level of the extracted surface. Default: 0 */
+    isoLevel?: number;
+    /** Color as CSS color string. Default: '#58c4dd' (Manim blue) */
+    color?: string;
+    /** Opacity from 0 to 1. Default: 1 */
+    opacity?: number;
+    /** Render as wireframe. Default: false */
+    wireframe?: boolean;
+    /** Render both sides. Default: true */
+    doubleSided?: boolean;
+    /** Center position [x, y, z]. Default: [0, 0, 0] */
+    center?: Vector3Tuple;
+}
+/**
+ * ImplicitSurface - the 3D isosurface f(x, y, z) = isoLevel.
+ *
+ * The surface is built with marching cubes (see {@link marchingCubes}) over a
+ * sampled grid, so an arbitrary smooth scalar field can be visualised without a
+ * parametrisation. It extends {@link Mobject3D} and reuses the Surface3D
+ * material and depth conventions, including the transparent depth prepass from
+ * issue #416, so a translucent isosurface occludes itself correctly.
+ *
+ * @example
+ * ```typescript
+ * // A unit sphere: x^2 + y^2 + z^2 = 1
+ * const sphere = new ImplicitSurface({
+ *   func: (x, y, z) => x * x + y * y + z * z,
+ *   isoLevel: 1,
+ *   resolution: 32,
+ * });
+ *
+ * // A torus implicit surface
+ * const torus = new ImplicitSurface({
+ *   func: (x, y, z) => {
+ *     const q = Math.sqrt(x * x + y * y) - 1;
+ *     return q * q + z * z;
+ *   },
+ *   isoLevel: 0.09,
+ *   opacity: 0.6,
+ * });
+ * ```
+ */
+export declare class ImplicitSurface extends Mobject3D {
+    private _func;
+    private _xRange;
+    private _yRange;
+    private _zRange;
+    private _resolution;
+    private _isoLevel;
+    private _wireframe;
+    private _doubleSided;
+    private _centerPoint;
+    private _positions;
+    private _triangleCount;
+    constructor(options: ImplicitSurfaceOptions);
+    /** Run marching cubes and cache the resulting triangle soup. */
+    private _computeSurface;
+    /** Build an indexed-free BufferGeometry with smooth normals from the cache. */
+    private _buildGeometry;
+    /**
+     * The depth prepass only helps a translucent solid. An opaque surface
+     * already writes depth, a wireframe must stay visible, and a faded-out
+     * surface must not depth-block other transparent objects.
+     */
+    private _prepassEnabled;
+    /** Enable or disable the prepass; disabled means skipped by the renderer. */
+    private _applyPrepassState;
+    /** Find the depth-prepass child mesh, if this surface has one. */
+    private _getPrepassMesh;
+    /**
+     * Create the Three.js mesh. A transparent surface renders in two passes to
+     * fix self-occlusion (issue #416): a depth-only prepass writes the front-most
+     * layer, then the color pass depth-tests against it. The prepass mesh is
+     * created before the color mesh so its lower object.id wins three.js'
+     * reversePainterSortStable tiebreak and draws first.
+     */
+    protected _createThreeObject(): THREE.Object3D;
+    /** Sync material properties to the Three.js object. */
+    protected _syncMaterialToThree(): void;
+    /** Recompute the surface and rebind the geometry on both meshes. */
+    private _updateGeometry;
+    /** The flat vertex positions of the surface triangles. */
+    getPositions(): Float32Array;
+    /** The number of triangles in the surface. */
+    getTriangleCount(): number;
+    /** Get the scalar field. */
+    getFunc(): ScalarField3D;
+    /** Set a new scalar field and rebuild the surface. */
+    setFunc(func: ScalarField3D): this;
+    /** Get the iso level. */
+    getIsoLevel(): number;
+    /** Set the iso level and rebuild the surface. */
+    setIsoLevel(isoLevel: number): this;
+    /** Get the grid resolution. */
+    getResolution(): number;
+    /** Set the grid resolution and rebuild the surface. */
+    setResolution(resolution: number): this;
+    /** Whether wireframe mode is enabled. */
+    isWireframe(): boolean;
+    /** Set wireframe mode. */
+    setWireframe(value: boolean): this;
+    copy(): ImplicitSurface;
+}
+//# sourceMappingURL=ImplicitSurface.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ImplicitSurface.d.ts","sourceRoot":"","sources":["../../../src/mobjects/three-d/ImplicitSurface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAiB,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,8EAA8E;IAC9E,IAAI,EAAE,aAAa,CAAC;IACpB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1B,2CAA2C;IAC3C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1B,2CAA2C;IAC3C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1B,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uCAAuC;IACvC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oDAAoD;IACpD,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,eAAgB,SAAQ,SAAS;IAC5C,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,UAAU,CAAe;IACjC,OAAO,CAAC,cAAc,CAAS;gBAEnB,OAAO,EAAE,sBAAsB;IAqC3C,gEAAgE;IAChE,OAAO,CAAC,eAAe;IAavB,+EAA+E;IAC/E,OAAO,CAAC,cAAc;IAOtB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAIvB,6EAA6E;IAC7E,OAAO,CAAC,kBAAkB;IAM1B,kEAAkE;IAClE,OAAO,CAAC,eAAe;IAUvB;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,IAAI,KAAK,CAAC,QAAQ;IA4B9C,uDAAuD;cACpC,oBAAoB,IAAI,IAAI;IAoB/C,oEAAoE;IACpE,OAAO,CAAC,eAAe;IAavB,0DAA0D;IAC1D,YAAY,IAAI,YAAY;IAI5B,8CAA8C;IAC9C,gBAAgB,IAAI,MAAM;IAI1B,4BAA4B;IAC5B,OAAO,IAAI,aAAa;IAIxB,sDAAsD;IACtD,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAMlC,yBAAyB;IACzB,WAAW,IAAI,MAAM;IAIrB,iDAAiD;IACjD,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMnC,+BAA+B;IAC/B,aAAa,IAAI,MAAM;IAIvB,uDAAuD;IACvD,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAMvC,yCAAyC;IACzC,WAAW,IAAI,OAAO;IAItB,0BAA0B;IAC1B,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAMzB,IAAI,IAAI,eAAe;CAiBjC"}

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

@@ -18,4 +18,6 @@ export { TexturedSurface, texturedSphere, type TexturedSurfaceOptions, type Text
 export { ThreeDAxes, type ThreeDAxesOptions } from './ThreeDAxes';
 export { Prism, Dot3D, ThreeDVMobject, type PrismOptions, type Dot3DOptions, type ThreeDVMobjectOptions, } from './ThreeDExtensions';
 export { ConvexHull3D, type ConvexHull3DOptions } from './ConvexHull3D';
+export { marchingCubes, type MarchingCubesOptions, type MarchingCubesResult, type ScalarField3D, } from './marchingCubes';
+export { ImplicitSurface, type ImplicitSurfaceOptions } from './ImplicitSurface';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/mobjects/three-d/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,eAAe,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AACpF,OAAO,EAAE,KAAK,EAAE,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAGnD,OAAO,EACL,UAAU,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,YAAY,EACZ,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAGnE,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,KAAK,wBAAwB,GAC9B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,eAAe,EACf,cAAc,EACd,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGlE,OAAO,EACL,KAAK,EACL,KAAK,EACL,cAAc,EACd,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,qBAAqB,GAC3B,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/mobjects/three-d/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,eAAe,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AACpF,OAAO,EAAE,KAAK,EAAE,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAGnD,OAAO,EACL,UAAU,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,YAAY,EACZ,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAGnE,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,KAAK,wBAAwB,GAC9B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,eAAe,EACf,cAAc,EACd,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGlE,OAAO,EACL,KAAK,EACL,KAAK,EACL,cAAc,EACd,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,qBAAqB,GAC3B,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAGxE,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,aAAa,GACnB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,eAAe,EAAE,KAAK,sBAAsB,EAAE,MAAM,mBAAmB,CAAC"}

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"}