gl-axes

Draws axes for 3D scenes:

Example

Here is a simple example showing how to use gl-axes to visualize the extents of an isosurface:

//Load shell
var shell = require("gl-now")({ clearColor: [0,0,0,0] })
var camera = require("game-shell-orbit-camera")(shell)

//Mesh creation tools
var createMesh = require("gl-simplicial-complex")
var polygonize = require("isosurface").surfaceNets
var createAxes = require("gl-axes")

//Matrix math
var mat4 = require("gl-matrix").mat4

//Bounds on function to plot
var bounds = [[-5,-5,-5], [5,5,5]]

//Plot level set of f = 0
function f(x,y,z) {
  return x*x + y*y + z*z - 2.0
}

//State variables
var mesh, axes

shell.on("gl-init", function() {
  var gl = shell.gl

  //Set up camera
  camera.lookAt(bounds[1], [0,0,0], [0, 1, 0])

  //Create mesh
  mesh = createMesh(gl, polygonize([64, 64, 64], f, bounds))

  //Create axes object
  axes = createAxes(gl, {
    bounds: bounds
  })
})

shell.on("gl-render", function() {
  var gl = shell.gl
  gl.enable(gl.DEPTH_TEST)

  //Compute camera parameters
  var cameraParameters = {
    view: camera.view(),
    projection: mat4.perspective(
        mat4.create(),
        Math.PI/4.0,
        shell.width/shell.height,
        0.1,
        1000.0)
  }
  
  //Draw mesh
  mesh.draw(cameraParameters)

  //Draw axes
  axes.draw(cameraParameters)
})

You can play with this demo yourself on requirebin.

Install

npm install gl-axes

API

Constructor

var axes = require("gl-axes")(gl[, params])

Creates an axes object.

• gl is a WebGL context
• params is an object with the same behavior as axes.update

Returns A new glAxes object for drawing the

Methods

axes.draw(camera)

Draws the axes object with the given camera parameters. The camera object can have the following properties:

• model - Is the model matrix for the axes object (default identity)
• view - Is the view matrix for the axes (default identity)
• projection - Is the projection matrix for the axes (default identity)

All camera matrices are in 4x4 homogeneous coordinates and encoded as length 16 arrays as done by gl-matrix.

axes.update(params)

Updates the parameters of the axes object using the properties in params. These can be as follows:

• bounds the bounding box for the axes object, represented as a pair of 3D arrays encoding the lower and upper bounds for each component. Default is [[-10,-10,-10],[10,10,10]]
• labels a 3D array encoding the labels for each of the 3 axes. Default is ['x', 'y', 'z']
• tickSpacing either a number or 3d array representing the spacing between the tick lines for each axis. Default is 0.5
• showAxes a vector of boolean values determining which of the 3 axes tick lines to show. Default is [true,true,true]
• tickWidth the width of a tick line in the underlying box in pixels
• font the font family to use for rendering text. Default 'sans-serif'
• axesColors an array of colors for each axis, or else a single 3D array encoding all axes colors. Default is [[0,0,0], [0,0,0], [0,0,0]]
• gridColor the color of the grid lines in the background. Default is [0,0,0]
• ticks Alternatively, you can specify custom tick labels for each axis by passing in an array of 3 arrays of tick markings. Each tick marking array is an array of objects with the properties x and text which denote the position on the tick axis and the text of the tick label respectively.
• textScale overrides the scaling computation to a default textScale in model coordinates.

axes.dispose()

Releases all resources associated with this axes object.

Credits

(c) 2014 Mikola Lysenko. MIT License