PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

0.3.38

npm

3d-tiles-renderer

https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification

3d-tiles3dtilesb3dmcesiumgeometrygltfgraphicsrenderingterrainthreejsbabylonjsr3f
Published30 Sept 2024
Direct dependencies16
Transitive dependenciesNot calculated

README

Current package documentation

3d-tiles-renderer

npm version build

JavaScript renderer implementation for the 3D Tiles format with support for both Three.js and Babylon.js. The renderer supports most of the 3D Tiles spec features with a few exceptions. For a list of available data sets and generation tools see the 3d Tiles resources list.

If a tileset or geometry does not load or render properly please make an issue! Example data is needed for adding and testing features. See the Feature Complete Milestone for information on which features are not yet implemented.

Getting Started

Installation

npm install 3d-tiles-renderer --save

API

PackageReference
3d-tiles-renderer/coreAPI Reference
3d-tiles-renderer/threeUsage Guide · API Reference
3d-tiles-renderer/babylonjsUsage Guide · API Reference
3d-tiles-renderer/r3fUsage Guide · API Reference

Plugins

PackageReference
3d-tiles-renderer/three/pluginsPlugin Guide · API Reference
3d-tiles-renderer/core/pluginsAPI Reference

Examples

The following examples use Three.js. Babylon.js demos are also available for Mars and Google Photorealistic Tiles.

See the Three.js usage guide or Babylon.js usage guide for setup details with each engine.

ExampleDescription
Core
Dingo Gap MarsMultiple tilesets
Kitchen SinkAll options and features
VRRendering in VR
External Tiles Providers ¹
Cesium Ion 3D TilesStandard Cesium Ion tileset
Cesium Ion LunarLunar surface tiles
Cesium Ion MarsMars surface tiles
Google PhotorealisticGoogle Photorealistic Tiles
Google GlobeGoogle Globe Tiles
PLATEAUPLATEAU city data over Cesium World Terrain
Customization
Custom MaterialUsing a custom material
Offscreen ShadowsShadows from offscreen tiles
Texture OverlaysAlternate texture overlays
Plugins
MetadataTile metadata
Fade TransitionTile LoD fade transition
Deep ZoomDeep Zoom Image format
PotreePotree point cloud format
TMS / XYZTMS, XYZ map tiles
WMTSWMTS map tiles
WMSWMS map tiles
Quantized MeshQuantized mesh with overlays
Load RegionLoading tiles in region volumes
GeoJSONGeoJSON overlays
Vector TilesMapbox Vector Tiles and Protomap Tiles overlays

¹ Requires a Google Tiles API Key or Cesium Ion API Key

Community Resources

Here is a reference to existing 3DTilesRendererJS integrations:

  • three-geospatial: Clouds and atmosphere rendering via a three.js geospatial rendering modules, alongside 3DTilesRendererJS.
  • 3D Tiles in MapLibre Guide: Official example showing how to render 3D tiles using a synced Three.js layer.
  • Giro3D: Framework for visualizing and interacting with heterogenous geospatial data in the browser, 2D, 2.5D and 3D data.
  • iTowns: Framework designed for the efficient visualization, navigation, and interaction with 2D and 3D geospatial data on the web.
  • threepipe Plugin: Plugin for the threepipe rendering framework integrating 3DTilesRendererJS.
  • 3DBAG Viewer: Web viewer for the 3DBAG dataset, a nationwide 3D model of all buildings in the Netherlands built with roofer.
  • Babylon.js Guide: Official documentation on integrating 3DTilesRendererJS into your Babylon.js project.
  • Community Plugins: Additional community-maintained threejs plugins for 3DTilesRendererJS.

Gotchas

Some behaviors to be aware of when configuring the renderer:

  • Cache limits are hard caps. No new tiles load once the LRUCache reaches maxSize or maxBytesSize. If the tiles needed for the current view do not fit then coarser tiles are displayed and refinement stops. Monitor lruCache.cachedBytes and lruCache.isFull() and raise maxBytesSize or errorTarget when a view needs more detail than fits.

LICENSE

The software is available under the Apache V2.0 license.

Copyright © 2020 California Institute of Technology. ALL RIGHTS RESERVED. United States Government Sponsorship Acknowledged. Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 17

Native requirements
16 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
jest
Environment
{
  "local_name": "jest",
  "alias": false,
  "peer_metadata": null
}
^27.1.1development
vite
Environment
{
  "local_name": "vite",
  "alias": false,
  "peer_metadata": null
}
^5.3.1development
three
Environment
{
  "local_name": "three",
  "alias": false,
  "peer_metadata": null
}
^0.166.0development
cesium
Environment
{
  "local_name": "cesium",
  "alias": false,
  "peer_metadata": null
}
^1.97.0development
jest-cli
Environment
{
  "local_name": "jest-cli",
  "alias": false,
  "peer_metadata": null
}
^27.1.1development
babel-jest
Environment
{
  "local_name": "babel-jest",
  "alias": false,
  "peer_metadata": null
}
^29.5.0development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^5.1.3development
@babel/core
Environment
{
  "local_name": "@babel/core",
  "alias": false,
  "peer_metadata": null
}
^7.21.8development
@types/three
Environment
{
  "local_name": "@types/three",
  "alias": false,
  "peer_metadata": null
}
^0.166.0development
concurrently
Environment
{
  "local_name": "concurrently",
  "alias": false,
  "peer_metadata": null
}
^6.2.1development
@types/eslint
Environment
{
  "local_name": "@types/eslint",
  "alias": false,
  "peer_metadata": null
}
^7.28.1development
@babel/preset-env
Environment
{
  "local_name": "@babel/preset-env",
  "alias": false,
  "peer_metadata": null
}
^7.21.5development
eslint-config-mdcs
Environment
{
  "local_name": "eslint-config-mdcs",
  "alias": false,
  "peer_metadata": null
}
^5.0.0development
eslint-plugin-jest
Environment
{
  "local_name": "eslint-plugin-jest",
  "alias": false,
  "peer_metadata": null
}
^28.6.0development
@typescript-eslint/parser
Environment
{
  "local_name": "@typescript-eslint/parser",
  "alias": false,
  "peer_metadata": null
}
^7.14.1development
@typescript-eslint/eslint-plugin
Environment
{
  "local_name": "@typescript-eslint/eslint-plugin",
  "alias": false,
  "peer_metadata": null
}
^7.14.1development
three
Environment
{
  "local_name": "three",
  "alias": false,
  "peer_metadata": null
}
>=0.123.0peer

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "942bb2426354b2393e6fcc752f613d67c141b367",
  "tarball": "https://registry.npmjs.org/3d-tiles-renderer/-/3d-tiles-renderer-0.3.38.tgz",
  "fileCount": 104,
  "integrity": "sha512-gpfigbT1OeFDmXl8j5ZKdTR9x4wQ/9ZjYGoixEiSrsfW7+w7dwkzGfWORxMsCw+Y8Q9c2HURiz5uyMfpUy43vg==",
  "signatures": [
    {
      "sig": "MEQCIAknDtHIeS4JdZjGaHmuV7jMkfml43H9g5MDingkJxcVAiApre5fvIjjC0Mu79kv3F0ivblMMCP9rFpSUEOectt6nQ==",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 361875
}

Repository

PENDING
nasa-ammos/3dtilesrendererjs

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:37 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:ed2327a9669cbf40e2ba5d2b1edfa668067cb9cd2a930f969e82bfce171a1ed2

Other collected versions

0.5.318 Sept0.5.224 Aug0.5.17 Aug0.5.015 Jul0.4.289 Jun0.4.2725 MayView all collected versions →