Renderer agnostic react bindings for boxes
npm install @downpourdigital/boxes-react-bridgeRenderer-agnostic bindings for boxes — Create and compose boxes scenes with any react renderer.
```
yarn add @downpourdigital/boxes-react-bridge``
npm i --save @downpourdigital/boxes-react-bridge
typescript
import {
BoxesRoot,
Renderable,
TransformNode,
UniformProvider,
PerspectiveWrapper,
MatchGlTransform,
usePxPerUnit,
} from '@downpourdigital/boxes-react-bridge';`$3
boxes-react-bridge only "renders" your elements into a container. This can be a boxes Scene or anything living in the boxes scene graph.
What you do with the scene is then up to you – rendering, materials and geometries have to be done the "traditional", imperative way.$3
First, you'll have to specify a point from which to tap into the react tree. This could be the root of your app. E.g. with ReactDOM:`tsx
const scene = new Scene();ReactDOM.render(
,
document.getElementById( 'root' ),
);
`
All boxes related nodes inside will now be mounted into scene.$3
For now, only
Renderable, TransformNode and UniformProvider are represented. The elements props closely match that of their imperative counterpart. Additionally, react ref props can be used and transforms can be supplied as arrays. `tsx
() => {
const ref = useRef();
return (
ref={ref}
translation={[1, 2, 3]}
>
);
}`$3
boxes-react-bridge can infer CSS transforms from boxes transforms to sync DOM content to WebGL. Right now, only PerspectiveCameras are supported.To get the correct CSS perspective, wrap your App in a
component. This'll create a with the necessary styles.`tsx
ReactDOM.render(
// your canvas dimensions in pixels
width={1024}
height={1024}
// the camera from which you're projecting
camera={scene.activeCamera}
>
,
document.getElementById( 'root' ),
);`
Now you can place a component inside the element with which you want to sync transforms. This'll place a at the nodes origin. You may have to fight with CSS for a bit to get things looking right.Use the
usePxPerUnit hook to convert from boxes units to pixels.A 2x2u square on top of a
Renderable would look like this:`tsx
() => {
const scalar = usePxPerUnit();
return (
geometry={geometry}
material={material}
>
transform: 'translate3d(-50%, 50%, 0)',
border: '1px solid red',
width: 2 * scalar,
height: 2 * scalar,
}}
>
SYNCED TRANSFORMS!
``
© 2020 DOWNPOUR DIGITAL, licensed under BSD-4-Clause