Presence3D

Presence3D automatically Implements Avatars, Mouse Pointers and Presence Controls into a Autodesk APS viewer.

Quickstart

To add the Presence3D component to your application, follow the steps below:

1

Before we start

Before utilizing the Presence3D plugin, it is essential to initialize a room with a defined name and ID for the participant and the group. You need to have the room variable to add the Presence3D plugin.

2

Verify your Viewer implementation

To implement the Presence3D plugin it's essential that your you have access to the viewer instance that you will need to pass to our plugin.

Here you can see a basic Autodesk APS viewer implementation:

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

  await viewer.start();
});

3

Install the package

Install the Autodesk plugin package with npm:

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

4

Import the Presence3D component

After installing the package, import the Presence3D component from the Autodesk package:

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

5

Add the Presence3D plugin

Initialize the Presence3D plugin with the viewer instance and add it to your SuperViz room:

const autodeskPresence = new Presence3D(viewer);

room.addComponent(autodeskPresence);

6

Configure Presence3D (Optional)

You can customize the Presence3D component by passing configuration options when initializing it. These options allow you to control features such as avatars, laser pointers, and participant names. For a full list of available options, refer to our API Reference.

Here's an example of how to configure Presence3D with some common options:

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

7

Next steps

You are now all set! See what else can you do:

Autodesk Plugin API Reference

Resources to get you started

We've prepared a few resources to help you get started with the Autodesk integration and use it alosing with other components to create a collaborative environment.

Quickstart​