Skip to content

Latest commit

 

History

History
142 lines (101 loc) · 5.02 KB

README.md

File metadata and controls

142 lines (101 loc) · 5.02 KB
Raw

Voxelizer Logo

Voxelizer

Voxelization of 3D models

npm version Build Coverage Status Language grade: JavaScript

Voxelizer is a JavaScript voxelization engine for conducting voxelization of 3D models. It does so by leveraging three.js and allowing you to use it's wast ecosystem of file loaders, plugins, etc.

Examples - Documentation - Wiki - Migration

Table of Contents

Install

As NPM package

$ npm install voxelizer

Using a CDN

You can import the latest standalone UMD build from a CDN such as:

<script src="https://unpkg.com/voxelizer/lib/voxelizer.js"></script>

If you want a specific version, use https://unpkg.com/react-dropdown-tree-select@<version>/lib/voxelizer.js Visit unpkg.com for further details.

Peer Dependency

In order to avoid version conflicts in your project, you must install three.js as a peer dependency. Note that NPM doesn't install peer dependencies automatically. Instead it will generate a warning message with instructions on how to install them.

If you're using the CDN build, you'd also need to add the peer dependency to your application.

<script src="https://unpkg.com/three/build/..."></script>

Usage

Example

// Import via ES6 modules
import * as THREE from 'three';
import {Sampler, XMLExporter} from 'voxelizer';
// or UMD
const { Sampler, XMLExporter } = window.Voxelizer;


// Generate a yellow torus mesh to voxelize.
let geometry = new THREE.TorusGeometry( 10, 3, 16, 100 );
let material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
let torus = new THREE.Mesh( geometry, material );

// Setup Voxelizer.
let options = {
  fill: false,
  color: true
};
const sampler = new Sampler('raycast', options);

// Voxelize torus.
const resolution = 10;
let data = sampler.sample(torus, resolution);

// Export result to XML.
const exporter = new XMLExporter()
exporter.parse(data, function (xml) {
  console.log(xml)
});

Import support

Voxelizer is able to load any mesh created with three.js. By doing so, one can make use of the around 40 📄 file loaders provided by three.js, including support for the popular glTF, OBJ and STL formats.

three.js classifies these loaders as "examples". Please see the three.js documentation for how to use these.

Following is an example of how to load and voxelize a glTF file:

import {GLTFLoader} from 'three/examples/jsm/loaders/GLTFLoader';

// Setup voxelizer.
// ...

const gltfloader = new GLTFLoader();
gltfloader.load('path/to/file.glb', function (data) {
  let mesh = data.scene;
  let data = sampler.sample(mesh, resolution);
  
  // Do something with the data.
  // ...
});

Export support

Several file types and data structures are supported for exporting the voxel data.

File formats

Data structures

License

Copyright © André Storhaug

Voxelizer is licensed under the MIT License.

Related