Base class for all viewer implementations.

It contains everything that is needed to connect to the Autodesk viewing service and display 3D models. It also includes basic navigation support, and context menu and extension APIs.

Changes the active layer state. Get a list of all available layerStates and their active status through getLayerStates.

Returns true if any layer is hidden.

Not yet implemented for 3D.

Returns true if every node is visible.

Clears the selection.

Restore original colors for all themed shapes.

Given coordinates in pixel screen space it returns information of the underlying geometry node. Hidden nodes will not be taken into account. Returns null if there is no geometry in the specified location. For 2d models, it will return null outside the paper. See also worldToClient().

Create ViewCube.

Display ViewCube.

Display ViewCube.

Explodes the model from the center of gravity.

Not applicable to 2D.

Unloads any loaded extensions and then uninitializes the viewer.

Fits camera to objects by ID. It fits the entire model if no ID is provided. Operation will fit to the model’s bounding box when its object tree is not available. To enqueue a fitToView() operation, use viewer.getObjectTree()’s callback(s).

Returns the name of the active navigation tool.

Returns the selected items from all loaded models.

Returns the state of first person tool popup

Not applicable to 2D.

Gets the camera so it can be modified by the client.

Fetch a click action configuration entry.

Returns a list of active cut planes

Not applicable to 2D

Returns the default navigation tool

Returns the explode scale.

Not applicable to 2D.

Returns the state of first person tool popup

Not applicable to 2D.

Gets the current camera focal length.

Gets the current camera vertical field of view.

Returns an array of the IDs of the currently hidden nodes. When isolation is in place, there are no hidden nodes returned because all nodes that are not isolated are considered hidden.

Returns an array of the IDs of the currently isolated nodes.

Not yet implemented for 2D.

Returns information for each layer state: name, description, active. Activate a state through activateLayerState.

Get the memory stats when using on demand loading.

Gets the current state of the navigation lock.

Gets the current configuration of the navigation lock.

Gets the viewer model object tree. Once the tree is received it will invoke the specified callback function.

You can use the model object tree to get information about items in the model. The tree is made up of nodes, which correspond to model components such as assemblies or parts.

Gets the properties for an ID. Once the properties are returned, the method raises a onPropertiesReady event.

Captures the current screen image as Blob URL Blob URL can be used like a regular image url (e.g., window.open, img.src, etc) If width and height are 0, returns asynchronously and calls the callback with an image as Blob URL with dimensions equal to current canvas dimensions If width and height are given, returns asynchronously and calls the callback with the resized image as Blob URL If no callback is given, displays the image in a new window. See also getScreenShotBuffer().

Alternative call to getScreenShot() which internally uses additional steps (more processing) to generate the screenshot.

Returns the current selection.

Returns the number of nodes in the current selection.

Returns information about the visibility of the current selection.

Gets the view state as a plain object.

Ensures the passed in dbid / ids are hidden.

Hides all lines in the scene.

Temporarily remove a model from the Viewer, but keep loaders, materials, and geometry alive.

Hides all points in the scene.

Create any DOM and canvas elements, and setup WebGL.

Initializes all gui settings to their defaults or to the session stored setting This gives session stored settings priority

Returns true if the layer is visible.

Not yet implemented for 3D.

Returns true if the specified node is visible. The model argument is required only when in multi-model scenarios.

Isolates one of many sub-elements. You can pass in a node or an array of nodes to isolate. Pass in null to reset isolation.

Join a live review session.

Leave a live review session.

Loads a model into the viewer.

Localize the viewer. This method can be overwritten so that the subclasses can localize any additional elements.

Expose if the model has topology information downloaded. Only applicable to 3D models.

Play animation if animation data is available as part of model data. If the model data does not contain any animation, this function call is a no op.

Here is an example of callback function.
function(value) {
    if (value < 100)
        console.log("Animation progress: " + value + "%.");
    else
        console.log("Animation finished.");
}

Registers a new callback that modifies the context menu. This allows extensions and others to add, remove, or change items in the context menu. Extensions that call registerContextMenuCallback() should call unregisterContextMenuCallback() in their unload().

// Here's an example that appends a new context menu item:

viewer.registerContextMenuCallback('MyExtensionName', function (menu, status) {
    if (status.hasSelected) {
        menu.push({
            title: 'My new context menu item with selected objects',
            target: function () {
                alert('Do something with selected objects');
        });
    } else {
        menu.push({
            title: 'My new context menu item, no selected objects',
            target: function () {
                alert('Do something else');
        });
    }
});

Resizes the viewer.

Restores the viewer state from a given object.

Searches the elements for the given text. When the search is complete, the callback onResultsReturned(idArray) is invoked.

Selects the array of ids. You can also just pass in a single id instead of an array.

Currently three ways of node selection are supported:

• Autodesk.Viewing.SelectionMode.MIXED
  • Leaf nodes are selected using the overlayed selection type, and inner nodes are selected using the regular selection type.
• Autodesk.Viewing.SelectionMode.REGULAR
  • Nodes are tinted with the selection color.
• Autodesk.Viewing.SelectionMode.OVERLAYED
  • Nodes are tinted with the selection color and shown on top of the not selected geometry.

Swaps the current navigation tool for the tool with the provided name. Will trigger NAVIGATION_MODE_CHANGED event if the mode actually changes.

Sets the background color.

Toggles bimwalk tool popup.

Not applicable to 2D.

Sets the click behavior on the canvas to follow config. This is used to change the behavior of events such as selection or COI changed.

{
      "click": {
          "onObject": [ACTIONS],
          "offObject": [ACTIONS]
      },
      "clickCtrl": {
          "onObject": [ACTIONS],
          "offObject": [ACTIONS]
      },
      "clickShift": {
          ...
      },
      "clickCtrlShift": {
          ...
      },
      "disableSpinner": BOOLEAN
      "disableMouseWheel": BOOLEAN,
      "disableTwoFingerSwipe": BOOLEAN
 }

Actions can be any of the following:
- selectOnly
- selectToggle
- deselectAll
- isolate
- showAll
- setCOI
- focus
- hide

Modifies a click action configuration entry.

Modify the default click behaviour for the viewer.

Sets the object context menu.

Apply a list of cut planes

Not applicable to 2D

Activates the default context menu. Contains options Isolate, Hide selected, Show all objects, Focus and Clear selection.

Sets the default navigation tool. This tool will always sit beneath the navigation tool on the tool stack.

Turns edge topology display on/off (where available)

Toggles environment map for background.

Not applicable to 2D.

Toggles first person tool popup.

Not applicable to 2D.

Sets the current cameras focal length.

Sets the current cameras vertical field of view.

Toggles ghosting during search and isolate.

Not applicable to 2D.

Toggles ground reflection.

Not applicable to 2D.

If enabled, set ground reflection alpha. This is reset to default when reflections toggled off.

Not applicable to 2D

If enabled, set ground reflection color. This is reset to default when reflections toggled off.

Not applicable to 2D

Toggles ground shadow.

Not applicable to 2D.

If enabled, set ground shadow alpha

Not applicable to 2D

If enabled, set ground shadow color

Not applicable to 2D

Set visibility for a single layer, or for all layers.

Not yet implemented for 3D.

Sets the Light Presets (Environments) for the Viewer.

Not applicable to 2D.

Sets the preference in the UI

Set model units

Locks or unlocks navigation controls.

When navigation is locked, certain operations (for example, orbit, pan, or fit-to-view) are disabled.

Updates the configuration of the navigation lock, i.e., which actions are available when navigation is locked.

The configurable actions are ‘orbit’, ‘pan’, ‘zoom’, ‘roll’, ‘fov’, ‘walk’, or ‘gotoview’. By default, none of the actions are enabled when the navigation is locked.

Toggles whether the navigation should be optimized for performance. If set to true, anti-aliasing and ambient shadows will be off while navigating.

Not applicable to 2D.

Set or unset a view navigation option to allow the orbit controls to move the camera beyond the north and south poles (world up/down direction). In other words, when set the orbit control will allow the camera to rotate into an upside down orientation. When unset orbit navigation should stop when the camera view direction reaches the up/down direction.

Not applicable to 2D.

Sets the preference in the UI

Toggles whether progressive rendering is used. Warning: turning progressive rendering off will have serious performance implications.

Enables or disables the high quality rendering settings.

Not applicable to 2D.

Toggles rendercache feature.

Not applicable to 2D.

Set or unset a view navigation option to reverse the default direction for horizontal look operations.

Not applicable to 2D.

Sets the preference in the UI

Set or unset a view navigation option to reverse the default direction for vertical look operations.

Not applicable to 2D.

Sets the preference in the UI

Set or unset a view navigation option to reverse the default direction for camera dolly (zoom) operations.

Sets the preference in the UI

Changes color of the selection for a particular selection type.

• Autodesk.Viewing.SelectionMode.MIXED
  • Sets the same color for regular and overlayed selection.
• Autodesk.Viewing.SelectionMode.REGULAR
  • Sets the color of regular selection.
• Autodesk.Viewing.SelectionMode.OVERLAYED
  • Sets the color of overlayed selection.

viewer.setSelectionColor(new THREE.Color(0xFF0000), Autodesk.Viewing.SelectionMode.MIXED); // red color

Sets selection granularity mode. Supported values are:

• Autodesk.Viewing.SelectionMode.LEAF_OBJECT
  • Always select the leaf objects in the hierarchy.
• Autodesk.Viewing.SelectionMode.FIRST_OBJECT
  • For a given node, selects the first non-composite (layer, collection, model) on the path from the root to the given node, and all children.
• Autodesk.Viewing.SelectionMode.LAST_OBJECT
  • For a given node, selects the nearest ancestor composite node and all children. Selects the input node itself in case there is no composite node in the path to the root node.

AutoCAD drawings are commonly displayed with white lines on a black background. Setting reverse swaps (just) these two colors.

Highlight an object with a theming color that is blended with the original object’s material.

Set or unset a view navigation option which requests that mouse buttons be reversed from their default assignment. i.e. Left mouse operation becomes right mouse and vice versa.

Sets the preference in the UI

Set or unset a view navigation option which requests that orbit controls always orbit around the currently set pivot point.

Sets the preference in the UI

Set the face of ViewCube and apply camera transformation according to it.

Sets the view from an array of parameters.

Sets the view using the default view in the source file.

Sets the view from an array representing a view box.

Not applicable to 3D.

Get the state of the view navigation option that requests the default direction for camera dolly (zoom) operations to be towards the camera pivot point.

Sets the preference in the UI

Ensures the passed in dbid / ids are shown.

Ensures everything is visible. Clears all node isolation (3D) and turns on all layers (2D).

Make a previously hidden model visible again.

Initializes the viewer and loads any extensions specified in the constructor’s config parameter. If the optional parameters are specified, the start() function will use an optimized initialization sequence that results in faster model load. The parameters are the same as the ones for Viewer3D.loadModel and you do not need to call loadModel subsequently if the model is loaded via the call to start().

Toggles the selection for a given dbid. If it was unselected, it is selected. If it was selected, it is unselected.

Currently three ways of node selection are supported:

• Autodesk.Viewing.SelectionMode.MIXED
  • Leaf nodes are selected using OVERLAYED and inner nodes are selected using REGULAR selection type.
• Autodesk.Viewing.SelectionMode.REGULAR
  • Nodes are tinted with the selection color.
• Autodesk.Viewing.SelectionMode.OVERLAYED
  • Nodes are tinted with the selection color and shown on top of the not selected geometry.

Not yet implemented for 2D.

Toggles the visibility of the given node.

Not yet implemented for 2D.

ADP

Transfer model from this viewer to another one - including state of selection, ghosting, and theming.

Removes all created DOM elements and performs any GL uninitialization that is needed.

Unregisters an existing callback that modifies the context menu. Extensions that call registerContextMenuCallback() should call unregisterContextMenuCallback() in their unload().

Calculates the pixel position in client space coordinates of a point in world space. See also clientToWorld().

Fired when the list of selected objects changes in a multi-model context.

Fired when animations are successfully initialized.

Fired when a camera changes.

Fired when the cutting planes change.

Fired when the ESC key is pressed.

Fired whenever the Explode tool is used.

Fired when a viewer extension is successfully loaded.

Fired when a viewer extension is successfully unloaded.

Fired when the render frame shown by the Viewer is final or complete (it has no more pending geometry or post processing effects which delay incoming frames), or when the Viewer stops showing final frames.

Fired when a fitToView operation is applied.

Fired when fragments are loaded on demand

Fired when the screen mode changes.

Fired when the model/drawing finishes loading.

Fired when the viewer hides a set of objects.

Fired when user clicks on a hyperlink embedded in the model.

Fired when the viewer isolates a set of objects (i.e., makes everything else invisible or ghosted).

Fired when visibility of a 2D layer changes.

Fired when something in the view changes that may expose missing geometry.

Fired when the viewer receives and parses the initial model manifest.

Fired when a model is removed from the viewer.

Fired then the navigation tool changes.

Fired when the instance tree is successfully created.

Fired when there’s an error while parsing the instance tree.

Fired when a user preference property changes.

Fired when a single user preference property is reset.

Fired repeatedly throughout the process of opening a model/drawing.

Fired when rendering options change.

Fired when the render has presented to the screen.

Fired when a model is reset to its initial configuration.

Fired when the user clicks on the UI for restoring default settings. Will get fired after all other Autodesk.Viewing.PREF_CHANGED_EVENT get fired.

Fired when the list of selected objects changes.

Fired when the viewer shows a set of objects.

Fired when the model/drawing textures finish loading.

Fired when a tool is activated or deactivated.

Fired when the viewer is fully initialized.

Fired when the viewer size changes.

Fired when the viewer state is restored.

Fired when the viewer is fully uninitialized.