npm package: @olearis/view3d
Description: Fast & Customizable glTF 3D model viewer, packed with full of features!
Author: NAVER Corp.
Latest version: 2.10.4

<center>

<img width="400" src="https://naver.github.io/egjs-view3d/poster/cube.png">

# View3D

<img alt="npm (scoped)" src="https://img.shields.io/npm/v/@egjs/view3d?logo=npm"></img>
<img alt="License" src="https://img.shields.io/github/license/naver/egjs-view3d" />
<img alt="Typescript" src="https://img.shields.io/static/v1.svg?label=&message=TypeScript&color=294E80&style=flat-square&logo=typescript" />
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/naver/egjs-view3d?style=social" />

Fast & Customizable glTF 3D model viewer, packed with full of features!

👉 **[Demo](https://naver.github.io/egjs-view3d)** / **[API Document](https://naver.github.io/egjs-view3d/docs/api/View3D)** / **[Tutorial](https://naver.github.io/egjs-view3d/docs/)**

</center>

## 🔹 Features
- glTF Viewer based on the [three.js](https://github.com/mrdoob/three.js/)
  - View, rotate, translate and zoom your glTF 3D models in the web.
  - Works on both 🖥️ Desktop & 📱 Mobile
  - Customize your viewer with options like autoplay, skybox, and shadow
- Augmented Reality
  - View3D supports Augmented Reality based on WebXR, Scene Viewer, and AR Quick Look
  - You can see, rotate, move, and scale the 3D model on the floor & wall in our AR sessions.
- Supports compressed glTF 2.0 models
  - View3D can display compressed glTF models with the following extensions.
    - KHR_draco_mesh_compression
    - EXT_meshopt_compression
    - KHR_texture_basisu
- Typescript-based

## 🔹 Installation

```sh
npm i @egjs/view3d
# OR
yarn add @egjs/view3d
```

## 🔹 Quick Start
@egjs/view3d requires one wrapper & one canvas element to be initialized.

```html
<div id="view3d" class="view3d-wrapper">
  <canvas class="my-canvas"></canvas>
</div>
```

Then you can use it like

```js
import View3D from "@egjs/view3d";
import "@egjs/view3d/css/view3d-bundle.min.css";

const canvasEl = document.querySelector("#view3d");
const view3d = new View3D(canvasEl, {
  src: "URL_TO_YOUR_3D_MODEL",
  envmap: "URL_TO_YOUR_HDR_IMAGE",
});

// or just

const view3d = new View3D("#view3d");
```

See detailed explanation on our [Tutorial](https://naver.github.io/egjs-view3d/docs/)

## 🔹 Browser Support
View3D is available for the last two major versions of all evergreen desktop and mobile browsers.

## 🔹 Articles
- [WebAR with WebXR API, Part 1](https://medium.com/naver-fe-platform/webar-with-webxr-api-part-1-e191a2dc7177)
- [WebAR with WebXR API, Part 2](https://medium.com/naver-fe-platform/webar-with-webxr-api-part-2-dc76b20767fb)

## 🔹 License
```
Copyright (c) 2020-present NAVER Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```