@navaramap/three-default-plugin 0.1.1 → 0.2.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2026 Navara contributors
+Copyright (c) 2026 MapLibre contributors
 
 This project is dual-licensed under either of
 

package/dist/index.d.ts

@@ -28,6 +28,8 @@ import { LightProbeConfig } from '@navaramap/three-default-descs';
 import { MeshHandle } from '@navaramap/three';
 import { PlaneMeshConfig } from '@navaramap/three-default-descs';
 import { Plugin as Plugin_2 } from '@navaramap/three';
+import { PolygonMeshConfig } from '@navaramap/three-default-descs';
+import { PolylineMeshConfig } from '@navaramap/three-default-descs';
 import { RainDropConfig } from '@navaramap/three-default-descs';
 import { RainMeshConfig } from '@navaramap/three-default-descs';
 import { SelectiveBloomEffectConfig } from '@navaramap/three-default-descs';
@@ -64,7 +66,7 @@ export declare type DefaultEffectDescription = AerialPerspectiveConfig | CloudsC
 
 export declare type DefaultLightDescription = SunLightConfig | SkyLightProbeConfig | AmbientLightConfig | LightProbeConfig;
 
-export declare type DefaultMeshDescription = RainMeshConfig | SnowMeshConfig | SkyMeshConfig | SkyBoxMeshConfig | StarsConfig | BoxMeshConfig | SphereMeshConfig | GlowGlobeMeshConfig | CylinderMeshConfig | TubeMeshConfig | PlaneMeshConfig | GLTFModelConfig | SplatMeshConfig | AxesHelperConfig | ArrowHelperConfig | ArclineMeshConfig | SmoothLineMeshConfig | InstancedBoxMeshConfig | InstancedSphereMeshConfig | InstancedPlaneMeshConfig | InstancedCylinderMeshConfig | InstancedGltfModelMeshConfig;
+export declare type DefaultMeshDescription = PolygonMeshConfig | PolylineMeshConfig | RainMeshConfig | SnowMeshConfig | SkyMeshConfig | SkyBoxMeshConfig | StarsConfig | BoxMeshConfig | SphereMeshConfig | GlowGlobeMeshConfig | CylinderMeshConfig | TubeMeshConfig | PlaneMeshConfig | GLTFModelConfig | SplatMeshConfig | AxesHelperConfig | ArrowHelperConfig | ArclineMeshConfig | SmoothLineMeshConfig | InstancedBoxMeshConfig | InstancedSphereMeshConfig | InstancedPlaneMeshConfig | InstancedCylinderMeshConfig | InstancedGltfModelMeshConfig;
 
 export declare class DefaultPlugin extends Plugin_2<default_2<DefaultDescriptions>, ViewContext> {
     private view?;
@@ -72,8 +74,21 @@ export declare class DefaultPlugin extends Plugin_2<default_2<DefaultDescription
     /**
      * Add default descriptors automatically to make the photorealistic scene.
      * This method must be invoked after `view.init()`.
+     *
+     * `deferredLighting` lights the scene from the atmosphere in post: it sets
+     * `aerialPerspective.irradiance` and `view.lit = false` together, since the
+     * forward pass would otherwise apply lighting as well. `shadow` and
+     * `specular` enable the sun's shadows and its specular highlight in that
+     * lighting through the aerial perspective's options of the same name. Both
+     * are off by default because either allocates the shadow G-buffer, and
+     * both are inert without `deferredLighting`. Toggle any of them later via
+     * the returned handle and `view.lit`.
      */
-    addDefaultPhotorealScene(): {
+    addDefaultPhotorealScene(options?: {
+        deferredLighting?: boolean;
+        shadow?: boolean;
+        specular?: boolean;
+    }): {
         sky: MeshHandle<SkyMeshDesc>;
         stars: MeshHandle<StarsDesc>;
         skyLightProbe: LightHandle<SkyLightProbeDesc>;

package/dist/index.js

@@ -1,25 +1,29 @@
 import { Plugin as e } from "@navaramap/three";
-import { AerialPerspectiveEffectDesc as t, AmbientLightDesc as n, ArclineMeshDesc as r, ArrowHelperDesc as i, AxesHelperDesc as a, BoxMeshDesc as o, CloudsEffectDesc as s, ColorGradingLUTEffectDesc as c, CylinderMeshDesc as l, DepthOfFieldEffectDesc as u, FXAAEffectDesc as d, FogLightEffectDesc as f, GLTFModelDesc as p, GlowGlobeMeshDesc as m, InstancedBoxMeshDesc as h, InstancedCylinderMeshDesc as g, InstancedGltfModelMeshDesc as _, InstancedPlaneMeshDesc as v, InstancedSphereMeshDesc as y, LensFlareEffectDesc as b, LightProbeDesc as x, PlaneMeshDesc as S, RainDropEffectDesc as C, RainMeshDesc as w, SMAAEffectDesc as T, SSAOEffectDesc as E, SSREffectDesc as D, SelectiveBloomEffectDesc as O, SelectiveOutlineEffectDesc as k, SkyBoxMeshDesc as A, SkyLightProbeDesc as j, SkyMeshDesc as M, SmoothLineMeshDesc as N, SnowMeshDesc as P, SphereMeshDesc as F, SplatMeshDesc as I, StarsDesc as L, SunLightDesc as R, ToneMappingEffectDesc as z, TubeMeshDesc as B } from "@navaramap/three-default-descs";
+import { AerialPerspectiveEffectDesc as t, AmbientLightDesc as n, ArclineMeshDesc as r, ArrowHelperDesc as i, AxesHelperDesc as a, BoxMeshDesc as o, CloudsEffectDesc as s, ColorGradingLUTEffectDesc as c, CylinderMeshDesc as l, DepthOfFieldEffectDesc as u, FXAAEffectDesc as d, FogLightEffectDesc as f, GLTFModelDesc as p, GlowGlobeMeshDesc as m, InstancedBoxMeshDesc as h, InstancedCylinderMeshDesc as g, InstancedGltfModelMeshDesc as _, InstancedPlaneMeshDesc as v, InstancedSphereMeshDesc as y, LensFlareEffectDesc as b, LightProbeDesc as x, PlaneMeshDesc as S, PolygonMeshDesc as C, PolylineMeshDesc as w, RainDropEffectDesc as T, RainMeshDesc as E, SMAAEffectDesc as D, SSAOEffectDesc as O, SSREffectDesc as k, SelectiveBloomEffectDesc as A, SelectiveOutlineEffectDesc as j, SkyBoxMeshDesc as M, SkyLightProbeDesc as N, SkyMeshDesc as P, SmoothLineMeshDesc as F, SnowMeshDesc as I, SphereMeshDesc as L, SplatMeshDesc as R, StarsDesc as z, SunLightDesc as B, ToneMappingEffectDesc as V, TubeMeshDesc as H } from "@navaramap/three-default-descs";
 //#region src/index.ts
-var V = class extends e {
+var U = class extends e {
 	view;
-	async init(e, V) {
-		this.view = e, e.registerMesh("rain", w), e.registerMesh("snow", P), e.registerMesh("sky", M), e.registerMesh("skyBox", A), e.registerMesh("stars", L), e.registerMesh("box", o), e.registerMesh("sphere", F), e.registerMesh("glowGlobe", m), e.registerMesh("cylinder", l), e.registerMesh("tube", B), e.registerMesh("plane", S), e.registerMesh("gltfModel", p), e.registerMesh("splat", I), e.registerMesh("axesHelper", a), e.registerMesh("arrowHelper", i), e.registerMesh("arcLines", r), e.registerMesh("smoothLines", N), e.registerMesh("boxes", h), e.registerMesh("spheres", y), e.registerMesh("planes", v), e.registerMesh("cylinders", g), e.registerMesh("gltfModels", _), e.registerLight("sun", R), e.registerLight("ambient", n), e.registerLight("skyLightProbe", j), e.registerLight("lightProbe", x), e.registerEffect("aerialPerspective", t), e.registerEffect("rainDrop", C), e.registerEffect("selectiveBloom", O), e.registerEffect("selectiveOutline", k), e.registerEffect("clouds", s), e.registerEffect("fogLight", f), e.registerEffect("lensFlare", b), e.registerEffect("ssao", E), e.registerEffect("ssr", D), e.registerEffect("depthOfField", u), e.registerEffect("colorGradingLUT", c), e.registerEffect("toneMapping", z), e.registerEffect("smaa", T), e.registerEffect("fxaa", d);
+	async init(e, U) {
+		this.view = e, e.registerMesh("rain", E), e.registerMesh("snow", I), e.registerMesh("sky", P), e.registerMesh("skyBox", M), e.registerMesh("stars", z), e.registerMesh("box", o), e.registerMesh("sphere", L), e.registerMesh("glowGlobe", m), e.registerMesh("cylinder", l), e.registerMesh("tube", H), e.registerMesh("plane", S), e.registerMesh("gltfModel", p), e.registerMesh("splat", R), e.registerMesh("axesHelper", a), e.registerMesh("arrowHelper", i), e.registerMesh("arcLines", r), e.registerMesh("polygon", C), e.registerMesh("polyline", w), e.registerMesh("smoothLines", F), e.registerMesh("boxes", h), e.registerMesh("spheres", y), e.registerMesh("planes", v), e.registerMesh("cylinders", g), e.registerMesh("gltfModels", _), e.registerLight("sun", B), e.registerLight("ambient", n), e.registerLight("skyLightProbe", N), e.registerLight("lightProbe", x), e.registerEffect("aerialPerspective", t), e.registerEffect("rainDrop", T), e.registerEffect("selectiveBloom", A), e.registerEffect("selectiveOutline", j), e.registerEffect("clouds", s), e.registerEffect("fogLight", f), e.registerEffect("lensFlare", b), e.registerEffect("ssao", O), e.registerEffect("ssr", k), e.registerEffect("depthOfField", u), e.registerEffect("colorGradingLUT", c), e.registerEffect("toneMapping", V), e.registerEffect("smaa", D), e.registerEffect("fxaa", d);
 	}
-	addDefaultPhotorealScene() {
+	addDefaultPhotorealScene(e) {
 		if (!this.view) throw Error("DefaultPlugin is not initialized. Call view.addPlugin() and view.init() first.");
-		let e = this.view, t = e.isMobileOptimized();
-		return {
-			sky: e.addMesh({ sky: {} }),
-			stars: e.addMesh({ stars: {} }),
-			skyLightProbe: e.addLight({ skyLightProbe: {} }),
-			sun: e.addLight({ sun: {} }),
-			aerialPerspective: e.addEffect({ aerialPerspective: {} }),
-			lensFlare: t ? void 0 : e.addEffect({ lensFlare: {} }),
-			toneMapping: e.addEffect({ toneMapping: {} }),
-			antialiasing: t ? e.addEffect({ fxaa: {} }) : e.addEffect({ smaa: {} })
+		let t = this.view, n = t.isMobileOptimized(), r = t.addMesh({ sky: {} }), i = t.addMesh({ stars: {} }), a = t.addLight({ skyLightProbe: {} }), o = t.addLight({ sun: {} }), s = t.addEffect({ aerialPerspective: {
+			...e?.deferredLighting ? { irradiance: !0 } : {},
+			...e?.shadow ? { shadow: !0 } : {},
+			...e?.specular ? { specular: !0 } : {}
+		} });
+		return e?.deferredLighting && (t.lit = !1), {
+			sky: r,
+			stars: i,
+			skyLightProbe: a,
+			sun: o,
+			aerialPerspective: s,
+			lensFlare: n ? void 0 : t.addEffect({ lensFlare: {} }),
+			toneMapping: t.addEffect({ toneMapping: {} }),
+			antialiasing: n ? t.addEffect({ fxaa: {} }) : t.addEffect({ smaa: {} })
 		};
 	}
 };
 //#endregion
-export { V as DefaultPlugin };
+export { U as DefaultPlugin };

package/dist/index.umd.cjs

@@ -1 +1 @@
-(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports,require("@navaramap/three"),require("@navaramap/three-default-descs")):typeof define==`function`&&define.amd?define([`exports`,`@navaramap/three`,`@navaramap/three-default-descs`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.NavaraDefaultPlugin={},e._navaramap_three,e._navaramap_three_default_descs))})(this,function(e,t,n){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`}),e.DefaultPlugin=class extends t.Plugin{view;async init(e,t){this.view=e,e.registerMesh(`rain`,n.RainMeshDesc),e.registerMesh(`snow`,n.SnowMeshDesc),e.registerMesh(`sky`,n.SkyMeshDesc),e.registerMesh(`skyBox`,n.SkyBoxMeshDesc),e.registerMesh(`stars`,n.StarsDesc),e.registerMesh(`box`,n.BoxMeshDesc),e.registerMesh(`sphere`,n.SphereMeshDesc),e.registerMesh(`glowGlobe`,n.GlowGlobeMeshDesc),e.registerMesh(`cylinder`,n.CylinderMeshDesc),e.registerMesh(`tube`,n.TubeMeshDesc),e.registerMesh(`plane`,n.PlaneMeshDesc),e.registerMesh(`gltfModel`,n.GLTFModelDesc),e.registerMesh(`splat`,n.SplatMeshDesc),e.registerMesh(`axesHelper`,n.AxesHelperDesc),e.registerMesh(`arrowHelper`,n.ArrowHelperDesc),e.registerMesh(`arcLines`,n.ArclineMeshDesc),e.registerMesh(`smoothLines`,n.SmoothLineMeshDesc),e.registerMesh(`boxes`,n.InstancedBoxMeshDesc),e.registerMesh(`spheres`,n.InstancedSphereMeshDesc),e.registerMesh(`planes`,n.InstancedPlaneMeshDesc),e.registerMesh(`cylinders`,n.InstancedCylinderMeshDesc),e.registerMesh(`gltfModels`,n.InstancedGltfModelMeshDesc),e.registerLight(`sun`,n.SunLightDesc),e.registerLight(`ambient`,n.AmbientLightDesc),e.registerLight(`skyLightProbe`,n.SkyLightProbeDesc),e.registerLight(`lightProbe`,n.LightProbeDesc),e.registerEffect(`aerialPerspective`,n.AerialPerspectiveEffectDesc),e.registerEffect(`rainDrop`,n.RainDropEffectDesc),e.registerEffect(`selectiveBloom`,n.SelectiveBloomEffectDesc),e.registerEffect(`selectiveOutline`,n.SelectiveOutlineEffectDesc),e.registerEffect(`clouds`,n.CloudsEffectDesc),e.registerEffect(`fogLight`,n.FogLightEffectDesc),e.registerEffect(`lensFlare`,n.LensFlareEffectDesc),e.registerEffect(`ssao`,n.SSAOEffectDesc),e.registerEffect(`ssr`,n.SSREffectDesc),e.registerEffect(`depthOfField`,n.DepthOfFieldEffectDesc),e.registerEffect(`colorGradingLUT`,n.ColorGradingLUTEffectDesc),e.registerEffect(`toneMapping`,n.ToneMappingEffectDesc),e.registerEffect(`smaa`,n.SMAAEffectDesc),e.registerEffect(`fxaa`,n.FXAAEffectDesc)}addDefaultPhotorealScene(){if(!this.view)throw Error(`DefaultPlugin is not initialized. Call view.addPlugin() and view.init() first.`);let e=this.view,t=e.isMobileOptimized();return{sky:e.addMesh({sky:{}}),stars:e.addMesh({stars:{}}),skyLightProbe:e.addLight({skyLightProbe:{}}),sun:e.addLight({sun:{}}),aerialPerspective:e.addEffect({aerialPerspective:{}}),lensFlare:t?void 0:e.addEffect({lensFlare:{}}),toneMapping:e.addEffect({toneMapping:{}}),antialiasing:t?e.addEffect({fxaa:{}}):e.addEffect({smaa:{}})}}}});
+(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports,require("@navaramap/three"),require("@navaramap/three-default-descs")):typeof define==`function`&&define.amd?define([`exports`,`@navaramap/three`,`@navaramap/three-default-descs`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.NavaraDefaultPlugin={},e._navaramap_three,e._navaramap_three_default_descs))})(this,function(e,t,n){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`}),e.DefaultPlugin=class extends t.Plugin{view;async init(e,t){this.view=e,e.registerMesh(`rain`,n.RainMeshDesc),e.registerMesh(`snow`,n.SnowMeshDesc),e.registerMesh(`sky`,n.SkyMeshDesc),e.registerMesh(`skyBox`,n.SkyBoxMeshDesc),e.registerMesh(`stars`,n.StarsDesc),e.registerMesh(`box`,n.BoxMeshDesc),e.registerMesh(`sphere`,n.SphereMeshDesc),e.registerMesh(`glowGlobe`,n.GlowGlobeMeshDesc),e.registerMesh(`cylinder`,n.CylinderMeshDesc),e.registerMesh(`tube`,n.TubeMeshDesc),e.registerMesh(`plane`,n.PlaneMeshDesc),e.registerMesh(`gltfModel`,n.GLTFModelDesc),e.registerMesh(`splat`,n.SplatMeshDesc),e.registerMesh(`axesHelper`,n.AxesHelperDesc),e.registerMesh(`arrowHelper`,n.ArrowHelperDesc),e.registerMesh(`arcLines`,n.ArclineMeshDesc),e.registerMesh(`polygon`,n.PolygonMeshDesc),e.registerMesh(`polyline`,n.PolylineMeshDesc),e.registerMesh(`smoothLines`,n.SmoothLineMeshDesc),e.registerMesh(`boxes`,n.InstancedBoxMeshDesc),e.registerMesh(`spheres`,n.InstancedSphereMeshDesc),e.registerMesh(`planes`,n.InstancedPlaneMeshDesc),e.registerMesh(`cylinders`,n.InstancedCylinderMeshDesc),e.registerMesh(`gltfModels`,n.InstancedGltfModelMeshDesc),e.registerLight(`sun`,n.SunLightDesc),e.registerLight(`ambient`,n.AmbientLightDesc),e.registerLight(`skyLightProbe`,n.SkyLightProbeDesc),e.registerLight(`lightProbe`,n.LightProbeDesc),e.registerEffect(`aerialPerspective`,n.AerialPerspectiveEffectDesc),e.registerEffect(`rainDrop`,n.RainDropEffectDesc),e.registerEffect(`selectiveBloom`,n.SelectiveBloomEffectDesc),e.registerEffect(`selectiveOutline`,n.SelectiveOutlineEffectDesc),e.registerEffect(`clouds`,n.CloudsEffectDesc),e.registerEffect(`fogLight`,n.FogLightEffectDesc),e.registerEffect(`lensFlare`,n.LensFlareEffectDesc),e.registerEffect(`ssao`,n.SSAOEffectDesc),e.registerEffect(`ssr`,n.SSREffectDesc),e.registerEffect(`depthOfField`,n.DepthOfFieldEffectDesc),e.registerEffect(`colorGradingLUT`,n.ColorGradingLUTEffectDesc),e.registerEffect(`toneMapping`,n.ToneMappingEffectDesc),e.registerEffect(`smaa`,n.SMAAEffectDesc),e.registerEffect(`fxaa`,n.FXAAEffectDesc)}addDefaultPhotorealScene(e){if(!this.view)throw Error(`DefaultPlugin is not initialized. Call view.addPlugin() and view.init() first.`);let t=this.view,n=t.isMobileOptimized(),r=t.addMesh({sky:{}}),i=t.addMesh({stars:{}}),a=t.addLight({skyLightProbe:{}}),o=t.addLight({sun:{}}),s=t.addEffect({aerialPerspective:{...e?.deferredLighting?{irradiance:!0}:{},...e?.shadow?{shadow:!0}:{},...e?.specular?{specular:!0}:{}}});return e?.deferredLighting&&(t.lit=!1),{sky:r,stars:i,skyLightProbe:a,sun:o,aerialPerspective:s,lensFlare:n?void 0:t.addEffect({lensFlare:{}}),toneMapping:t.addEffect({toneMapping:{}}),antialiasing:n?t.addEffect({fxaa:{}}):t.addEffect({smaa:{}})}}}});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@navaramap/three-default-plugin",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "main": "dist/index.umd.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,20 +12,20 @@
   "license": "MIT OR Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/reearth/navara.git",
+    "url": "git+https://github.com/maplibre/navara.git",
     "directory": "web/navara_three_default_plugin"
   },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "@navaramap/three": "0.1.1"
+    "@navaramap/three": "0.2.0"
   },
   "dependencies": {
-    "@navaramap/three-default-descs": "0.1.1"
+    "@navaramap/three-default-descs": "0.2.0"
   },
   "devDependencies": {
-    "@navaramap/three": "0.1.1"
+    "@navaramap/three": "0.2.0"
   },
   "scripts": {
     "type-check": "tsc && tsc -p tsconfig.node.json",

package/src/index.ts

@@ -24,6 +24,10 @@ import {
   ArrowHelperDesc,
   ArclineMeshDesc,
   SmoothLineMeshDesc,
+  PolygonMeshDesc,
+  PolylineMeshDesc,
+  type PolygonMeshConfig,
+  type PolylineMeshConfig,
   type RainMeshConfig,
   type SnowMeshConfig,
   type SkyMeshConfig,
@@ -115,6 +119,8 @@ export class DefaultPlugin extends Plugin<
     view.registerMesh("axesHelper", AxesHelperDesc);
     view.registerMesh("arrowHelper", ArrowHelperDesc);
     view.registerMesh("arcLines", ArclineMeshDesc);
+    view.registerMesh("polygon", PolygonMeshDesc);
+    view.registerMesh("polyline", PolylineMeshDesc);
     view.registerMesh("smoothLines", SmoothLineMeshDesc);
     view.registerMesh("boxes", InstancedBoxMeshDesc);
     view.registerMesh("spheres", InstancedSphereMeshDesc);
@@ -148,8 +154,21 @@ export class DefaultPlugin extends Plugin<
   /**
    * Add default descriptors automatically to make the photorealistic scene.
    * This method must be invoked after `view.init()`.
+   *
+   * `deferredLighting` lights the scene from the atmosphere in post: it sets
+   * `aerialPerspective.irradiance` and `view.lit = false` together, since the
+   * forward pass would otherwise apply lighting as well. `shadow` and
+   * `specular` enable the sun's shadows and its specular highlight in that
+   * lighting through the aerial perspective's options of the same name. Both
+   * are off by default because either allocates the shadow G-buffer, and
+   * both are inert without `deferredLighting`. Toggle any of them later via
+   * the returned handle and `view.lit`.
    */
-  addDefaultPhotorealScene(): {
+  addDefaultPhotorealScene(options?: {
+    deferredLighting?: boolean;
+    shadow?: boolean;
+    specular?: boolean;
+  }): {
     sky: MeshHandle<SkyMeshDesc>;
     stars: MeshHandle<StarsDesc>;
     skyLightProbe: LightHandle<SkyLightProbeDesc>;
@@ -186,8 +205,15 @@ export class DefaultPlugin extends Plugin<
 
     // Effects
     const aerialPerspective = view.addEffect<AerialPerspectiveEffectDesc>({
-      aerialPerspective: {},
+      aerialPerspective: {
+        ...(options?.deferredLighting ? { irradiance: true } : {}),
+        ...(options?.shadow ? { shadow: true } : {}),
+        ...(options?.specular ? { specular: true } : {}),
+      },
     });
+    if (options?.deferredLighting) {
+      view.lit = false;
+    }
 
     // Skip lens flare on mobile - expensive effect with limited benefit
     const lensFlare = mobile
@@ -248,6 +274,8 @@ export type DefaultEffectDescription =
   | ToneMappingConfig;
 
 export type DefaultMeshDescription =
+  | PolygonMeshConfig
+  | PolylineMeshConfig
   | RainMeshConfig
   | SnowMeshConfig
   | SkyMeshConfig