@navaramap/three-default-descs

The built-in mesh, light, and effect Descriptors for @navaramap/three. Meshes range from primitives (box, sphere, cylinder, plane, tube, lines) to GLTF models, Gaussian splats, instanced variants, and atmosphere-related meshes (sky, stars). Lights cover the sun, ambient light, and light probes. Effects include aerial perspective, clouds, SSAO, SSR, selective bloom/outline, depth of field, tone mapping, and antialiasing (SMAA/FXAA).

Most applications don't depend on this package directly: @navaramap/three-default-plugin registers everything here under standard keys and re-exports all classes and config types. Depend on this package directly when you want to register only a subset of Descriptors yourself, or when you need the Descriptor classes and config types without the plugin:

import ThreeView from "@navaramap/three";
import {
  BoxMeshDesc,
  type BoxMeshConfig,
} from "@navaramap/three-default-descs";

const view = new ThreeView<{ mesh: BoxMeshConfig }>();
view.registerMesh("box", BoxMeshDesc); // before init()
await view.init();

// Place the mesh on the globe at the target lng/lat (degrees, meters).
view.addMesh({
  box: { width: 100, height: 100, depth: 100 },
  geodetic: { lng: 139.77, lat: 35.68, height: 0 },
});

These Descriptors are also reference implementations for writing custom Descriptors on top of the MeshDesc / LightDesc / EffectDesc base classes from @navaramap/three.

Documentation

Every Descriptor and its options are documented at https://navara.world/docs/.

License

MIT OR Apache-2.0