A modern 3D viewer framework built on top of three.js, written in TypeScript, designed to make creating high-quality, modular, and extensible 3D experiences on the web simple and enjoyable.
npm install threepipeNext generation toolkit for web3D and photorealistic graphics.
Website —
Github —
Examples —
API Reference —
Realistic Rendering
Threepipe is a modern 3D framework built on top of three.js, written in TypeScript, designed to make creating high-quality, modular, and extensible 3D experiences on the web simple and enjoyable.
- Simple, intuitive API for creating 3D model viewers/configurators/editors on web pages, with many built-in presets for common workflows and use-cases.
- Companion editor to create, edit and configure 3D scenes in the browser.
- Modular architecture that allows you to easily extend the viewer, scene objects, materials, shaders, rendering, post-processing and serialization with custom functionality.
- Plugin system along with a rich of built-in plugins that allows you to easily add new features to the viewer.
- uiconfig compatibility to automatically generate configuration UIs in the browser.
- Modular rendering pipeline with built-in deferred rendering, post-processing, RGBM HDR rendering, etc.
- Material extension framework to modify/inject/build custom shader code into existing materials at runtime from plugins.
- Extendable asset import, export and management pipeline with built-in support for gltf, glb, obj+mtl, fbx, materials(pmat/bmat), json, zip, png, jpeg, svg, webp, ktx2, ply, 3dm and many more.
- Automatic serialization of all viewer and plugin settings in GLB(with custom extensions) and JSON formats.
- Built-in undo/redo support for user actions.
- Automatic disposal of all three.js resources with built-in reference management.
- Realtime Realistic Rendering with screen-space post-processing effects from webgi.
- Animation system(and UI) to create state, keyframe-based animations for any object, material, or viewer property with global timeline.
Checkout the documentation and guides on the threepipe website for more details.
Code samples and demos covering various usecases and test are present in the examples folder.
Try them: https://threepipe.org/examples/
View and edit the source code by pressing the code button on the top left of the example page.
!Threepipe Examples SSAO With Editor
A web-based editor to create, edit, configure and export 3D scenes and models for use with Threepipe.
!Threepipe Editor SSR !Threepipe Editor Edit Mode
!Threepipe Editor Color Picker !Threepipe Editor Buffers
!Threepipe Editor Scene !Threepipe Editor Path Tracing
Checkout the full Getting Started Guide on threepipe.org
- A 3D Model (GLTF, GLB, OBJ, FBX, etc).
- Optionally, the model, scene, and plugins can be configured, compressed and exported using the Threepipe Editor or Tweakpane Editor.
- Here is a sample model with configured settings - classic-watch.glb
- Models can be downloaded from websites and marketplaces like Poly Haven, Sketchfab, CGTrader, TurboSquid, etc.
- A modern browser(like chrome, safari) that supports WebGL2 and WebAssembly (for some plugins).
- A code editor like VSCode or WebStorm
- Node.js (optional, only for local development). Node 18+ is recommended.
- Basic knowledge of JavaScript/TypeScript and HTML
- An existing project or willingness to start a new one
To create a new project locally
``
npm create threepipe@latest
And follow the instructions to select a template and create a new project.
Pre-ready templates with model viewer and plugins can be directly run and edited on stackblitz.
Basic javascript |
typescript
Rendering javascript |
typescript
R3F javascript |
typescript
NextJS typescript
`html
`
Check it in action: https://threepipe.org/examples/#html-js-sample/
Check out the details about the ThreeViewer API and more plugins.
`bash`
npm install threepipe
First, create a canvas element in your HTML page:
`html`
Then, import the viewer and create a new instance:
`typescript
import {ThreeViewer, IObject3D} from 'threepipe'
// Create a viewer
const viewer = new ThreeViewer({canvas: document.getElementById('three-canvas') as HTMLCanvasElement})
// Load an environment map
await viewer.setEnvironmentMap('https://samples.threepipe.org/minimal/venice_sunset_1k.hdr')
// Load a model
const result = await viewer.load
autoCenter: true,
autoScale: true,
})
`
That's it! You should now see a 3D model on your page.
The 3D model can be opened in the editor to view and edit the scene settings, objects, materials, lights, cameras, post-processing, etc. and exported as a GLB file. All settings are automatically serialized and saved in the GLB file, which can be loaded into the viewer. Any plugins used in the editor can be added to the viewer to add the same functionality. The plugin data is automatically loaded(if the plugin is added) when the model is added to the scene.
The viewer initializes with a Scene, Camera, Camera controls(Orbit Controls), several importers, exporters and a default rendering pipeline. Additional functionality can be added with plugins.
Check out the glTF Load example to see it in action or to check the JS equivalent code: https://threepipe.org/examples/#gltf-load/
Check out the Plugins section to learn how to add additional functionality to the viewer.
Threepipe includes a built-in rendering and post-processing pipeline that is highly optimized and feature packed. Several realistic rendering plugins are included in the threepipe core like SSAOPlugin for quick ambient occlusion, SSAAPlugin for anti-aliasing, TonemapPlugin for tonemapping, etc.
Threepipe provides the @threepipe/webgi-plugins package (now free) with even more advanced realistic rendering plugins like Screen Space Reflections, HDR Bloom, Depth Of Field etc that work in realtime on all devices.
Follow the quickstart guide on various realistic rendering plugins and how they effect the lighting in the scene at webgi.dev
Threepipe also provides other plugins like Path Tracing for photorealistic rendering and baking, and more third party plugins for various effects and custom materials.
Threepipe can be used in your favourite framework or library like React, Vue.js, Svelte, etc.
Below we provide minimal sample components for different UI frameworks, these can serve as a starting point to make your own viewer component with additional functionality and plugins.
Checkout the Framework Samples section in the Threepipe Examples for sample usage and downloadable source code.
The best way to use the viewer in react is to wrap it in a custom component.
Here is a sample react component in tsx to render a model with an environment map.
`tsx
import React from 'react'
function ThreeViewerComponent({src, env}: {src: string, env: string}) {
const canvasRef = React.useRef(null)
React.useEffect(() => {
const viewer = new ThreeViewer({canvas: canvasRef.current})
const envPromise = viewer.setEnvironmentMap(env)
const modelPromise = viewer.load(src)
Promise.all([envPromise, modelPromise]).then(([env, model]) => {
console.log('Loaded', model, env, viewer)
})
return () => {
viewer.dispose()
}
}, [])
return (
)
}
`
Check it in action: https://threepipe.org/examples/#react-tsx-sample/
Other examples in js: https://threepipe.org/examples/#react-js-sample/ and jsx: https://threepipe.org/examples/#react-jsx-sample/
For a more declarative approach using JSX syntax, you can use the @threepipe/plugin-r3f package which provides React Three Fiber integration.
`bash`
npm install @threepipe/plugin-r3f
Here is a sample React Three Fiber component to render a model with an environment map using declarative JSX syntax.
`tsx
import React from 'react'
import { createRoot } from 'react-dom/client'
import { ViewerCanvas, Asset, Model } from '@threepipe/plugin-r3f'
import { LoadingScreenPlugin } from 'threepipe'
function App() {
return (
style={{width: 800, height: 600}}
plugins={[LoadingScreenPlugin]}
onMount={async (viewer) => {
console.log('Viewer mounted:', viewer)
}}
>
}>
autoSetBackground={true}
/>
autoCenter={true}
autoScale={true}
/>
)
}
createRoot(document.getElementById('root')).render(
`
ViewerCanvas is the wrapper around the r3f Canvas component that initializes the ThreePipe viewer and provides the viewer context to all child components.
Any children added to this component are added to the scene model root.
Check it in action: https://threepipe.org/examples/#r3f-tsx-sample/
The best way to use the viewer in nextjs is to wrap it in a custom component which can then be used in any page.
Here is a sample client side react component with nextjs in tsx to render a model with an environment map.
The 'use client' directive is required to make it a client component.threepipe
In the client component, and any plugins can be imported at the top level normally, and imported using next/dynamic at any server side or client side pages in next.js.
`tsx
'use client'
import React from 'react'
import {ThreeViewer} from 'threepipe';
export default function ThreeViewerComponent({src, env}: {src: string, env: string}) {
const canvasRef = React.useRef
React.useEffect(() => {
if (!canvasRef.current) return
const viewer = new ThreeViewer({ canvas: canvasRef.current!, tonemap: false, rgbm: false, msaa: true })
viewer.scene.backgroundColor = null
const envPromise = viewer.setEnvironmentMap(env)
const modelPromise = viewer.load(src, {autoScale: true, autoCenter: true})
Promise.all([envPromise, modelPromise]).then(([envMap, model]) => {
console.log('Loaded', model, envMap, viewer)
})
return () => {if (viewer) viewer.dispose()}
}, [src, env])
return
Then import and use the component on any page
tsx
const ThreeViewer = dynamic(async () => import('./ThreeViewerComponent'), { ssr: false });
export default function HomePage() {
return
env={"https://samples.threepipe.org/minimal/venice_sunset_1k.hdr"}
/>
}
`Checkout the nextjs starter on stackblitz for a complete working using threepipe and several plugins in a nextjs application.
$3
and its plugins can be imported dynamically using js import() syntax to reduce the initial bundle size.
Here is a sample client side react component with nextjs in tsx to render a model with an environment map using dynamic import.`tsx
'use client'
import React from 'react'
import type {ThreeViewer} from 'threepipe';export default function ThreeViewerComponent({src, env}: {src: string, env: string}) {
const canvasRef = React.useRef(null)
React.useEffect(() => {
if (!canvasRef.current) return
let viewer: ThreeViewer;
(async () => {
const { ThreeViewer } = await import('threepipe')
viewer = new ThreeViewer({ canvas: canvasRef.current!, tonemap: false, rgbm: false, msaa: true })
viewer.scene.backgroundColor = null
const envPromise = viewer.setEnvironmentMap(env)
const modelPromise = viewer.load(src, {autoScale: true, autoCenter: true})
Promise.all([envPromise, modelPromise]).then(([envMap, model]) => {
console.log('Loaded', model, envMap, viewer)
})
})()
return () => {if (viewer) viewer.dispose()}
}, [src, env])
return
width: 800, height: 600,
position: 'absolute', transform: 'translate(-50%, -50%)', top: '50%', left: '50%',
}} ref={canvasRef}/>
}
`The component can simply be used on any page without
or ssr: false since it is already a client component.`tsx
env={"https://samples.threepipe.org/minimal/venice_sunset_1k.hdr"}
/>
`$3
A sample vue.js component in js to render a model with an environment map.
js
const ThreeViewerComponent = {
setup() {
const canvasRef = ref(null); onMounted(() => {
const viewer = new ThreeViewer({ canvas: canvasRef.value });
const envPromise = viewer.setEnvironmentMap('https://samples.threepipe.org/minimal/venice_sunset_1k.hdr');
const modelPromise = viewer.load('https://threejs.org/examples/models/gltf/DamagedHelmet/glTF/DamagedHelmet.gltf');
Promise.all([envPromise, modelPromise]).then(([env, model]) => {
console.log('Loaded', model, env, viewer)
})
onBeforeUnmount(() => {
viewer.dispose();
});
});
return { canvasRef };
},
};
`Check it in action: https://threepipe.org/examples/#vue-html-sample/
Another example with Vue SFC(Single file component): https://threepipe.org/examples/#vue-sfc-sample/
$3
A sample svelte component in js to render a model with an environment map.
html
`Check it in action: https://threepipe.org/examples/#svelte-sample/
For Svelte 5, simply initialize
to $state() -
`js
let canvasRef = $state();
`License
The core framework(src, dist, examples folders) and any plugins without a separate license are under the Free Apache 2.0 license
Some plugins(in the plugins folder) might have different licenses. Check the individual plugin documentation and the source folder/files for more details.
🚀 Status
The project is in stage and under active development.
Many features will be added but the core API will not change significantly in future releases.🔗 Table of Contents
- ThreePipe
- Examples
- Table of Contents
- Getting Started
- HTML/JS Quickstart (CDN)
- NPM/YARN Package
- Installation
- Loading a 3D Model
- Frameworks
- License
- Status
- Documentation (API Reference)
- Contributing
- Features
- File Formats
- Loading files
- Exporting files
- Render Pipeline
- Material Extension
- UI Configuration
- Serialization
- Plugin System
- Timeline
- Viewer API
- ThreeViewer
- RenderManager
- RootScene
- ICamera
- AssetManager
- AssetImporter
- AssetExporter
- MaterialManager
- Other classes and interfaces
- Plugins
- TonemapPlugin - Add tonemap to the final screen pass
- DropzonePlugin - Drag and drop local files to import and load
- ProgressivePlugin - Post-render pass to blend the last frame with the current frame
- SSAAPlugin - Add Super Sample Anti-Aliasing by applying jitter to the camera.
- DepthBufferPlugin - Pre-rendering of depth buffer
- NormalBufferPlugin - Pre-rendering of normal buffer (deferred shading)
- GBufferPlugin - Pre-rendering of depth-normal and flags buffers in a single pass (deferred shading)
- SSAOPlugin - Add SSAO(Screen Space Ambient Occlusion) for physical materials.
- CanvasSnapshotPlugin - Add support for taking snapshots of the canvas with anti-aliasing and other options
- PickingPlugin - Adds support for selecting objects in the viewer with user interactions and selection widgets
- AssetExporterPlugin - Provides options and methods to export the scene/object GLB or Viewer Configuration JSON
- LoadingScreenPlugin - Shows a configurable loading screen overlay over the canvas
- FullScreenPlugin - Adds support for moving the canvas or the container fullscreen mode in browsers
- InteractionPromptPlugin - Adds an animated hand icon over canvas to prompt the user to interact
- TransformControlsPlugin - Adds support for moving, rotating and scaling objects in the viewer with interactive widgets
- ContactShadowGroundPlugin - Adds a ground plane at runtime with contact shadows
- GLTFAnimationPlugin - Add support for playing and seeking glTF animations
- PopmotionPlugin - Integrates with popmotion.io library for animation/tweening
- AnimationObjectPlugin - Create and manage keyframe-based animations for any object, material, or viewer property with timeline controls
- CameraViewPlugin - Add support for saving, loading, animating, looping between camera views
- TransformAnimationPlugin - Add support for saving, loading, animating, between object transforms
- RenderTargetPreviewPlugin - Preview any render target in a UI panel over the canvas
- GeometryUVPreviewPlugin - Preview UVs of any geometry in a UI panel over the canvas
- FrameFadePlugin - Post-render pass to smoothly fade to a new rendered frame over time
- VignettePlugin - Add Vignette effect by patching the final screen pass
- ChromaticAberrationPlugin - Add Chromatic Aberration effect by patching the final screen pass
- FilmicGrainPlugin - Add Filmic Grain effect by patching the final screen pass
- NoiseBumpMaterialPlugin - Sparkle Bump/Noise Bump material extension for PhysicalMaterial
- CustomBumpMapPlugin - Adds multiple bump map support and bicubic filtering material extension for PhysicalMaterial
- ClearcoatTintPlugin - Clearcoat Tint material extension for PhysicalMaterial
- FragmentClippingExtensionPlugin - Fragment/SDF Clipping material extension for PhysicalMaterial
- ParallaxMappingPlugin - Relief Parallax Bump Mapping extension for PhysicalMaterial
- HDRiGroundPlugin - Add support for ground projected hdri/skybox to the webgl background shader.
- VirtualCamerasPlugin - Add support for rendering virtual cameras before the main one every frame.
- EditorViewWidgetPlugin - Adds an interactive
ViewHelper/AxisHelper that syncs with the main camera.
- Object3DWidgetsPlugin - Automatically create light and camera helpers/gizmos when they are added to the scene.
- Object3DGeneratorPlugin - Provides an API and UI to create scene objects like lights, cameras, meshes, etc.
- DeviceOrientationControlsPlugin - Adds a controlsMode to the mainCamera for device orientation controls(gyroscope rotation control).
- PointerLockControlsPlugin - Adds a controlsMode to the mainCamera for pointer lock controls.
- ThreeFirstPersonControlsPlugin - Adds a controlsMode to the mainCamera for first person controls from threejs.
- GLTFKHRMaterialVariantsPlugin - Support using for variants from KHR_materials_variants extension in glTF models.
- Rhino3dmLoadPlugin - Add support for loading .3dm files (Rhino 3D)
- PLYLoadPlugin - Add support for loading .ply files
- STLLoadPlugin - Add support for loading .stl files (STL))
- KTX2LoadPlugin - Add support for loading .ktx2 files (KTX2 - GPU Compressed Textures)
- KTXLoadPlugin - Add support for loading .ktx files (Note - use ktx2)
- CascadedShadowsPlugin - High-quality directional light shadows across large scenes using Cascaded Shadow Maps (CSM) technique
- USDZLoadPlugin - Add partial support for loading .usdz, .usda files (USDZ)
- GLTFMeshOptDecodePlugin - Decode glTF files with EXT_meshopt_compression extension.
- SimplifyModifierPlugin - Boilerplate for plugin to simplify geometries
- MeshOptSimplifyModifierPlugin - Simplify geometries using meshoptimizer library
- UndoManagerPlugin - Adds support for undo/redo operations in the viewer. Used by other plugins to manage undo history.
- ObjectConstraintsPlugin - Add support for constraints between objects like follow path, look at, position/rotation/scale locking, etc.
- Packages
- @threepipe/webgi-plugins - Web Global Illumination - Realistic rendering plugin pack (SSR, SSRTAO, HDR Bloom, TAA, Depth of Field, SSGI, etc.)
- @threepipe/plugin-tweakpane Tweakpane UI Plugin
- @threepipe/plugin-blueprintjs BlueprintJs UI Plugin
- @threepipe/plugin-tweakpane-editor - Editor Plugin using Tweakpane for plugin UI
- @threepipe/plugin-configurator - Provides MaterialConfiguratorPlugin and SwitchNodePlugin` to allow users to select variationsCheck the list of all functions, classes and types in the API Reference Docs.
Contributions to ThreePipe are welcome and encouraged! Feel free to open issues and pull requests on the GitHub repository.
Read the contributing guidelines for more details on how to setup and work on the project.