@superviz/autodesk-viewer-plugin

SuperViz Autodesk viewer SDK plugin

SuperViz provides a suite of programmable low-code Collaboration and Communication components, all synchronized with an advanced Real-time Data Engine, enabling real-time and asynchronous collaboration and communication within any JavaScript based application.

The SuperViz Autodesk Plugin, when integrated, connects a Autodesk scene to the SuperViz SDK, allowing avatars, pinned comments, and other collaborative features within the 3D environment for a shared participant experience.

Note: to use this package, you must also have the following minimum versions:

• SuperViz SDK, minimum version 5.0.0
• Autodesk Viewer, minimum version 7.0.0

Getting started

1. Installing SuperViz Autodesk extension

The Presence3D component is not available from the @superviz/sdk package, instead, to use Presence 3D you must use the @superviz/autodesk-plugin package.

To install the @superviz/autodesk-viewer-plugin package with npm, run the following command:

npm install --save @superviz/autodesk-viewer-plugin

Or with Yarn:

yarn add @superviz/autodesk-viewer-plugin

2. Adding Autodesk to SuperViz SDK

To add an Autodesk Presence3D component, you can use the following code:

import { Presence3D } from '@superviz/autodesk-viewer-plugin';

Autodesk.Viewing.Initializer(options, async () => {
  const viewerDiv = document.getElementById('forge-viewer');
  const viewer = new Autodesk.Viewing.GuiViewer3D(viewerDiv);

  await viewer.start();

  const autodeskPresence = new Presence3D(viewer, {
    isAvatarsEnabled: true,
    isLaserEnabled: true,
    isNameEnabled: true,
    avatarConfig: {
      height: 0,
      scale: 1,
      laserOrigin: { x: 0, y: 0, z: 0 },
    },
  });

  sdk.addComponent(autodeskPresence);
});

Please check the documentation for more information about the Presence3D component.

Contributing

Issues

To report a new bug, request a new feature, or if you need any help, you can file an issue on GitHub. We have a few templates to help you out.

License

SuperViz SDK is licensed under the BSD 2-Clause License.