Skip to main content

Presence for AutoDesk APS Viewer

Our Autodesk plugin is designed to seamlessly integrate avatars, mouse-pointers, lasers, and host controls into your digital twin tool.

Before we start​

It is important to initialize a room with a defined name, ID, and avatar for the participant and for the group, as it will be used to store the comment data on our servers.

If no avatar is provided, then a default avatar from SuperViz will be used.

tip

When using Video Conference together with Presence3D you can enable users to select from our list of avatars, by setting the flag defaultAvatars as true on the Video Conference constructor.

Initializing Autodesk​

To initialize the Presence3D for Autodesk, you will need to first have an HTML element loaded with the Autodesk and have the viewer instance from Autodesk, like in the code below:

const viewer = new Autodesk.Viewing.GuiViewer3D(viewerDiv, config3d);

The minimum Autodesk Platform Services Viewer version required is version 7**.**

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 use the @superviz/autodesk-viewer-plugin package please add the script below before the </head>

<script type="module" src="https://unpkg.com/@superviz/autodesk-viewer-plugin@latest"></script>

How to use it​

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 },
	  },
	});

	room.addComponent(autodeskPresence);
});

When initializing the Presence3D you must pass the Autodesk viewer already loaded as the first parameter (the viewer variable on the sample above), and as a second parameter you can use an options object with the listed properties:

NameTypeDescription
avatarConfigAvatarConfigConfiguration for avatar, like scale, position, on and laser configuration.
isAvatarsEnabledbooleanEnable or disable the need for avatar in the room.
Default value: true
isLaserEnabledbooleanEnable or disable laser pointers. If isAvatarsEnabled is set to false, this will also be false.
Default value: true
isMouseEnabledbooleanEnable or disable Mouse presence within the 3D model.
Default value: true
isNameEnabledbooleanEnable or disable showing the participant's name on top of the avatars.
Default value: true
warning

Please, make sure to only initialize the Presence3D once the Autodesk Viewer is fully loaded, otherwise you won’t be able to initialize the use of the component.

Methods​

follow()​

The follow() method, when called with a participant id as an argument, allows other participants to follow the referenced participant on the Autodesk viewer. You can, after, call the method without parameters to stop following the participant.

Example:

// Pass a participant ID to start following it
autodeskPresence.follow("<PARTICIPANT_ID>");

// Call the method without parameters to stop following the past participant
autodeskPresence.follow();

goTo()​

The goTo() method, when called with a participant id as an argument, allows other participants to quickly jump to the referenced participant position on the Autodesk, facilitating quick location of participants.

Example:

autodeskPresence.goTo("<PARTICIPANT_ID>");

Types Definition​

AvatarConfig​

Type: object

An object describing the configuration for avatar, like scale, position, and laser configuration.

NameTypeDescription
heightnumberRequired. The scale you want your avatar to be rendered, in pixels.
scalenumberRequired. The height you want your avatar to be positioned from the ground, in pixels.
laserOriginPositionRequired. Represents the origin position of your laser beam in relation to your avatar model.

Example:

avatarConfig: {
  height: 1.6,
  scale: 1,
  laserOrigin: {
    x: 0,
    y: 0,
    z: 0
  }
}

Position​

Type: object

Represents the origin position of your laser beam in relation to your avatar model.

NameTypeDescription
xnumberRequired. Represents the x-axis (horizontal) position.
ynumberRequired. Represents the y-axis (vertical) position.
znumberRequired. Represents the z-axis (depth) position.

Example:

laserOrigin: {
  x: 0,
  y: 0,
  z: 0
}