CallbackMap

class Communicator.CallbackMap(): Object which maps callback names to functions. Used by WebViewer.setCallbacks

Properties

`XHRonerror`	Triggered during load progress of HTTP requests.
`XHRonloadend`	Triggered when an HTTP request completes.
`XHRonprogress`	Triggered during load progress of HTTP requests.
`addCuttingSection`	Triggered when a cutting section is added to the scene.
`assemblyTreeReady`	Triggered when methods on the Model class are allowed to…
`bcfLoaded`	Triggered after a BCF file has been loaded.
`bcfRemoved`	Triggered after a BCF file has been removed.
`beginInteraction`	Triggered on the start of a mouse drag from any of the…
`cadViewCreated`	Triggered when a CAD View is created.
`camera`	Triggered when the camera changes.
`cappingIdle`	Triggered when capping geometry generation becomes idle…
`configurationActivated`	Triggered when a Configuration is activated.
`contextMenu`	Triggered when Ui.Context.ContextMenu menu is shown or…
`cuttingPlaneDrag`	Triggered when a cutting plane is dragged.
`cuttingPlaneDragEnd`	Triggered when a cutting plane drag event stops.
`cuttingPlaneDragStart`	Triggered when a cutting plane drag event starts.
`cuttingSectionsLoaded`	Triggered after a batch update to cutting sections, such…
`deprecated`	Triggered when a function marked (@deprecated) is…
`endInteraction`	Triggered at the end of a mouse drag from any of the…
`explode`	Triggered when the expode magnitude of ExplodeManager…
`firstModelLoaded`	Triggered when the first model of a scene gets loaded.
`frameDrawn`	Triggered when a frame has been drawn.
`handleEvent`	Triggered when a geometry handle is moved.
`handleEventEnd`	Triggered when a geometry handle is no longer selected.
`handleEventStart`	Triggered when a geometry handle is selected.
`hwfParseComplete`	Triggered when HWF parsing becomes completed.
`incrementalSelectionBatchBegin`	Triggered before a batch of incrementally selected…
`incrementalSelectionBatchEnd`	Triggered after a batch of incrementally selected…
`incrementalSelectionEnd`	Triggered after all batches of incrementally selected…
`info`	Triggered when an info message is generated by the…
`lineCreated`	Triggered when a markup line is created.
`lineDeleted`	Triggered when a markup line is deleted.
`lineLoaded`	Triggered when a markup line is loaded.
`measurement`
`measurementBegin`	Triggered when a measurement operator has begun…
`measurementCreated`	Triggered when a measurement is fully created.
`measurementDeleted`	Triggered when a measurement is deleted by its…
`measurementHidden`	Triggered when a measurement is hidden by a call to its…
`measurementLoaded`	Triggered when a measurement loaded by its…
`measurementShown`	Triggered when a measurement is shown by a call to its…
`measurementValueSet`	Triggered when the measurement value is set but before it…
`missingModel`	Triggered when a missing model is discovered during a…
`modelLoadBegin`	Triggered immediately when Model.switchToModel is…
`modelLoadFailure`	Triggered when a model could not be loaded.
`modelLoaded`
`modelStructureHeaderParsed`	Triggered when a model header has been parsed.
`modelStructureLoadBegin`
`modelStructureLoadEnd`
`modelStructureParseBegin`
`modelStructureReady`	Triggered when the model structure has been loaded and is…
`modelSwitchStart`	Triggered when Model.switchToModel or Model.clear is…
`modelSwitched`	Triggered when Model.switchToModel or Model.clear is…
`noteTextCreated`	Triggered when note text is created, especially via the…
`noteTextHidden`	Triggered when note text is hidden, especially via the…
`noteTextShown`	Triggered when note text is shown, especially via the…
`overlayViewportSet`	Triggered when an overlay viewport is set.
`partsVisibilityHidden`	Triggered when parts are hidden.
`partsVisibilityShown`	Triggered when parts are shown.
`redlineCreated`	Triggered when a redline markup item is created.
`redlineDeleted`	Triggered when a redline markup item is deleted.
`redlineUpdated`	Triggered when a redline markup item is updated.
`removeCuttingSection`	Triggered when a cutting section is removed.
`sceneReady`	Triggered when the scene is ready to be interacted with.
`sceneRendered`
`selection`
`selectionArray`	Triggered when a selection event occurs.
`shatteredXmlStructureReady`
`sheetActivated`	Triggered when a drawing sheet has been activated.
`sheetDeactivated`	Triggered when drawing sheets have been deactivated.
`streamingActivated`	Triggered when the client begins streaming data from the…
`streamingDeactivated`	Triggered when streaming from the client has stopped.
`subtreeDeleted`	Triggered when a subtree has been deleted.
`subtreeLoaded`	Triggered when a subtree has been loaded. This includes…
`timeout`	Triggered when a timeout due to inactivity occurs.
`timeoutWarning`	Triggered when a timeout due to inactivity is about to…
`transitionBegin`	Triggered when a camera transition begins.
`transitionEnd`	Triggered when a camera transition ends.
`viewAxes`	Triggered after the view axes have been set.
`viewCreated`	Triggered when a view is created or by creating a redline…
`viewDeactivated`	Triggered when a view is deactivated.
`viewDeleted`	Triggered when a view is deleted.
`viewLoaded`	Triggered when a view is loaded from data.
`viewOrientation`	Triggered after the view orientation has changed.
`visibilityChanged`	Triggered when nodes are shown or hidden. If shownBodyIds…
`volumeSelectionBatchBegin`
`volumeSelectionBatchEnd`
`volumeSelectionEnd`
`walkOperatorActivated`	Triggered when the Operator.CameraWalkOperator becomes…
`walkOperatorDeactivated`	triggered when the Operator.CameraWalkOperator is…
`webGlContextLost`	Triggered when the browser causes the WebGL context to be…
`websocketConnectionClosed`	Triggered when the browser stream websocket connection is…

Properties

Communicator.CallbackMap.XHRonerror

Triggered during load progress of HTTP requests.

Happens when an error occurs during the loading of a model via an HTTP request. For some errors (e.g. 404) make sure to check the status of XHRonloadend instead.

Communicator.CallbackMap.XHRonloadend

Triggered when an HTTP request completes.

A completed HTTP request does not necessarily indicate success. Make sure to check the return status.

Communicator.CallbackMap.XHRonprogress

Triggered during load progress of HTTP requests.

Happens when loading a model via an HTTP request.

Communicator.CallbackMap.addCuttingSection: Triggered when a cutting section is added to the scene.

Communicator.CallbackMap.assemblyTreeReady: Triggered when methods on the Model class are allowed to be called.

Communicator.CallbackMap.bcfLoaded: Triggered after a BCF file has been loaded.

Communicator.CallbackMap.bcfRemoved: Triggered after a BCF file has been removed.

Communicator.CallbackMap.beginInteraction: Triggered on the start of a mouse drag from any of the built-in Communicator operators.

Communicator.CallbackMap.cadViewCreated: Triggered when a CAD View is created.

Communicator.CallbackMap.camera: Triggered when the camera changes.

Communicator.CallbackMap.cappingIdle: Triggered when capping geometry generation becomes idle or active.

Communicator.CallbackMap.configurationActivated: Triggered when a Configuration is activated.

Communicator.CallbackMap.contextMenu

Triggered when Ui.Context.ContextMenu menu is shown or hidden.

By default, this function is called on right mouse-click events.

Communicator.CallbackMap.cuttingPlaneDrag: Triggered when a cutting plane is dragged.

Communicator.CallbackMap.cuttingPlaneDragEnd: Triggered when a cutting plane drag event stops.

Communicator.CallbackMap.cuttingPlaneDragStart: Triggered when a cutting plane drag event starts.

Communicator.CallbackMap.cuttingSectionsLoaded

Triggered after a batch update to cutting sections, such as when deserializing from JSON data.

This event may be triggered manually after modifying cutting sections to cause the UI state to be updated.

Communicator.CallbackMap.deprecated: Triggered when a function marked (@deprecated) is called.

Communicator.CallbackMap.endInteraction: Triggered at the end of a mouse drag from any of the built-in Communicator operators or if Operator.stopInteraction gets called for a given operator.

Communicator.CallbackMap.explode: Triggered when the expode magnitude of ExplodeManager changes.

Communicator.CallbackMap.firstModelLoaded

Triggered when the first model of a scene gets loaded.

Clearing or switching models allows this to be triggered again.

Communicator.CallbackMap.frameDrawn: Triggered when a frame has been drawn.

Communicator.CallbackMap.handleEvent: Triggered when a geometry handle is moved.

Communicator.CallbackMap.handleEventEnd: Triggered when a geometry handle is no longer selected.

Communicator.CallbackMap.handleEventStart: Triggered when a geometry handle is selected.

Communicator.CallbackMap.hwfParseComplete: Triggered when HWF parsing becomes completed.

Communicator.CallbackMap.incrementalSelectionBatchBegin

Triggered before a batch of incrementally selected entities is put into the SelectionManager

See also: - SelectionManager.advanceIncrementalSelection

Communicator.CallbackMap.incrementalSelectionBatchEnd

Triggered after a batch of incrementally selected entities is put into the SelectionManager

See also: - SelectionManager.advanceIncrementalSelection

Communicator.CallbackMap.incrementalSelectionEnd

Triggered after all batches of incrementally selected entities have been put into the SelectionManager

See also: - SelectionManager.advanceIncrementalSelection

Communicator.CallbackMap.info: Triggered when an info message is generated by the viewer.

Communicator.CallbackMap.lineCreated: Triggered when a markup line is created.

Communicator.CallbackMap.lineDeleted: Triggered when a markup line is deleted.

Communicator.CallbackMap.lineLoaded: Triggered when a markup line is loaded.

Communicator.CallbackMap.measurement: Note

measurement is deprecated: Use any of the specific measurement callbacks instead: - measurementBegin - measurementCreated - measurementDeleted - measurementHidden - measurementLoaded - measurementShown - measurementValueSet

Communicator.CallbackMap.measurementBegin: Triggered when a measurement operator has begun measuring.

Communicator.CallbackMap.measurementCreated: Triggered when a measurement is fully created.

Communicator.CallbackMap.measurementDeleted: Triggered when a measurement is deleted by its MeasureManager

Communicator.CallbackMap.measurementHidden: Triggered when a measurement is hidden by a call to its setVisibility method.

Communicator.CallbackMap.measurementLoaded: Triggered when a measurement loaded by its MeasureManager

Communicator.CallbackMap.measurementShown: Triggered when a measurement is shown by a call to its setVisibility method.

Communicator.CallbackMap.measurementValueSet

Triggered when the measurement value is set but before it is displayed to the user.

This callback is useful for customizing the display of measurement text by using its getMeasurementValue and setMeasurementText methods.

Communicator.CallbackMap.missingModel: Triggered when a missing model is discovered during a load.

Communicator.CallbackMap.modelLoadBegin: Triggered immediately when Model.switchToModel is called.

Communicator.CallbackMap.modelLoadFailure: Triggered when a model could not be loaded.

Communicator.CallbackMap.modelLoaded: Note

modelLoaded is deprecated: Use subtreeLoaded instead.

Communicator.CallbackMap.modelStructureHeaderParsed: Triggered when a model header has been parsed.

Communicator.CallbackMap.modelStructureLoadBegin: Note

modelStructureLoadBegin is deprecated

Communicator.CallbackMap.modelStructureLoadEnd: Note

modelStructureLoadEnd is deprecated

Communicator.CallbackMap.modelStructureParseBegin: Note

modelStructureParseBegin is deprecated

Communicator.CallbackMap.modelStructureReady

Triggered when the model structure has been loaded and is ready to be queried.

This callback will only be called after the assemblyTreeReady callback gets triggered.

Communicator.CallbackMap.modelSwitchStart: Triggered when Model.switchToModel or Model.clear is called. This gets triggered after any of the above methods begin.

Communicator.CallbackMap.modelSwitched: Triggered when Model.switchToModel or Model.clear is called. This gets triggered after any of the above methods complete.

Communicator.CallbackMap.noteTextCreated: Triggered when note text is created, especially via the note operator.

Communicator.CallbackMap.noteTextHidden: Triggered when note text is hidden, especially via the note operator.

Communicator.CallbackMap.noteTextShown: Triggered when note text is shown, especially via the note operator.

Communicator.CallbackMap.overlayViewportSet: Triggered when an overlay viewport is set.

Communicator.CallbackMap.partsVisibilityHidden: Triggered when parts are hidden.

Note

partsVisibilityHidden is deprecated: Use visibilityChanged instead.

Communicator.CallbackMap.partsVisibilityShown: Triggered when parts are shown.

Note

partsVisibilityShown is deprecated: Use visibilityChanged instead.

Communicator.CallbackMap.redlineCreated: Triggered when a redline markup item is created.

Communicator.CallbackMap.redlineDeleted: Triggered when a redline markup item is deleted.

Communicator.CallbackMap.redlineUpdated

Triggered when a redline markup item is updated.

An update is triggered by changes in a redline markup item’s position, size, or text.

Communicator.CallbackMap.removeCuttingSection: Triggered when a cutting section is removed.

Communicator.CallbackMap.sceneReady

Triggered when the scene is ready to be interacted with.

View operations such as moving the camera may be invoked. However, operations requiring node IDs should not be called at this time.

Communicator.CallbackMap.sceneRendered: Note

sceneRendered is deprecated: Use frameDrawn instead.

Communicator.CallbackMap.selection: Note

selection is deprecated: Use selectionArray instead.

Communicator.CallbackMap.selectionArray: Triggered when a selection event occurs.

Communicator.CallbackMap.shatteredXmlStructureReady: Note

shatteredXmlStructureReady is deprecated: Triggered when the node structure parsed directly from the XML file of a shattered model is parsed.

Communicator.CallbackMap.sheetActivated: Triggered when a drawing sheet has been activated.

Communicator.CallbackMap.sheetDeactivated: Triggered when drawing sheets have been deactivated.

Communicator.CallbackMap.streamingActivated: Triggered when the client begins streaming data from the server.

Communicator.CallbackMap.streamingDeactivated: Triggered when streaming from the client has stopped.

Communicator.CallbackMap.subtreeDeleted: Triggered when a subtree has been deleted.

Communicator.CallbackMap.subtreeLoaded: Triggered when a subtree has been loaded. This includes loading a model as well as directly creating nodes.

Communicator.CallbackMap.timeout: Triggered when a timeout due to inactivity occurs.

Communicator.CallbackMap.timeoutWarning: Triggered when a timeout due to inactivity is about to occur.

Communicator.CallbackMap.transitionBegin: Triggered when a camera transition begins.

Communicator.CallbackMap.transitionEnd: Triggered when a camera transition ends.

Communicator.CallbackMap.viewAxes: Triggered after the view axes have been set.

Communicator.CallbackMap.viewCreated: Triggered when a view is created or by creating a redline item when no view is active.

Communicator.CallbackMap.viewDeactivated: Triggered when a view is deactivated.

Communicator.CallbackMap.viewDeleted: Triggered when a view is deleted.

Communicator.CallbackMap.viewLoaded: Triggered when a view is loaded from data.

Communicator.CallbackMap.viewOrientation: Triggered after the view orientation has changed.

Communicator.CallbackMap.visibilityChanged: Triggered when nodes are shown or hidden. If shownBodyIds and hiddenBodyIds are both empty, only the visibility of structural nodes (nodes that do not directly contain geometry) changed.

Communicator.CallbackMap.volumeSelectionBatchBegin: Note

volumeSelectionBatchBegin is deprecated: Use incrementalSelectionBatchBegin instead.

Communicator.CallbackMap.volumeSelectionBatchEnd: Note

volumeSelectionBatchEnd is deprecated: Use incrementalSelectionBatchEnd instead.

Communicator.CallbackMap.volumeSelectionEnd: Note

volumeSelectionEnd is deprecated: Use incrementalSelectionEnd instead.

Communicator.CallbackMap.walkOperatorActivated: Triggered when the Operator.CameraWalkOperator becomes active.

Communicator.CallbackMap.walkOperatorDeactivated: triggered when the Operator.CameraWalkOperator is deactivated.

Communicator.CallbackMap.webGlContextLost: Triggered when the browser causes the WebGL context to be lost and rendering cannot continue.

Communicator.CallbackMap.websocketConnectionClosed: Triggered when the browser stream websocket connection is closed.