seng-panoramarenderer

Provides functionality for displaying simple image (or video) panorama's including basic support for hotspots.

Installation

yarn add seng-panoramarenderer

npm i -S seng-panoramarenderer

Basic usage

Simple Panorama example (make sure the images are preloaded first).

import { PanoramaRenderer } from 'seng-panoramarenderer';

const renderer = new PanoramaRenderer(wrapperElement, imageElement);
renderer.init();

Note: when the height and width of the image are both a power of two (2048x1024 or 4096x2048 for example), mip mapping can be used. This will greatly improve the visual quality of the panorama.

For more examples, please check the examples directory.

Building

In order to build seng-event, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

git clone https://github.com/mediamonks/seng-panoramarenderer.git

Change to the seng-panoramarenderer directory:

cd seng-panoramarenderer

Install dev dependencies:

yarn

Use one of the following main scripts:

yarn build            # build this project
yarn dev              # run compilers in watch mode, both for babel and typescript
yarn test             # run the unit tests incl coverage
yarn test:dev         # run the unit tests in watch mode
yarn lint             # run eslint and tslint on this project
yarn doc              # generate typedoc documentation

When installing this module, it adds a pre-commit hook, that runs lint and prettier commands before committing, so you can be sure that everything checks out.

Contribute

View CONTRIBUTING.md

Authors

View AUTHORS.md

LICENSE

MIT © MediaMonks