retiam 1.0.0 → 1.0.2

package/dist/src/engine/_core/Material.d.ts

@@ -1,6 +1,6 @@
 import { Color } from '../math/Color';
 import { SubTexture } from '../loader/SubTexture';
-import { ShadingStyle } from '../render/RenderConfig';
+import { Shading, ShadingStyle } from '../material/shading';
 export type TextureSource = string | ImageBitmap | HTMLCanvasElement | OffscreenCanvas | HTMLImageElement | HTMLVideoElement | HTMLElement | SubTexture;
 /**
  * Bitmask flags to track which material properties were explicitly set by the user.
@@ -21,8 +21,7 @@ export declare enum MaterialFlags {
     ALBEDO_IDX = 2048,
     NORMAL_IDX = 4096,
     NORMAL_SCALE = 8192,
-    SHADING_STYLE = 16384,
-    STYLE_PARAMS = 32768
+    SHADING_STYLE = 16384
 }
 /**
  * Manages rendering material parameters (reflectance, roughness, metallic, normal scaling) for an [[Entity]],
@@ -52,6 +51,7 @@ export declare class Material {
     readonly _emColor: Float32Array;
     private _albedoMap?;
     private _normalMap?;
+    private _shading;
     /**
      * Creates a new Material instance.
      *
@@ -151,22 +151,17 @@ export declare class Material {
     setSpecular(v: number): Material;
     /** Sets the normal map scale strength. */
     setNormalScale(v: number): Material;
-    /** Shading style override for this material (-1: inherit from RenderConfig, 0: PBR, 1: Gooch, 2: Cel, 3: Clay). */
+    /** Surface lighting override. Null inherits the parent material or scene default. */
+    get shading(): Shading | null;
+    set shading(value: Shading | null);
+    /** Selects a shading model using its name, or -1 to inherit. */
     get shadingStyle(): ShadingStyle | number;
-    set shadingStyle(v: ShadingStyle | number);
-    get goochWarm(): number;
-    set goochWarm(v: number);
-    get goochCool(): number;
-    set goochCool(v: number);
-    get celBands(): number;
-    set celBands(v: number);
-    get rimStrength(): number;
-    set rimStrength(v: number);
-    get rimPower(): number;
-    set rimPower(v: number);
-    setShadingStyle(v: ShadingStyle | number): Material;
-    setGooch(warm?: number, cool?: number): Material;
-    setCel(bands?: number, rimStrength?: number): Material;
+    set shadingStyle(value: ShadingStyle | number);
+    setShadingStyle(value: ShadingStyle | number): this;
+    setGooch(warm?: number, cool?: number): this;
+    setCel(bands?: number, rimStrength?: number, rimPower?: number): this;
+    /** Numeric settings interpolate within a model; model changes happen at the endpoint. */
+    interpolateShading(start: Material, target: Material, t: number): void;
     /** Clones this material instance. */
     copy(): Material;
     clone(): Material;

package/dist/src/engine/_core/Scene.d.ts

@@ -11,6 +11,7 @@ import { Entity } from './Entity';
 import { Compute, ComputeCommand } from '../compute/Compute';
 import { RenderCommand } from './SceneInterface';
 import { RenderConfig } from '../render/RenderConfig';
+import { Shading } from '../material/shading';
 import { Pass } from '../render/frame_graph/Pass';
 import { GroupAnimator } from '../animation/GroupAnimator';
 import { SnapshotManager } from './SnapshotManager';
@@ -386,6 +387,8 @@ export declare class Scene {
      */
     onAfterReset(): void;
     enableFrameFeedback(): FrameFeedbackFeature;
+    /** Default surface lighting for this scene; individual materials can override it. */
+    shading: Shading;
     _renderConfig: RenderConfig;
     get renderConfig(): RenderConfig;
     addCompute(...compute_commands: ComputeCommand[]): void;

package/dist/src/engine/_core/SnapshotManager.d.ts

@@ -1,8 +1,10 @@
 import { Scene } from './Scene';
+import { Shading } from '../material/shading';
 export interface EntitySnapshot {
     id: number;
     visibility: boolean;
     stateData: Float32Array;
+    shading?: Shading | null;
 }
 export interface AnimationSnapshot {
     type: string;
@@ -30,6 +32,7 @@ export interface SceneSnapshot {
     entities: EntitySnapshot[];
     animations: AnimationSnapshot[];
     isPaused: boolean;
+    shading?: Shading;
 }
 /**
  * Manages deterministic scene state checkpoints and snapshots.

package/dist/src/engine/components/fragment/ModelFragment.d.ts

@@ -6,13 +6,8 @@ export declare class ModelFragment extends FragmentComponent {
     private _lastShadowState;
     private _lastShadowMethod;
     private _lastLightSize;
-    private _lastShadingStyle;
+    private _shading;
     private _lastIsTransparent;
-    private _lastGoochWarm;
-    private _lastGoochCool;
-    private _lastCelBands;
-    private _lastCelRimStrength;
-    private _lastCelRimPower;
     prepare(scene: Scene, state?: State): void;
     setup(builder: ShaderBuilder, passName: string): void;
     isPassActive(passName: string, state: State): boolean;

package/dist/src/engine/material/shading/CelShading.d.ts

@@ -0,0 +1,16 @@
+import { Shading } from './Shading';
+export interface CelShadingOptions {
+    bands?: number;
+    rimStrength?: number;
+    rimPower?: number;
+}
+/** Cartoon lighting bands with an optional silhouette highlight. */
+export declare class CelShading extends Shading {
+    bands: number;
+    rimStrength: number;
+    rimPower: number;
+    constructor({ bands, rimStrength, rimPower }?: CelShadingOptions);
+    writeParameters(target: Float32Array, offset: number): void;
+    interpolate(start: CelShading, target: CelShading, t: number): void;
+    clone(): CelShading;
+}

package/dist/src/engine/material/shading/ClayShading.d.ts

@@ -0,0 +1,6 @@
+import { Shading } from './Shading';
+/** Matte studio lighting for inspecting shapes. */
+export declare class ClayShading extends Shading {
+    constructor();
+    clone(): ClayShading;
+}

package/dist/src/engine/material/shading/GoochShading.d.ts

@@ -0,0 +1,14 @@
+import { Shading } from './Shading';
+export interface GoochShadingOptions {
+    warm?: number;
+    cool?: number;
+}
+/** Warm/cool lighting for technical illustrations. */
+export declare class GoochShading extends Shading {
+    warm: number;
+    cool: number;
+    constructor({ warm, cool }?: GoochShadingOptions);
+    writeParameters(target: Float32Array, offset: number): void;
+    interpolate(start: GoochShading, target: GoochShading, t: number): void;
+    clone(): GoochShading;
+}

package/dist/src/engine/material/shading/PBRShading.d.ts

@@ -0,0 +1,6 @@
+import { Shading } from './Shading';
+/** Physically based surface lighting using the material's roughness and metallic values. */
+export declare class PBRShading extends Shading {
+    constructor();
+    clone(): PBRShading;
+}

package/dist/src/engine/material/shading/Shading.d.ts

@@ -0,0 +1,17 @@
+export declare enum ShadingStyle {
+    PBR = "pbr",
+    GOOCH = "gooch",
+    CEL = "cel",
+    CLAY = "clay"
+}
+/** A surface lighting model. Numeric parameters are written to the material GPU buffer. */
+export declare abstract class Shading {
+    readonly style: ShadingStyle;
+    readonly chunk: string;
+    readonly fragment: string;
+    protected constructor(style: ShadingStyle, chunk: string, fragment: string);
+    writeParameters(target: Float32Array, offset: number): void;
+    /** Interpolate numeric settings between two instances of this lighting model. */
+    interpolate(start: Shading, target: Shading, t: number): void;
+    abstract clone(): Shading;
+}

package/dist/src/engine/material/shading/index.d.ts

@@ -0,0 +1,5 @@
+export { Shading, ShadingStyle } from './Shading';
+export { PBRShading } from './PBRShading';
+export { CelShading, type CelShadingOptions } from './CelShading';
+export { GoochShading, type GoochShadingOptions } from './GoochShading';
+export { ClayShading } from './ClayShading';

package/dist/src/engine/render/RenderConfig.d.ts

@@ -17,12 +17,7 @@ export declare enum DenoiserType {
     OIDN = "oidn",
     NATIVE = "native"
 }
-export declare enum ShadingStyle {
-    PBR = "pbr",
-    GOOCH = "gooch",
-    CEL = "cel",
-    CLAY = "clay"
-}
+export { ShadingStyle } from '../material/shading/Shading';
 export declare enum ShadowMethod {
     PCF = "pcf",
     PCSS = "pcss"
@@ -37,12 +32,6 @@ export declare class RenderConfig {
     shadowMethod: ShadowMethod;
     lightSize: number;
     frustumCulling: boolean;
-    shadingStyle: ShadingStyle;
-    celBands: number;
-    celRimStrength: number;
-    celRimPower: number;
-    goochWarm: number;
-    goochCool: number;
     raytraceEnabled: boolean;
     rtSamples: number;
     rtMaxAccumulation: number;
@@ -51,15 +40,4 @@ export declare class RenderConfig {
     bounce_count: number;
     denoiser: DenoiserType;
     oidnModel: string;
-    /** Apply Cel/Toon shading with optional parameters. Chainable. */
-    setCel(options?: {
-        bands?: number;
-        rimStrength?: number;
-        rimPower?: number;
-    }): this;
-    /** Apply Gooch technical illustration shading. Chainable. */
-    setGooch(options?: {
-        warm?: number;
-        cool?: number;
-    }): this;
 }

package/dist/src/index.d.ts

@@ -436,3 +436,4 @@ export * from './engine/utils/SubdivisionEngine';
 export * from './engine/utils/Utility';
 export * from './engine/utils/gpu_utils';
 export * from './plugins/OutlinePlugin';
+export * from './engine/material/shading';

package/package.json

@@ -1,117 +1,108 @@
-{
-  "name": "retiam",
-  "version": "1.0.0",
-  "description": "WebGPU powered animation engine",
-  "type": "module",
-  "main": "./dist/retiam.es.js",
-  "module": "./dist/retiam.es.js",
-  "types": "./dist/src/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/src/index.d.ts",
-      "import": "./dist/retiam.es.js"
-    },
-    "./dist/assets/*": "./dist/assets/*",
-    "./*": {
-      "types": "./dist/libs/*/index.d.ts",
-      "import": "./dist/libs/*/index.js"
-    }
-  },
-  "bin": {
-    "retiam": "./bin/cli.js"
-  },
-  "files": [
-    "dist/*.js",
-    "dist/assets/**",
-    "dist/libs/**/*.js",
-    "dist/libs/**/*.d.ts",
-    "dist/src/**/*.d.ts",
-    "bin"
-  ],
-  "scripts": {
-    "dev": "vite",
-    "build": "tsc && vite build",
-    "prepack": "npm run build",
-    "build:watch": "vite build --watch",
-    "export": "node ./bin/cli.js export",
-    "render": "node ./bin/cli.js render",
-    "lint:scene": "node ./bin/cli.js lint",
-    "snapshot": "node ./bin/cli.js snapshot",
-    "init": "node ./bin/cli.js init",
-    "create": "node ./bin/cli.js create",
-    "cdn": "vite preview",
-    "start": "npm run dev",
+{
+  "name": "retiam",
+  "version": "1.0.2",
+  "description": "WebGPU powered animation engine",
+  "type": "module",
+  "main": "./dist/retiam.es.js",
+  "module": "./dist/retiam.es.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/retiam.es.js"
+    },
+    "./dist/assets/*": "./dist/assets/*",
+    "./*": {
+      "types": "./dist/libs/*/index.d.ts",
+      "import": "./dist/libs/*/index.js"
+    }
+  },
+  "bin": {
+    "retiam": "./bin/cli.js"
+  },
+  "files": [
+    "dist/*.js",
+    "dist/assets/**",
+    "dist/libs/**/*.js",
+    "dist/libs/**/*.d.ts",
+    "dist/src/**/*.d.ts",
+    "bin"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "prepack": "npm run build",
+    "build:watch": "vite build --watch",
+    "export": "node ./bin/cli.js export",
+    "render": "node ./bin/cli.js render",
+    "lint:scene": "node ./bin/cli.js lint",
+    "snapshot": "node ./bin/cli.js snapshot",
+    "init": "node ./bin/cli.js init",
+    "create": "node ./bin/cli.js create",
+    "cdn": "vite preview",
+    "start": "npm run dev",
     "resolve": "npm i",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-    "test:distribution": "node --import tsx --test test/library_portability_test.ts test/package_contents_test.mjs",
-    "unit-test": "ts-node-esm test/test.ts",
-    "gen-context": "ts-node tools/context_gen/context_generator.ts ./src",
-    "gen-index": "node ./tools/index_generator/generate-index.cjs"
-  },
-  "author": "Abhilas Biswas",
-  "license": "ISC",
-  "devDependencies": {
-    "@lightningjs/msdf-generator": "^1.1.1",
-    "@types/earcut": "^3.0.0",
-    "@types/events": "^3.0.3",
-    "@types/integer": "^4.0.3",
-    "@types/jest": "^29.5.12",
-    "@types/matter-js": "^0.20.2",
-    "@types/node": "^22.2.0",
-    "@webgpu/types": "^0.1.31",
-    "jest": "^29.7.0",
-    "msdf-atlas-gen": "^1.0.0",
-    "msdf-bmfont-xml": "^2.7.0",
-    "puppeteer": "^21.11.0",
-    "roughjs": "^4.6.6",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2",
-    "tsx": "^4.22.4",
-    "vite-plugin-dts": "^5.0.1",
-    "vite-plugin-mkcert": "^2.0.0"
-  },
-  "peerDependencies": {
-    "roughjs": "^4.6.6",
-    "puppeteer": ">=21"
-  },
-  "peerDependenciesMeta": {
-    "roughjs": {
-      "optional": true
-    },
-    "puppeteer": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "@dimforge/rapier2d-compat": "^0.20.0",
-    "@dimforge/rapier3d-compat": "^0.20.0",
-    "@types/libtess": "^1.2.0",
-    "@types/prismjs": "^1.26.6",
-    "@zappar/msdf-generator": "^1.2.4",
-    "box3d-wasm": "^0.2.0",
-    "cli-progress": "^3.12.0",
-    "earcut": "^3.0.2",
-    "events": "^3.3.0",
-    "extrude-polyline": "^1.0.6",
-    "jolt-physics": "^1.1.0",
-    "libtess": "^1.2.2",
-    "mathjax-full": "^3.2.2",
-    "matter-js": "^0.20.0",
-    "mp4-muxer": "^5.2.2",
-    "msedge-tts": "^2.0.8",
-    "oidn-web": "^0.3.5",
-    "opentype.js": "^1.3.4",
-    "path-data-parser": "^0.1.0",
-    "planck": "^1.5.0",
-    "polygon-clipping": "^0.15.7",
-    "prismjs": "^1.30.0",
-    "svg-parser": "^2.0.4",
-    "svg-pathdata": "^7.0.0",
-    "typescript": "^5.4.5",
-    "vite": "^6.1.1",
-    "webm-muxer": "^5.1.4",
-    "wgsl_reflect": "^1.2.3",
-    "woff2-encoder": "^2.0.0",
-    "ws": "^8.16.0"
-  }
-}
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test:distribution": "node --import tsx --test test/library_portability_test.ts test/package_contents_test.mjs test/render_config_test.mjs",
+    "test:create": "node --test test/create_retiam_test.mjs",
+    "test:shading": "npm run build && node --test test/shading_test.mjs test/shading_browser.test.mjs",
+    "test:studio-layout": "node --test test/studio_layout.test.mjs",
+    "unit-test": "ts-node-esm test/test.ts",
+    "gen-context": "ts-node tools/context_gen/context_generator.ts ./src",
+    "gen-index": "node ./tools/index_generator/generate-index.cjs"
+  },
+  "author": "Abhilas Biswas",
+  "license": "ISC",
+  "devDependencies": {
+    "@lightningjs/msdf-generator": "^1.1.1",
+    "@types/earcut": "^3.0.0",
+    "@types/events": "^3.0.3",
+    "@types/integer": "^4.0.3",
+    "@types/jest": "^29.5.12",
+    "@types/matter-js": "^0.20.2",
+    "@types/node": "^22.2.0",
+    "@webgpu/types": "^0.1.31",
+    "jest": "^29.7.0",
+    "msdf-atlas-gen": "^1.0.0",
+    "msdf-bmfont-xml": "^2.7.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.22.4",
+    "vite-plugin-dts": "^5.0.1",
+    "vite-plugin-mkcert": "^2.0.0"
+  },
+  "dependencies": {
+    "@dimforge/rapier2d-compat": "^0.20.0",
+    "@dimforge/rapier3d-compat": "^0.20.0",
+    "@types/libtess": "^1.2.0",
+    "@types/prismjs": "^1.26.6",
+    "@zappar/msdf-generator": "^1.2.4",
+    "box3d-wasm": "^0.2.0",
+    "cli-progress": "^3.12.0",
+    "earcut": "^3.0.2",
+    "events": "^3.3.0",
+    "extrude-polyline": "^1.0.6",
+    "jolt-physics": "^1.1.0",
+    "libtess": "^1.2.2",
+    "mathjax-full": "^3.2.2",
+    "matter-js": "^0.20.0",
+    "mp4-muxer": "^5.2.2",
+    "msedge-tts": "^2.0.8",
+    "oidn-web": "^0.3.5",
+    "opentype.js": "^1.3.4",
+    "path-data-parser": "^0.1.0",
+    "planck": "^1.5.0",
+    "polygon-clipping": "^0.15.7",
+    "prismjs": "^1.30.0",
+    "puppeteer": "^21.11.0",
+    "roughjs": "^4.6.6",
+    "svg-parser": "^2.0.4",
+    "svg-pathdata": "^7.0.0",
+    "typescript": "^5.4.5",
+    "vite": "^6.1.1",
+    "webm-muxer": "^5.1.4",
+    "wgsl_reflect": "^1.2.3",
+    "woff2-encoder": "^2.0.0",
+    "ws": "^8.16.0"
+  }
+}