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

Communicator.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

Communicator.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

Communicator.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

Communicator.ExplodeManager.start(nodeIds, explosionVector)

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

Arguments
  • nodeIds ([Communicator.NodeId]()) – 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 (Communicator.Point3()) – 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

Communicator.ExplodeManager.stop()

Terminates any active explode operation.

Return type

Communicator.DeprecatedPromise

Returns

a promise that resolves when this operation is complete.