@plattar/plattar-ar-adapter

Plattar AR Adapter for interfacing with Google & Apple WebAR

Usage no npm install needed!

<script type="module">
  import plattarPlattarArAdapter from 'https://cdn.skypack.dev/@plattar/plattar-ar-adapter';
</script>

README

Plattar Logo

install size NPM License

plattar-ar-adapter allows easy interfacing with Apple Quicklook and Google SceneViewer

Quick Use

// Minified Version ES2015 & ES2019 (Latest)
https://cdn.jsdelivr.net/npm/@plattar/plattar-ar-adapter/build/es2015/plattar-ar-adapter.min.js
https://cdn.jsdelivr.net/npm/@plattar/plattar-ar-adapter/build/es2019/plattar-ar-adapter.min.js

// Standard Version ES2015 & ES2019 (Latest)
https://cdn.jsdelivr.net/npm/@plattar/plattar-ar-adapter/build/es2015/plattar-ar-adapter.js
https://cdn.jsdelivr.net/npm/@plattar/plattar-ar-adapter/build/es2019/plattar-ar-adapter.js

Installation

  • Install using npm
npm install @plattar/plattar-ar-adapter

Examples

  • Launch AR for Plattar Products & Variations
import {ProductAR} from "@plattar/plattar-ar-adapter";

// grab your product/variation ID from the Plattar CMS
const productID:string = "{YOUR_PRODUCT_ID}";
const variationID:string = "{YOUR_VARIATION_ID}";

const webAR:ProductAR = new ProductAR(productID, variationID);

webAR.init().then((ar:ProductAR) => {
    ar.start();
}).catch((err) => {
    console.error("AR Not Available");
});
  • Launch AR for Plattar Scenes
import {SceneAR} from "@plattar/plattar-ar-adapter";

// grab your scene ID from the Plattar CMS
const sceneID:string = "{YOUR_SCENE_ID}";

const webAR:SceneAR = new SceneAR(sceneID);

webAR.init().then((ar:SceneAR) => {
    ar.start();
}).catch((err) => {
    console.error("AR Not Available");
});