If not configured, the first shapediver instance of the configurator is used
Adds a camera or zoom command to the camera queue but does not trigger the update yet.
This function can be used to accumulate various camera commands before executing the camera update.
=> Use processCameraQueue for executing the accumulated camera commands.
Camera position or zoom target
Defines the type of camera queue entry (false: move camera, true: zoom camera)
Duration of the movement in milliseconds
If not configured, the first shapediver instance of the configurator is used
Adds a parameter to the update queue but does not trigger the update yet.
This function can be used to accumulate various parameter values before executing the parameter update.
=> Use processParamQueue for executing the accumulated parameter values.
If not configured, the first shapediver instance of the configurator is used
Function for receiving the API of a shapediver instance.
This function will first wait until the communication plugin of the corresponding shapediver instance is ready.
If not configured, the first shapediver instance of the configurator is used
Function for receiving the API of a shapediver control instance.
This function will not wait for any shapediver event, instead it will return undefined immediatly,
if there is no API available at this time.
If not configured, the first shapediver instance of the configurator is used
Function for receiving shapediver instance
If the parameter is used, the shapediver instance with the corresponding name will be fetched.
If parameter is not used, the first available shapediver instance of the configurator will be
returned.
Executes an asset update with all entries from the asset queue
If not configured, the first shapediver instance of the configurator is used
Execute a camera update with all entries from the camera queue
If not configured, the first shapediver instance of the configurator is used
Executes a parameter update with all entries from the parameter queue
If not configured, the first shapediver instance of the configurator is used
Removes assets from the scene.
Further information about the possible filter options can be found in
ShapeDiver docs.
If not configured, the first shapediver instance of the configurator is used
true: Assets will be removed after all other pending asset updates or asset remove requests
have been finished.
false: Assets will be removed in the next JS cycle, no matter if other asset updates
or asset remove requrests are currently pending.
Move the camera to a desired position
An object or JSON string including an "position" & "target" object.
See https://viewer.shapediver.com/v2/staging/doc/module-CameraApi-CameraApi.html#updateAsync
for further info.
Duration of the movement in milliseconds
If not configured, the first shapediver instance of the configurator is used
true: Execute camera movement after all previously added movement
commands have been finished.
false: Abort current and pending movement commands and move to the
desired position immediatly.
Set parameter value of the model.
Changes are not sent immediatly but forwarded to a designated queue instead (see description of queued parameter).
If not configured, the first shapediver instance of the configurator is used
true: Parameter will be applied after all currently pending parameter updates are finished.
In this case the current parameter update will not be aborted, which could otherwise
lead to missing or erronous parameter updates.
false: Parameter will be applied in the next JS cycle, no matter if other parameter updates
are currently pending.
Parameter updates which are triggered within the same JS cycle are accumulated and
applied in one update.\
Adds or updates assets to the 3d scene.
Further information about the desired asset structure can be found in
ShapeDiver docs.
If not configured, the first shapediver instance of the configurator is used
true: Assets will be updated after all currently pending asset updates are finished.
In this case the current asset update will not be aborted, which could otherwise
lead to missing or erronous asset updates.
false: Assest will be updated in the next JS cycle, no matter if other asset updates
are currently pending.
Asset updates which are triggered within the same JS cycle are accumulated and
applied in one update.
Function for adding and updating anchor assets with a customizable HTML string as content.
Adding, removing and updating the asset position is already handled within this function, whereas these tasks can be
exchanged or extended by the user to solve specific use cases.
See Release Notes for a detailed description of this functionality.
Configuration of assets which should be updated, see Cbn.CJS.HtmlAnchorAsset for detailed info
Optional name of the associated Shapediver control.
If not configured, the first shapediver instance of the configurator is used.
true: Assets will be updated after all currently pending asset updates are finished.
In this case the current asset update will not be aborted, which could otherwise
lead to missing or erronous asset updates.
false: Assets will be updated in the next JS cycle, no matter if other asset updates
are currently pending.
Asset updates which are triggered within the same JS cycle are accumulated and
applied in one update.
Function for waiting until the comm plugin of a shapediver instance is ready
If not configured, the first shapediver instance of the configurator is used
Function for waiting until the scene of a shapediver instance is visible
If not configured, the first shapediver instance of the configurator is used
Function for waiting until the model settings are registered.
At this point custom settings can be applied safely without getting overwritten by model settings.
If not configured, the first shapediver instance of the configurator is used
Zoom in on a certain part of the scene without modifying the camera direction
The zooming target, this can either be a certain scene path within the 3d model, a bounding box or the whole visible scene if the parameter is left empty
Duration of the movement in milliseconds
If not configured, the first shapediver instance of the configurator is used
true: execute camera movement after all previously added movement
commands have been finished
false: Abort current and pending movement commands and move to the
desired position immediatly
Generated using TypeDoc
Adds assets to the update queue but does not trigger the update yet.
This function can be used to accumulate various assets before executing the asset update.
=> Use processAssetQueue for executing the accululated asset updates.