ModelHandle/README.md
2021-05-29 14:18:52 +02:00

62 lines
2.3 KiB
Markdown

# Online 3D Viewer
Online 3D Viewer (https://3dviewer.net) is a free and open source web solution to visualize and explore 3D models right in your browser. This repository contains the source code of the website and the library behind it.
[![Build status](https://ci.appveyor.com/api/projects/status/exypq43a8kjby5n0?svg=true)](https://ci.appveyor.com/project/kovacsv/online3dviewer)
[![Build Status](https://travis-ci.com/kovacsv/Online3DViewer.svg?branch=master)](https://travis-ci.com/kovacsv/Online3DViewer)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/kovacsv/Online3DViewer.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/kovacsv/Online3DViewer/context:javascript)
<kbd><img src="https://user-images.githubusercontent.com/2034315/120069776-f183d980-c087-11eb-8948-f51a44e0579c.png"></kbd>
## Documentation
The repository is separated into two parts. See more information in the [Developer Documentation](https://github.com/kovacsv/Online3DViewer/wiki).
* **Online 3D Viewer Website**: Source code of the web solution with all of the pages and functions.
* **Online 3D Viewer Engine**: Source code of the library to visualize models easily.
## Supported file formats
### Import
- obj (with mtl and texture)
- 3ds (with texture)
- stl (text and binary)
- ply (text and binary)
- gltf (text and binary)
- 3dm (experimental)
- off (text only)
### Export
- obj (with mtl)
- stl (text and binary)
- ply (text and binary)
- gltf (text and binary)
- 3dm (experimental)
- off (text only)
## Features
- Load model:
- Select files from a file browser dialog.
- Drag and drop files from your computer.
- Specify files by web url.
- Specify files by web url in hash parameters.
- Explore model:
- Orbit, pan, zoom.
- Set up direction.
- Fit to window.
- Investigate model:
- List used and missing files.
- List all materials and meshes.
- Show/hide and zoom to a specific mesh.
- List materials used by a specific mesh.
- Show model information (model size, vertex and polygon count).
- Export model to various format.
- Embed viewer in your website.
## External Libraries
Online 3D Viewer uses these wonderful libraries: [jquery](https://github.com/jquery/jquery), [three.js](https://github.com/mrdoob/three.js), [rhino3dm](https://github.com/mcneel/rhino3dm).