timelyportfolio / gl-plot3d

A common interface for setting up 3D plots

gl-plot3d

A highly opinionated wrapper module which handles camera set up, picking, axes and rendering order. Meant to be used with the following visualization modules:

• gl-simplicial-complex
• gl-surface-plot
• gl-scatter
• gl-line-plot
• gl-error-bars

Lots of options, but reasonable defaults which should make it suitable for small projects like mesh viewers or quick data visualization.

Example

var createScene = require('gl-plot3d')
var createMesh = require('gl-simplicial-complex')
var bunny = require('bunny')
var fit = require('canvas-fit')

var canvas = document.createElement('canvas')
document.body.appendChild(canvas)
window.addEventListener('resize', fit(canvas))

var scene = createScene(canvas, {
  autoBounds: true
})

var mesh = createMesh(scene.gl, {
  cells:      bunny.cells,
  positions:  bunny.positions,
  colormap:   'jet'
})

scene.addObject(mesh)

Install

npm i gl-plot3d

API

Constructor

var scene = require('gl-plot3d')(canvas[, options])

Methods

scene.addObject(obj)

scene.removeObject(obj)

scene.dispose()

Properties

scene.gl

scene.axes

scene.camera

scene.bounds

scene.zNear

scene.zFar

scene.fovy

scene.clearColor