Panolens.js

Javascript panorama viewer based on Three.js

Image viewer
pchen66/panolens.jspchen66.github.io/Panolens/panolens

README

Panolens.js

[![NPM package][npm]][npm-url] [![License][license]][license-url] [![Bundle Size][bundle-size]][bundle-size-url] [![Build Status][build-status]][build-status-url] [![Dependencies][dependencies]][dependencies-url] [![Dev Dependencies][dev-dependencies]][dev-dependencies-url] [![Language Grade][lgtm]][lgtm-url] [![Coverage][coverage]][coverage-url]

Javascript 360 Panorama Viewer


Panolens.js is an event-driven and WebGL based panorama viewer. Lightweight and flexible. It's built on top of Three.JS.

Examples —
Documentation —
Migration —
FAQ

Panorama Demo


Usage


Include three.min.js and panolens.min.js

To find the correct supported versions, please check dependencies section in package.json or acess PANOLENS.VERSION or PANOLENS.THREE_VERSION at runtime.

  1. ``` html
  2. <script src="js/three.min.js"></script>
  3. <script src="js/panolens.min.js"></script>
  4. ```
The following code generates a 360 image panorama. The first panorama added to the viewer will be the entry point. To link panoramas, use panorama.link( other_panorama, new THREE.Vector3( X, Y, Z ) ) to connect the two.
  1. ``` js
  2. const panorama = new PANOLENS.ImagePanorama( 'asset/equirectangular.jpg' );
  3. const viewer = new PANOLENS.Viewer();
  4. viewer.add( panorama );
  5. ```

Dependency


Panolens.js includes Tween.js by default, meaningTWEEN will be available with window object

How to contribute


Always make your contributions for the latest dev branch, not master, so it can be tracked for the next release.

Development

  1. ```
  2. npm start
  3. ```

Build

  1. ```
  2. npm run build-closure
  3. ```

[npm]: https://img.shields.io/npm/v/panolens.svg
[npm-url]:https://www.npmjs.com/package/panolens
[license]: https://img.shields.io/github/license/pchen66/panolens.js.svg
[license-url]: ./LICENSE
[bundle-size]: https://badgen.net/bundlephobia/minzip/panolens
[bundle-size-url]: https://bundlephobia.com/result?p=panolens
[build-status]: https://travis-ci.com/pchen66/panolens.js.svg?branch=dev
[build-status-url]: https://travis-ci.com/pchen66/panolens.js
[dependencies]: https://img.shields.io/david/pchen66/panolens.js.svg
[dependencies-url]: https://david-dm.org/pchen66/panolens.js
[dev-dependencies]: https://img.shields.io/david/dev/pchen66/panolens.js.svg
[dev-dependencies-url]: https://david-dm.org/pchen66/panolens.js?type=dev
[lgtm]: https://img.shields.io/lgtm/grade/javascript/g/pchen66/panolens.js.svg?logo=lgtm&logoWidth=18&label=code%20quality
[lgtm-url]: https://lgtm.com/projects/g/pchen66/panolens.js/context:javascript
[coverage]: https://coveralls.io/repos/github/pchen66/panolens.js/badge.svg?branch=dev
[coverage-url]: https://coveralls.io/github/pchen66/panolens.js?branch=dev
[panolens-support]: https://pics.paypal.com/00/p/NDIyZmRiMGEtMGQyMy00Y2QzLWI1YWQtZmY1OGI1MzRjNDYw/image_2.PNG
[panolens-support-url]: https://www.paypal.me/panolens