https://github.com/mikolalysenko/greedy-mesher

Greedy mesh compiler
https://github.com/mikolalysenko/greedy-mesher

Last synced: about 2 months ago
JSON representation

Greedy mesh compiler

• Host: GitHub
• URL: https://github.com/mikolalysenko/greedy-mesher
• Owner: mikolalysenko
• License: mit
• Created: 2013-06-02T19:18:26.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-02-12T16:27:39.000Z (almost 9 years ago)
• Last Synced: 2024-10-20T14:27:55.564Z (2 months ago)
• Language: JavaScript
• Size: 18.6 KB
• Stars: 51
• Watchers: 7
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
greedy-mesher

=============

A flexible system for generating [greedy meshes](http://0fps.wordpress.com/2012/07/07/meshing-minecraft-part-2/) of [ndarrays](https://github.com/mikolalysenko/ndarray).

## Example

```javascript

var compileMesher = require("greedy-mesher")

var mesher = compileMesher({

  extraArgs: 1,

  order: [1, 0],

  append: function(lo_x, lo_y, hi_x, hi_y, val, result) {

    result.push([[lo_x, lo_y], [hi_x, hi_y]])

  }

})

var test_array = require("ndarray-pack")(

[[0, 2, 0, 0],

 [0, 1, 1, 0],

 [0, 1, 1, 0],

 [0, 0, 0, 0]])

var result = []

mesher(test_array, result)

console.log(result); 

// outputs: [ [ [ 1, 0 ], [ 2, 1 ] ], [ [ 1, 1 ], [ 3, 3 ] ] ]

```

## Install

    npm install greedy-mesher

    

### `require("greedy-mesher")(options)`

This routine generates a greedy mesher for a given order and list of closures

* `order` An array representing the order in which to mesh the input.

* `extraArgs` The number of optional arguments to pass to each closure.

* `skip(a,...)` A closure which tests if the given voxel should be skipped.  (Default: skips 0)

* `merge(a,b,...)` A closure which tests if voxels a and b can be merged in the mesh.  (Default: checks if voxels are equal)

* `append(lo0, lo1, ..., lon, hi0, hi1, ..., hin, val, ...)`

* `useGetter` if set, use `.get()` to access underlying data store

* `debug` If set, print out the generated source code to the console

**Returns** A compiled mesh generator.  Call this method using:

```javascript

var my_mesh = mesher(array, option1, option2, ...)

```

## Credits

(c) 2013 Mikola Lysenko. MIT License