What is Teleport.js?
The Teleport Javascript SDK#
Teleport.js is a client-side JavaScript library designed for loading and rendering 3D spatial Teleport reconstructions in WebGL applications. It integrates directly with Three.js, abstracting network requests and asset processing into standard JavaScript objects that feed straight into your 3D scene graph.
Teleport.js uses the Spark.js renderer and it's customized to provide the best performances for loading and displaying large sets of Gaussian Splats on the web and mobile browsers.
Core Capabilities#
1. Three.js Integration#
Automatically wraps the Teleport API into structured client-side objects. It instantiates internal splat meshes, sets up optimized renderer and provides objects directly as standard children within a Three.js scene and functions that integrate with Three.js 3D primitives.
2. Progressive Splats Loading#
Manages the download and memory allocation lifecycles for complex multi-resolution formats like .rad. It dynamically resolves chunked file streams to load Level of Detail (LoD) gaussian splats based on the active camera view.
3. Geospatial Realignment#
Decouples and parses raw gps_transform metadata present in your Teleport captures. This provides immediate access to position arrays, quaternion rotations and standard GPS dictionary values (latitude, longitude, altitude) for placing captures in GPS aware environments.
4. Raycasting and Interaction#
Exposes native raycasting methods built specifically for splat volumes, bypassing standard mesh constraints to return precise intersection points, distance calculations and target references from screen interactions.