🔰Looking Glass Core JS

(last updated July 2024)

Note: Looking Glass Core JS is no longer being actively developed. Please instead see Looking Glass Bridge SDK which includes Bridge.js which supports all of the same features and more.

Looking Glass Core (previously HoloPlay Core) apps will continue to work with Looking Glass displays sold prior to 2024.

This JavaScript library makes developing custom web-based holographic applications or integrating existing web-based rendering software with Looking Glass displays easy. With HoloPlayCore.js, developers can now interact with HoloPlay Service and obtain necessary information from the Looking Glass.

You can use this library to build a variety of web apps ranging from a simple gallery for displaying quilts to a complete 3D rendering program. For an example implementation of how to use looking glass core.js to develop web-based 3D rendering program, review the HoloPlay.js source code and its documentation, though note that this library has now been designated legacy software as it is no longer being actively maintained.

Features

• A client to communicate with HoloPlay Service.

• Shows calibration data and window information.

• Pre-defined Message objects make communication easier.

• Quilt loading and viewing functionality (see ShowMessage for more details).

Requirements

The end user must have Looking Glass Bridge installed on their machine.

Quick Start

Installation

From npm:

npm install --save holoplay-core

From CDN:

<script src="https://unpkg.com/holoplay-core"></script>

Usage

Include in html with script tag: (use holoplaycore.min.js for the minified version)

<script src="./node_modules/holoplay-core/dist/holoplaycore.js"></script>
<script>
  const client = new HoloPlayCore.Client(
      (msg) => {
        console.log('Calibration values:', msg);
      },
      (err) => {
        console.error('Error creating HoloPlay client:', err);
      });
</script>

or skip the script tag and import the ES6 module (note the different filename!):

<script type="module">
  import * as HoloPlayCore from './node_modules/holoplay-core/dist/holoplaycore.module.js';
  const client = new HoloPlayCore.Client(
      (msg) => {
        console.log('Calibration values:', msg);
      },
      (err) => {
        console.error('Error creating HoloPlay client:', err);
      });
</script>

or in Node:

const HoloPlayCore = require('holoplay-core');
const client = new HoloPlayCore.Client(
      (msg) => {
        console.log('Calibration values:', msg);
      },
      (err) => {
        console.error('Error creating HoloPlay client:', err);
      });

API References

Visit our documentation on the HoloPlayCore.js API for more detailed support on how to effectively use and integrate HoloPlayCore.js into your application.

Examples

Visit our documentation on HoloPlayCore.js example code for more details on implementation.

Questions

Email us at [e-mail] if you have any further questions about how you can integrate HoloPlay Core into your software.