Base class for all viewer implementations. It contains everything that is needed to connect to the Autodesk’s Forge service and display 2D and 3D models. It also includes basic navigation support, context menu and extension APIs.

Loads the extension with the given id and options. For internal use only.

Returns the loaded extension.

Unloads the extension with the given id. For internal use only.

Loads the extension with the given id and options. For internal use only.

Available from version 2.15

Loads an extension JavaScript file from a URL. It will download the file, parse it and then invoke loadExtension(). Calling this function a second time will not download the file again.

Available from version 2.15

viewer.loadExtensionAsync(
       'MyExtensionId',
       'http://my.site.com/path/MyExtension.js',
       {}
   ).then(function(ext){
       ext.doSomething();
   }).catch(function(error){
       console.error(error);
   });

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().

Loading extensions and initializing canvas interactions. Invoked automatically by Autodesk.Viewing.Viewer3D#start method.

Unloads extensions and the model loaded. Invoked automatically by Autodesk.Viewing.Viewer3D#finish method.

Triggers the Viewer’s render loop. Invoked automatically by Autodesk.Viewing.Viewer3D#start method. Refer to [ViewerConfig.startOnInitialize]`ViewerConfig <#fixMe/>`_ to change start’s method behavior.

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

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

Unloads any loaded extensions and then uninitializes the viewer.

Loads a model into the viewer. Can be used sequentially to load multiple 3D models into the same scene.

Returns the dimensions of the WebGL canvas.

Resizes the viewer. Required when wrapping div changes dimensions due to CSS changes.

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

Gets the view state as a plain object. A viewer state contains data for the viewport, selection and isolation,

Restores the viewer state from a given object.

Sets the view from an array representing a view box.

Not applicable to 3D.

Changes the active layer state. Layes is a feature usually available on 2D models and some 3D models.

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

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

Gets the properties for an ID.

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.

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
}

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

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.

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.

Sets the background colors, which will be used to create a gradient. Values are in the range [0..255]

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 the overlayed selection type, 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.

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 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.

Clears the selection.

Returns information about the visibility of the current selection.

Returns the number of nodes in the current selection.

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.

Returns the current selection.

Returns the selected items from all loaded models.

Returns the isolated items from all loaded models.

Returns the hidden nodes for all loaded models.

Ensures the passed in dbid / ids are hidden.

Ensures the passed in dbid / ids are shown.

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

Toggles the visibility of the given node.

Not yet implemented for 2D.

Returns true if every node is visible.

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

Explodes the model from the center of gravity.

Not applicable to 2D.

Returns the explode scale.

Not applicable to 2D.

Enables or disables the high quality rendering settings.

Not applicable to 2D.

Toggles ghosting during search and isolate.

Not applicable to 2D.

Toggles ground shadow.

Not applicable to 2D.

Toggles ground reflection.

Not applicable to 2D.

Toggles environment map for background.

Not applicable to 2D.

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

Overrlides line colors in 2D models to render in shades of gray. Applies only to 2D models.

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

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.

Locks or unlocks navigation controls.

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

Gets the current state of the navigation lock.

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.

Gets the current configuration of the navigation lock.

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

Returns the name of the active navigation tool.

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

Returns the default navigation tool

Gets the current camera vertical field of view.

Sets the current cameras vertical field of view.

Gets the current camera focal length.

Sets the current cameras focal length.

Hides all lines in the scene.

Hides all points in the scene.

Turns edge topology display on/off (where available)

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.

Modifies a click action configuration entry.

Fetch a click action configuration entry.

Modify the default click behaviour for the viewer.

Sets the Light Presets (Environments) for the Viewer.

Not applicable to 2D.

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 or unset a view navigation option to reverse the default direction for camera dolly (zoom) operations.

Sets the preference in the UI

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

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

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

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 visibility for a single layer, or for all layers.

Returns true if the layer is visible.

Returns true if any layer is hidden.

Returns true if all layers are hiden.

If enabled, set ground shadow color

Not applicable to 2D

If enabled, set ground shadow alpha

Not applicable to 2D

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

Not applicable to 2D

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

Not applicable to 2D

Returns a list of active cut planes

Not applicable to 2D

Apply a list of cut planes

Not applicable to 2D

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. Optional overlayRenderer can be supplied, in order to render an overlay on top of the renderer image.

Calculates the pixel position in client space coordinates of a point in world space.

See also [clientToWorld()]`Autodesk.Viewing.Viewer3D#clientToWorld </en/docs/viewer/v6/reference/Viewing/Viewer3D/#clientToWorld/>`_.

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()]`Autodesk.Viewing.Viewer3D#worldToClient </en/docs/viewer/v6/reference/Viewing/Viewer3D/#worldToClient/>`_.

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

Changes the 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

Changes the color of the selection for 2D drawings.

viewer.set2dSelectionColor(new THREE.Color(0xFF0000)); // red color

Interface method for UI workflows, returns a Promise that is meant to resolve with the instance of the toolbar. Headless Viewer will always return a rejected Promise.

Display ViewCube.

Display ViewCube UI, the buttons around it.

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

Sets the current UI theme of the viewer. Supported values are &quot;light-theme&quot; and &quot;dark-theme&quot;, which is the default.

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

Restore original colors for all themed shapes.

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

Make a previously hidden model visible again.

Disables roll-over highlighting.

disable the selection of a loaded model.

check if the mouse-over highlight is disabled or not

check if the mouse-over highlight is paused or not

check if the mouse-over highlight is active or not

check if the selection of the loaded model is disabled or not

Activates the extension based on the extensionID and mode given. By default it takes the first available mode in getmodes();

Dectivates the extension based on the extensionID specified.

Check if the extension is active or not by passing the extensionID.

Check if the extension is loaded or not by passing the extensionID.

Get a list of all the extensions that are currently loaded.

Get a list of all the modes that are available for the given extensionID.