This demo is real, click it!
npm install react-three-fiber
React-three-fiber is a small React renderer for THREE-js. Driving THREE as a render-target makes just as much sense as it makes for the DOM. Building a complex scene graph becomes easier because it can be componentized declaratively with clean, reactive semantics. This also opens up the eco system, you can now apply generic packages for state, animation, gestures, etc.
import { Canvas } from 'react-three-fiber' function Thing({ vertices, color }) { return ( <group ref={ref => console.log('we have access to the instance')}> <line position={[10, 20, 30]} rotation={[THREE.Math.degToRad(90), 0, 0]}> <geometry name="geometry" vertices={vertices.map(v => new THREE.Vector3(...v))} onUpdate={self => (self.verticesNeedUpdate = true)} /> <lineBasicMaterial name="material" color={color} /> </line> <mesh onClick={e => console.log('click')} onHover={e => console.log('hover')} onUnhover={e => console.log('unhover')}> <octahedronGeometry name="geometry" /> <meshStandardMaterial name="material" color="grey" opacity={0.5} transparent /> </mesh> </group> ) } ReactDOM.render( <Canvas> <Thing color="blue" vertices={[[-1, 0, 0], [0, 1, 0], [1, 0, 0]]} /> </Canvas>, document.getElementById('root') )
You can use THREE's entire object catalogue and all properties. When in doubt, always consult the docs.
<mesh visible userData={ test: "hello" } position={new THREE.Vector3(1, 2, 3)} rotation={new THREE.Euler(0, 0, 0)} geometry={new THREE.SphereGeometry(1, 16, 16)} material={new THREE.MeshBasicMaterial({ color: new THREE.Color('indianred'), transparent: true })} />
All properties that have a .set() method (colors, vectors, euler, matrix, etc) can be given a shortcut. For example THREE.Color.set can take a color string, hence instead of color={new THREE.Color('peachpuff') you can do color="peachpuff". Some set-methods take multiple arguments (vectors for instance), in this case you can pass an array.
You can stow away non-Object3D primitives (geometries, materials, etc) into the render tree so that they become managed and reactive. They take the same properties they normally would, constructor arguments are passed with args. If you give them a name they attach automatically to their parent.
The following is the same as above, but it's leaner and critical properties aren't re-instanciated on every render.
<mesh visible userData={ test: "hello" } position={[1, 2, 3]} rotation={[0, 0, 0]}> <sphereGeometry name="geometry" args={[1, 16, 16]} /> <meshStandardMaterial name="material" color="indianred" transparent /> </mesh>
You can nest primitive objects, good for awaiting async textures and such. You could use React-suspense if you wanted!
<meshBasicMaterial name="material"> <texture name="map" format={THREE.RGBFormat} image={img} onUpdate={self => img && (self.needsUpdate = true)} /> </meshBasicMaterial>
If you want to reach into nested attributes (for instance: mesh.rotation.x), just use dash-case:
<mesh rotation-x={1} material-color="lightblue" geometry-vertices={newVertices} />
When you need managed local (or custom/extended) objects, you can use the primitive placeholder.
const msh = new THREE.Mesh() return <primitive object={msh} />
THREE objects that implement their own raycast method (for instance meshes, lines, etc) can be interacted with by declaring events on the object. For now that's prop-updates (very useful for things like verticesNeedUpdate), hovering-state and clicks. Touch follows soon!
<mesh onClick={e => console.log('click')} onHover={e => console.log('hover')} onUnhover={e => console.log('unhover')} onUpdate={self => console.log('props have been updated')} />
Sometimes you're running effects, postprocessing, etc that needs to get updated. You can fetch the renderer, the camera, scene, and a render-loop subscribe to do this.
import { Canvas, useRender, useThree } from 'react-three-fiber' function App() { // gl is the webgl-renderer // canvas the dom element that was created // size the bounds of the view (which stretches 100% and auto-adjusts) // viewport is the calculated screen-size, it's a function const { gl, canvas, scene, camera, size, viewport } = useThree() // Subscribes to the render-loop, gets cleaned up automatically when the component unmounts // Add a "true" as the 2nd argument and you take over the render-loop useRender(({ gl, canvas, scene, camera }) => console.log("i'm in the render-loop")) return <group /> }
function Image({ url }) { const texture = useMemo(() => new THREE.TextureLoader().load(url), [url]) return ( <mesh> <planeBufferGeometry name="geometry" args={[1, 1]} /> <meshLambertMaterial name="material" transparent> <primitive name="map" object={texture} /> </meshLambertMaterial> </mesh> ) }
import { apply, Canvas, useRender, useThree } from 'react-three-fiber' import { EffectComposer } from './impl/postprocessing/EffectComposer' import { RenderPass } from './impl/postprocessing/RenderPass' import { GlitchPass } from './impl/postprocessing/GlitchPass' // Makes these objects available as native objects "<renderPass />" and so on apply({ EffectComposer, RenderPass, GlitchPass }) function Effects({ factor }) { const { gl, scene, camera, size } = useThree() const composer = useRef() useEffect(() => void composer.current.obj.setSize(size.width, size.height), [size.width, size.height]) // This takes over as the main render-loop (when 2nd arg is set to true) useRender(() => composer.current.obj.render(), true) return ( <effectComposer ref={composer} args={[gl]}> <renderPass name="passes" args={[scene, camera]} /> <glitchPass name="passes" renderToScreen factor={factor} /> </effectComposer> ) }
function Hud() { const scene = useRef() const hud = useRef() const cam = useRef() const { size: { aspect, width, height} } = useThree() const [data, set] = useState({ aspect: 0, radius: 0 }) useEffect(() => void set({ aspect, radius: (width + height) / 4 }), [width, height]) // This takes over as the main render-loop (when 2nd arg is set to true) useRender(({ gl }) => { gl.autoClear = true gl.render(scene.current, cam.current) gl.autoClear = false gl.clearDepth() gl.render(hud.current, cam.current) }, true) return ( <> <scene ref={scene}> <perspectiveCamera {...data} ref={cam} position={[0, 0, 5]} onUpdate={self => self.updateProjectionMatrix()} /> {/* Main scene ... */} </scene> <scene ref={hud}> {/* This scene will be projected on top... */} </scene> </> ) }