A standalone panorama viewer with WebGL
Branch: master
Clone or download
Latest commit 37fd486 Aug 5, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
.babelrc bam! Jun 8, 2017
.gitignore bam! Jun 8, 2017
.npmignore
LICENSE.md
README.md working on docs and demo Aug 4, 2017
index.js
package-lock.json 1.0.1 Aug 4, 2017
package.json 1.0.1 Aug 4, 2017

README.md

360-image-viewer

A standalone panorama WebGL image viewer for desktop and mobile. This uses regl as the WebGL wrapper, and comes in at a total of 140kb uglified, or 46kb gzipped. This is useful if you need a panorama viewer but don't want to embed all of ThreeJS (which is around 500kb uglified).

Install

npm install 360-image-viewer --save

Live Demo

Click here to see a demo of this module in action. The source code is in demo/index.js.

Example

The code below sets up a full-screen 360 image viewer. For a more complete example, see demo/index.js.

const create360Viewer = require('360-image-viewer');
const canvasFit = require('canvas-fit');

// load your image
const image = new Image();
image.src = 'panosphere.jpg';

image.onload = () => {
  // when the image is loaded, setup the viewer
  const viewer = create360Viewer({
    image: image
  });

  // attach canvas to body
  document.body.appendChild(viewer.canvas);

  // setup fullscreen canvas sizing
  const fit = canvasFit(viewer.canvas, window, window.devicePixelRatio);
  window.addEventListener('resize', fit, false);
  fit();

  // start the render loop
  viewer.start();
};

Usage

viewer = create360Viewer([opt])

Creates and returns a new WebGL canvas viewer with the specified opt options object.

Options:

  • image — the HTMLImageElement, if not specified it can be set later
  • canvas — a <canvas> tag to use, otherwise creates a new one
  • fov — a field of view, in radians, defaults to 45 degrees
  • rotateSpeed — a scalar for the drag rotation speed, default 0.15
  • damping — a scalar for damping/spring, default 0.275
  • clearColor — a RGBA clear color, default [ 0, 0, 0, 0 ] (ie. transparent)

You can also pass orbit-controls options, for example phi as the initial rotation, or passing { rotate: fale } to ignore mouse/touch rotation.

The image should be a DOM Image or Video element, and should already be loaded.

viewer.start()

Start the requestAnimationFrame render loop.

viewer.stop()

Stop the requestAnimationFrame render loop.

viewer.render()

Render a single frame. This may be useful if, say, you change the canvas size when the requestAnimationFrame is not running.

viewer.enableControls()

Enable the input controls, attaching mouse/touch events to the canvas. Has no effect if the controls are already enabled.

viewer.disableControls()

Disable the input controls, detaching mouse/touch events from the canvas. Has no effect if the controls are already disabled.

viewer.texture(image)

Changes the current image to the specified DOM image. This can be an image, video, or an options object for regl#texture(). By default, min and mag filter will use 'linear' for smoother filtering.

viewer.destroy()

Stop the render loop, disable the input controls, and destroy the WebGL context. The viewer will no longer be usable after this point.

viewer.canvas

The canvas the viewer will render into.

viewer.fov

The current field of view of the perspective camera in radians. Can be altered at run-time.

viewer.phi

The current horizontal rotation angle in radians.

viewer.theta

The current vertical rotation angle in radians.

viewer.on('tick', fn)

Attach a frame listener to the viewer, where fn accepts the dt (delta time) parameter per frame. You can remove this with viewer.removeListener('tick', fn).

License

MIT, see LICENSE.md for details.