voxel-select's Introduction

voxel-select

work in progress -- not done yet

select a cube shaped group/region of voxels in game. useful for exporting parts of a world, etc

npm install voxel-select

example

var createSelector = require('voxel-select')

var selector = createSelector(game)

select.set(start, end) // bounding box positions

api

require('voxel-selector')

returns an initialization function that you must pass your game object into in order to get a selector instance

selector.set(start, end, visible)

sets the selection. start and end should be [x, y, z] vectors. visible is by default true and controls whether or not to draw a selection wireframe

selector.dimensions()

returns absolute [width, height, depth] of the current selection

selector.transform(function(x, y, z, idx) {})

run a function over each voxel in the current selection. idx is the voxel interchange format array index

selector.selection()

returns data in the voxel interchange format

selector.reset()

clears the current selection and removes the wireframe if present

license

BSD

voxel-select's People

Contributors

Stargazers

Watchers

voxel-select's Issues

module idea: voxel-modifier

voxel-virus will remove neighboring voxels randomly at a given rate. To create water I changed the how to set a water type voxel if the voxel below is air or neighboring voxels are air.

Which got me thinking of a better way to abstract voxel manipulations. The goal: modify voxel interchange arrays over time and then return any modified voxels only when requested.

Example usage:

var voxelMod = require('voxel-modifier')(game);
var voxels = voxelMod
  // select voxels using voxel-select
  .select([0, 0, 0], [100, 100, 100])

  // apply noise modifier, randomly unselects voxels
  // 0 || null = happens only on a diff call
  .modify('noise', {amount: 0.3}, 0)

  // apply fluid modifier that flows at
  // every 300ms (based on delta) and applies water material
  .modify('fluid', {material: 'water'}, 300)

Which will start modifying voxels within the selected range by first randomly unselecting voxels and then adding voxels in a fluid like expansion.

// pass tick for timing rates at which voxels are modified
game.on('tick', voxels.tick.bind(voxels));

game.on('fire', function() {
  // only actually modify voxels when needed
  voxels.diff().forEach(function(v) {
    game.setBlock(v.position, v.type);
  });
});

Then for creating new modifiers:

// create a new modifier
voxels.modifier('explode', function(voxels, params) {
  /* calculate volume by params.radius
     and set voxels within the sphere to 0

     this function is only called at the given rate
     or only when diff() is called if null || 0
  */

  return voxels;
});

// add a modifier from npm
voxels.modifier('burn', require('voxel-burn'));

Unless something similar already exists or is planned. What do you think?

Recommend Projects

max-mapper / voxel-select Goto Github PK