JSDoc: Namespace: Client

Methods

(static) attachNodeSelectionChanged(callback, listener) → {sap.ve.dvl~Client}

Attach the Node Selection Changed event listener.

Parameters:

Name	Type	Description
`callback`	sap.ve.dvl~Client~nodeSelectionChangedCallback	The function to be called when the event occurs.
`listener`	Object	The context object to call the event handler with.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

(static) attachNodeVisibilityChanged(callback, listener) → {sap.ve.dvl~Client}

Attach the Node Visibility Changed event listener.

Parameters:

Name	Type	Description
`callback`	sap.ve.dvl~Client~nodeVisibilityChangedCallback	The function to be called when the event occurs.
`listener`	Object	The context object to call the event handler with.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

(static) attachStepEvent(callback, listener) → {sap.ve.dvl~Client}

Attach the Step Event listener.

Parameters:

Name	Type	Description
`callback`	sap.ve.dvl~Client~stepEventCallback	The function to be called when the event occurs.
`listener`	Object	The context object to call the event handler with.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

(static) attachUrlClicked(callback, listener) → {sap.ve.dvl~Client}

Attach the URL Clicked event listener.

Parameters:

Name	Type	Description
`callback`	sap.ve.dvl~Client~urlClickedCallback	The function to be called when the event occurs.
`listener`	Object	The context object to call the event handler with.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

(static) detachNodeSelectionChanged(callback, listener) → {sap.ve.dvl~Client}

Detach the Node Selection Changed event listener.

Parameters:

Name	Type	Description
`callback`	sap.ve.dvl~Client~nodeSelectionChangedCallback	The function to be called when the event occurs.
`listener`	Object	The context object to call the event handler with.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

(static) detachNodeVisibilityChanged(callback, listener) → {sap.ve.dvl~Client}

Detach the Node Visibility Changed event listener.

Parameters:

Name	Type	Description
`callback`	sap.ve.dvl~Client~nodeVisibilityChangedCallback	The function to be called when the event occurs.
`listener`	Object	The context object to call the event handler with.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

(static) detachStepEvent(callback, listener) → {sap.ve.dvl~Client}

Detach the Step Event listener.

Parameters:

Name	Type	Description
`callback`	sap.ve.dvl~Client~stepEventCallback	The function to be called when the event occurs.
`listener`	Object	The context object to call the event handler with.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

(static) detachUrlClicked(callback, listener) → {sap.ve.dvl~Client}

Detach the URL Clicked event listener. The passed function and listener object must match the ones used for event registration.

Parameters:

Name	Type	Description
`callback`	sap.ve.dvl~Client~urlClickedCallback	The function to be called when the event occurs.
`listener`	Object	The context object to call the event handler with.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

(static) GetDebugInfoString(clientId) → {string}

Displays custom information on top of rendered image together with debug information from the renderer. Only displays the information if DVLRENDEROPTION.DVLRENDEROPTION_SHOWDEBUG_INFO is ON.

Parameters:

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.

Returns:

Return null if you don't need to display any custom text, otherwise return a string with custom text if you need to display something.

Type: string

(static) getDecryptionHandler() → {sap.ve.dvl.DecryptionHandler}

Gets an object that decrypts content of encrypted models.

Returns:

An object that decrypts content of encrypted models.

Type: sap.ve.dvl.DecryptionHandler

(static) LogMessage(clientId, type, source, text)

Reports a warning, error, etc.

Parameters:

Name Type Description

clientId string Token representing the target client instance. This is usually the canvas ID.

type number DVLCLIENTLOGTYPE enum. The type of message to report (DEBUG, INFO, WARNING, ERROR).

source

string

Text representation of the message source. Can be null.

Source	Description
OpenGL	OpenGL rendering layer.
Memory	Memory management routines.
LocalFileSystem	Emscripten virtual local file system manager.
VDS	VDS file reading routines.
Scene	Scene manipulation routines.

text string The text message to display. Can be null.

(static) NotifyFileLoadProgress(clientId, progress) → {boolean}

Notifies about the file loading progress (which may be quite time consuming), and to check if the user wants to abort file loading.

Parameters:

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.
`progress`	number	A value from `0.0` to `1.0` indicating the file loading progress (where `1.0` means loading is complete).

Returns:

Return true to proceed with file loading, return false if the loading needs to be canceled.

Type: boolean

(static) NotifyFrameFinished(clientId)

Notifies when frame rendering has finished.

Parameters:

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.

(static) NotifyFrameStarted(clientId)

Notifies when frame rendering has started.

Parameters:

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.

(static) OnNodeSelectionChanged(clientId, sceneId, numberOfSelectedNodes, idFirstSelectedNode)

Indicates that the selection list has changed.

Parameters:

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.
`sceneId`	string	Scene token.
`numberOfSelectedNodes`	number	The number of nodes selected in the list.
`idFirstSelectedNode`	string	DVLID of the first selected node, or `DVLID_INVALID` if none selected.

Deprecated:

since version 6.2.0. Use attachNodeSelectionChanged.

(static) OnStepEvent(clientId, type, stepId)

Notifies about the step phase that's just been completed.

Parameters:

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.
`type`	number	The DVLSTEPEVENT type of the event that happened to the step.
`stepId`	string	The identifier of the step.

Deprecated:

since version 6.2.0. Use attachStepEvent.

(static) OnUrlClick(clientId, url, nodeId)

Called when URL link is clicked.

Parameters:

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.
`url`	string	URL link which is clicked.
`nodeId`	string	The identifier of the node.

Deprecated:

since version 6.2.0. Use attachUrlClicked.

(static) setDecryptionHandler(handler) → {sap.ve.dvl~Client}

Sets an object that decrypts content of encrypted models.

Parameters:

Name	Type	Description
`handler`	sap.ve.dvl.DecryptionHandler	An object that decrypts content of encrypted models.

Returns:

this to allow method chaining.

Type: sap.ve.dvl~Client

Type Definitions

nodeSelectionChangedCallback(parameters)

This callback is called when the Node Selection Changed event is fired.

Parameters:

Name Type Description

parameters

object

A map of parameters. See below.

Properties

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.
`sceneId`	string	Scene token.
`numberOfSelectedNodes`	number	The number of selected nodes.
`idFirstSelectedNode`	string	DVLID of the first selected node, or `DVLID_INVALID` if none selected.

nodeVisibilityChangedCallback(parameters)

This callback is called when the Node Visibility Changed event is fired.

Parameters:

Name Type Description

parameters

object

A map of parameters. See below.

Properties

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.
`sceneId`	string	Scene token.
`nodeId`	string	The ID of the node.
`visible`	boolean	The new visibility state of the node.

stepEventCallback(parameters)

This callback is called when the Step Event is fired.

Parameters:

Name Type Description

parameters

object

A map of parameters. See below.

Properties

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.
`type`	number	The DVLSTEPEVENT type of the event that happened to the step.
`stepId`	string	The identifier of the step.

urlClickedCallback(parameters)

This callback is called when the URL Clicked event is fired.

Parameters:

Name Type Description

parameters

object

A map of parameters. See below.

Properties

Name	Type	Description
`clientId`	string	Token representing the target client instance. This is usually the canvas ID.
`url`	string	A URL that was clicked on.
`nodeId`	string	A node ID that was clicked on.