The aim of the project is to add support for different triangulation/tessellation algorithms/libraries to three.js. Right now the library seamlessly supports the following triangulation libraries:
— original - original algorithm from THREE.ShapeUtils
— earcut - earcut triangulation library
— poly2tri - poly2tri triangulation library
— libtess - libtess tessellation library
To be able to use the libtess library you will have to also load the file tessy.js into your project.
The second aim of the project is to create compare the results of these different triangulation/tessellation algorithms/libraries in three.js.
The library comes with an adapter triangulation.js which can make it easy to switch between the different triangulation libraries inside your project. The implementation is simple.
The adapter is available through THREE.Triangulation and has two public methods:
setLibrary- sets the library that you currently want to use.
- The available libraries are in an object called
libraries. So to set earcut as your library:THREE.Triangulation.setLibrary( THREE.Triangulation.libraries.earcut );(or simply use the string'earcut').
setTimer- turns the timer on/off.
- The timer will output the time that was needed to perform the triangulation operations inside the console giving you valuable feedback on the performance of the chosen library.
To turn the timer on simply call:
THREE.Triangulation.setTimer( true );
For now there are two viewers.
- One single screen viewer where the triangulation result of a certain shape with a selected algorithm can be viewed.
- And multiple screen viewer where the triangulation result of a certain shape can be seen for all algorithms at the same time.
You can install the triangulation library using bower. Include the library under dependencies in your bower.json file:
"dependencies": {
...
"three.js_triangulation": "https://github.com/Wilt/three.js_triangulation.git"
...
}
And then run bower update:
bower update
In this case all the supported triangulation libraries will be automatically installed and you will be able to use them directly.
If you don't have bower installed I would like to refer to the official bower documentation
The example.html page shows how to implement the adapter and dependencies inside your html file.
After installing using bower following the description above you should be able to run this file and all dependencies should be loaded correctly.
If you want to move this file to the root folder of your project you should change the path of the include scripts accordingly.
Some basic tests in Jasmine are added inside the test folder.
More tests will be added later.
The next step will be to do some benchmarking of the different algorithms
Do you want support for another (or your own) triangulation library, then please make an issue or a pull-request where you explain what the added value of the proposed library is compared to the ones that are already implemented. It would also be good to make a live example where you show that your code is working. This will increase the chances of the library being implemented.