Autodesk.Viewing.ToolController
new ToolController(viewerImpl,viewerApi,autocam,utilities,defaultHandler)
Core interface to add and remove canvas interactions to the viewer.
This class is created internally by the Viewer api and is available via the “toolController” property of the Viewer3D api object. Client implementations should not normally instantiate this class directly.
Parameters
| viewerImpl* Object | The viewer implementation object. |
| viewerApi* Object | The viewer api object. |
| autocam* Object | The Autocam interface object. |
| utilities* Object | The ViewingUtilities object. |
| defaultHandler* Object | The default event handling tool. |
Methods
activateTool(toolName)
Activates the tool registered under the given name. Activation implies pushing the tool on a stack of “active” tools, each of which (starting from the top of the stack) is given the opportunity to handle incoming events. Tools may “consume” events by returning true from their event handling methods, or they may allow events to be passed down to the next tool on the stack by returning false from the handling methods. Upon activation the tools “activate” method is called with the name under which it has been activated. Activation is not allowed while the controller is in a “locked” state (see the methods “setIsLocked” and “getIsLocked”). Tools must be registered prior to activation (see the methods “registerTool” and “deregisterTool”).
Parameters
| toolName* string | The name of the tool to be activated. |
Returns
| Type | Description |
|---|---|
| boolean | True if activation was successful. |
deactivateTool(toolName)
The first tool found on the active stack with the given name is removed and its “deactivate” method is called. Once deactivated the tool will no longer receive events via its handler methods. Deactivation is not allowed while the controller is in a “locked” state (see the methods “setIsLocked” and “getIsLocked”).
Parameters
| toolName* string | The name of the tool to be deactivated. |
Returns
| Type | Description |
|---|---|
| boolean | True if deactivation was successful. |
deregisterTool(tool)
This method deregisters an event handling tool with the controller afterwhich it will no longer be available for activation and deactivation. All names that the tool is registered under will be deregistered. If any tool is active at the time of deregistration will first be deactivated and it’s “deactivate” method will be called.
Parameters
| tool* object | The tool to be deregistered. |
getActiveTool()
This method returns the name of the topmost tool on the tool stack. If no tools are active the name of the default tool is returned (which is “default”).
Returns
| Type | Description |
|---|---|
| string | The tool name to look up. |
getActiveToolName()
This method returns the name of the topmost tool on the tool stack. If no tools are active the name of the default tool is returned (which is “default”).
Returns
| Type | Description |
|---|---|
| string | The tool name to look up. |
getDefaultTool()
Get the tool which handle events if no other active tool handles them.
Returns
| Type | Description |
|---|---|
| object | The tool to be registered as the default. |
getIsLocked()
Get the current state of the controller lock.
Returns
| Type | Description |
|---|---|
| boolean | The state of the lock. |
getTool(name)
This method returns the tool registered under the given name.
Parameters
| name* string | The tool name to look up. |
Returns
| Type | Description |
|---|---|
| object | The tool registered under the given name or undefined if not found. |
getToolNames()
Obtain a list of all the currently registered tool names.
Returns
| Type | Description |
|---|---|
| array | List of all registered tool names. |
registerTool(tool)
This method registers an event handling tool with the controller. This makes the tool available for activation and deactivation. Tools are registered under one or more names which must be provided via their “getNames” method. The tools “getNames” method must return an array of one or more names. Typically a tool will only have one name but if it wishes to operate in different modes it can use different names to activate the modes. Registered tools have the properties named “utilities” and “controller” added to them which refer to the ViewingUtilities object and this controller respectively. Tools may not use the name “default” which is reserved.
Parameters
| tool* object | The tool to be registered. |
setDefaultTool(tool)
Set the tool which will be requested to handle events if no other active tool handles them.
Parameters
| tool* object | The tool to be registered as the default. |
setIsLocked(state)
Set the controller into a locked or unlocked state. While locked, tool activation and deactivation is not allowed. Locking the controller is sometimes necessary to force an interaction to remain active until it is fully completed.
Parameters
| state* boolean | The state of the controller lock. |
Returns
| Type | Description |
|---|---|
| boolean | The previous state of the lock (this may be used to restore the lock to it’s previous state). |
setMouseWheelInputEnabled(isEnabled)
Whether mouse scroll wheel (and/or two-finger vertical swipe) will trigger a camera zoom operation.
Parameters
| isEnabled* boolean |
