ExplodeManager

class Communicator.ExplodeManager(): This class provides an interface to the explode related features of the viewer. More information can be found here.

Methods

getActive()
getMagnitude()
setMagnitude()
start()
stop()

Methods

getActive

ExplodeManager.getActive()

Indicates whether there is a currently active explode operation.

Return type: boolean
Returns: boolean value indicating if there is an active explode operation.

getMagnitude

ExplodeManager.getMagnitude()

Gets the current explode magnitude. This will always return 0 when there is no active explode operation.

Return type: number
Returns: the current explode magnitude.

setMagnitude

ExplodeManager.setMagnitude(magnitude)

Sets the explosion magnitude if there is an active explosion operation. A value of 1.0 indicates that the distance between a part’s exploded center, and exploded center will be double.

Arguments

magnitude (number()) – the magnitude for the explosion.

Return type

Promise <void>

Returns

a promise that resolves when this operation is complete.

start

ExplodeManager.start([nodeIds[, explosionVector]])

Starts an explode operation. This will cancel any currently active explode operation.

Arguments

nodeIds ([NodeId]) – optional an array of NodeId for the parts that should be exploded. If this parameter is omitted or is an empty array, the entire model will be considered for explosion.
explosionVector (Point3()) – optional the vector to use for the center of the explosion.

Return type

Promise <void>

Returns

a promise that resolves when this operation is complete.

stop

ExplodeManager.stop()

Terminates any active explode operation.

Return type: DeprecatedPromise()
Returns: a promise that resolves when this operation is complete.