ShapeDiver 3D Viewer
You are reading the documentation of the public API of the ShapeDiver 3D viewer v2. This is the result of a complete software redesign of ShapeDiver's 3D viewer v1. It offers the following advantages over v1:
- new API v2 making use of promises
- support for multiple simultaneous sessions with one or several ShapeDiver models
- drag & drop, selection, highlighting
- advanced rendering and materials
- advanced control of the 3D scene (geometry and lighting)
- support for multiple viewports
- file/blob parameter types
- AR support soon to be there
Read more about ShapeDiver and 3D product configurators.
API
API v2
The new API v2 offers numerous advantages over API v1:
- supports promises and provides direct feedback of the result of asynchronous operations
- consistent naming convention
- support for changing of materials, and updating/adding of geometry
- support for drag & drop, selection, and highlighting
- support for configuration of the 3D scene lighting
- support for multiple viewports
- file/blob parameter types
API v1
The API v1 is offered for backwards compatibility with the API of ShapeDiver's 3D viewer v1.
We discourage use of the API v1 for developing new applications.
Questions, feedback, bugs
Don't hesitate to ask questions and provide feedback, please use our forum for this purpose. Should you find a bug, please report it in our forum or email us.
Notice for developers
The JavaScript API objects might contain additional members or functionality which are not documented here. Do not use such undocumented functionality. Such additional functionality will likely be changed or removed by us between releases or patches without further notice.
Browser support
The ShapeDiver 3D viewer v2 supports the following browsers:
- Chrome
- Firefox
- Edge
- Safari
- Internet Explorer 11
- Modern Smartphones and tablets, Android and iOS
External dependencies
-
WebGL based library used to create and display animated 3D computer graphics on a Web browser
-
Alternative promise based standalone HTTP-client to replace jQuery
verb-nurbs - optional
verb is a library for creating and manipulating NURBS surfaces and curves in many languages including JavaScript
Release Notes
| Version | Release date | Notes |
|---|---|---|
| ------ | -------------- | ------------------ |
| 2.0.6 | 2018-07-01 | API v2 available |
| ------ | -------------- | ------------------ |
| 2.0.7 | 2018-08-22 | Browser testing |
| ------ | -------------- | ------------------ |
| 2.0.8 | 2018-08-30 | Parameter history API |
| ------ | -------------- | ------------------ |
| 2.1.0 | 2018-10-12 | Multiple viewports, browser tested |
| ------ | -------------- | ------------------ |
| 2.2.0 | 2018-11-23 | oauth2 support fixed iOS texture problems fixed rendering of transparent objects drag/selection/hovering handler now supports touch events |
| ------ | -------------- | ------------------ |
| 2.3.0 | 2018-12-20 | improved rendering for transparent objects gems rendering fixes to responsive layout of viewer and controls/settings containers iframe API reflector supports addEventListener diverse bugfixes |
| ------ | -------------- | ------------------ |
| 2.4.0 | 2019-01-21 | export dialog bugfix CommPlugin error message improvements viewport resizing fix rendering bugfixes |
| ------ | -------------- | ------------------ |
| 2.5.0 | 2019-02-01 | anchor object documentation improvements and bugfix |
| ------ | -------------- | ------------------ |
| 2.6.0 | 2019-03-01 | THREE.LineSegments and THREE.LineLoop are supported now in addition to THREE.Line IE11 support restored Live transformations API Fixed crash when loading empty scene Pass on scroll events in case zooming is disabled Added further properties to AnchorEventData Support for settings for multiple viewports new setting ignoreSuperseded for CommPlugin fix in constructor SDVApp.ParametricViewer to allow an empty container array to be passed new camera settings for auto adjusting and revert at mouse up glb loader now uses browser cache Settings widget light intensity sliders max value increased to 5 CommPlugin sent export requests instead of export-cache requests Export modal dialog did not show message to user in case of download export not resulting in a downloadable file Material defined for SceneAsset takes precedence over materials defined in SceneAssetItems. |
Version
- Version: 2.6.0
- Build date: 2019-04-29T14:18:18.164Z
- Branch: 2.6.0
- Commit: 7fe94b241b08bca0b800141277524934abcd2ac9