@metafold/threejs
v0.3.0
Published
Metafold three.js addon
Readme
Metafold three.js addons
Installation
Include the following imports in the HTML head element, adjusting version numbers as appropriate:
<head>
<!-- ... -->
<script type="importmap">
{
"imports": {
"three": "https://unpkg.com/[email protected]/build/three.module.js",
"three/addons/": "https://unpkg.com/[email protected]/examples/jsm/",
"@metafold/threejs": "https://unpkg.com/@metafold/[email protected]/dist/main.js"
}
}
</script>
</head>Usage
As with the three.js post-processing guide, start by importing the required passes:
import { EffectComposer } from "three/addons/postprocessing/EffectComposer.js"
import { RenderPass } from "three/addons/postprocessing/RenderPass.js"
import { OutputPass } from "three/addons/postprocessing/OutputPass.js"
import { VolumeRenderPass } from "@metafold/threejs/VolumeRenderPass.js"In this example we include a standard scene RenderPass and the VolumeRenderPass introduced by
this addon.
const renderTarget = new THREE.WebGLRenderTarget(width, height)
renderTarget.depthTexture = new THREE.DepthTexture()
const composer = new EffectComposer(renderer, renderTarget)Note the EffectComposer should be initialized with a render target that includes a depth
texture to make the depth of previous passes available to the VolumeRenderPass. This enables the
VolumeRenderPass to composite the rendered shape with any geometry from previous passes.
const renderPass = new RenderPass(scene, camera)
composer.addPass(renderPass)
// Dummy data to initialize volume render pass
const volumeData = new Int8Array(64 * 64 * 64)
volumeData.fill(127)
const volumeRenderPass = new VolumeRenderPass(camera, width, height, volumeData, {
size: new THREE.Vector3(2.0, 2.0, 2.0),
// The resolution *must* match the volume data length
resolution: new THREE.Vector3(64, 64, 64),
})
composer.addPass(volumeRenderPass)
const outputPass = new OutputPass()
composer.addPass(outputPass)Initializing the VolumeRenderPass is simple as that!
After receiving volume data from the Metafold API, set the data on the pass as an Int8Array and
provide the corresponding patch parameters (size and resolution):
const volumeData = new Int8Array(buffer)
volumeRenderPass.setVolume(volumeData, { size, resolution })See examples/lattice_infill for a complete example (including Metafold SDK for Node.js usage)!