Contextual Comments

Contextual Comments embeds a customizable commenting experience into your Autodesk ASP viewer, enabling people to collaborate in real-time and asynchronously.

Quickstart

Contextual Comments for Autodesk APS viewer is an extension of the Contextual Comments Component. The difference from the default method is that we use AutodeskPin which automatically allow pins to work in a 3D environment.

To add AutodeskPin to your application, follow the steps below:

1

Before we start

Before utilizing the Contextual Comments component, 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 component.

2

Verify your Viewer implementation

To implement the AutodeskPin component 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 the npm package:

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

4

Import comments and AutodeskPin

After installing the package, import comments and the AutodeskPin component from the Autodesk plugin:

import { Comments } from '@superviz/sdk';
import { AutodeskPin } from '@superviz/autodesk-viewer-plugin';

5

Add comments and the AutodeskPin plugin

Initialize the AutodeskPin component, passing the viewer instance.

Add the Comments component and pass the pinAdapter instance.

Then finally add the component to your SuperViz room:

const pinAdapter = new AutodeskPin(viewer);
const comments = new Comments(pinAdapter);

room.addComponent(pinAdapter);

6

Next steps

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

Contextual Comments API Reference

AutodeskPin 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​