.. role:: clio-readonly
   :class: clio-flag clio-flag-readonly


##############
ExplodeService
##############

.. js:class:: wvc.ExplodeService

   IExplodeService
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wvc.ExplodeService.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~wvc.ExplodeService.serviceName`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wvc.ExplodeService.webViewer`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wvc.ExplodeService.getActive`
   * :js:meth:`~wvc.ExplodeService.getMagnitude`
   * :js:meth:`~wvc.ExplodeService.reset`
   * :js:meth:`~wvc.ExplodeService.setMagnitude`
   * :js:meth:`~wvc.ExplodeService.start`
   * :js:meth:`~wvc.ExplodeService.stop`
   
   



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: wvc.ExplodeService.constructor

      .. rst-class:: sig-pretty-signature
      
         | ExplodeService(): :js:class:`ExplodeService <wvc.ExplodeService>`
      
      **Returns**\ : :js:class:`ExplodeService <wvc.ExplodeService>`
      



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: wvc.ExplodeService.serviceName

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | serviceName: *"ExplodeService"*
      



.. rst-class:: kind-group kind-accessors

.. rubric:: Accessors
   :class: kind-group-title


.. js:method:: wvc.ExplodeService.webViewer

      .. rst-class:: sig-pretty-signature
      
         | *get* webViewer(): (*undefined* | *IWebViewer*\ )
      
      **Returns**\ : (*undefined* \| *IWebViewer*\ )
      
      .. rst-class:: sig-pretty-signature
      
         | *set* webViewer(**value**\ : (*undefined* | *IWebViewer*\ )): *void*
      
      **Parameters**
      
      
         **value**\ : (*undefined* \| *IWebViewer*\ )
      
      
      **Returns**\ : *void*
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: wvc.ExplodeService.getActive

      .. rst-class:: sig-pretty-signature
      
         | getActive(): *boolean*
      
      Indicates whether there is a currently active explode operation.
      
      **Returns**\ : *boolean*
      
      
         boolean value indicating if there is an active explode operation.
      
      



.. js:method:: wvc.ExplodeService.getMagnitude

      .. rst-class:: sig-pretty-signature
      
         | getMagnitude(): *number*
      
      Gets the current explode magnitude. This will always return 0 when there is no active explode operation.
      
      **Returns**\ : *number*
      
      
         the current explode magnitude.
      
      



.. js:method:: wvc.ExplodeService.reset

      .. rst-class:: sig-pretty-signature
      
         | reset(): *void*
      
      Resets the explode service, clearing any active operations.
      
      **Returns**\ : *void*
      



.. js:method:: wvc.ExplodeService.setMagnitude

      .. rst-class:: sig-pretty-signature
      
         | setMagnitude(**magnitude**\ : *number*\ ): *Promise*
      
      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.
      
      **Parameters**
      
      
         **magnitude**\ : *number*
      
      
            the magnitude for the explosion.
      
      
      
      **Returns**\ : *Promise*
      
      
         a promise that resolves when this operation is complete.
      
      



.. js:method:: wvc.ExplodeService.start

      .. rst-class:: sig-pretty-signature
      
         | start(**nodeIds**\ : *number*\ [], **explosionVector**\ : *IPoint3*\ ): *Promise*
      
      Starts an explode operation. This will cancel any currently active explode operation.
      
      **Parameters**
      
      
         **nodeIds**\ : *number*\ []
      
      
            an array of node Ids 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**\ : *IPoint3*
      
      
            the vector to use for the center of the explosion.
      
      
      
      **Returns**\ : *Promise*
      
      
         a promise that resolves when this operation is complete.
      
      



.. js:method:: wvc.ExplodeService.stop

      .. rst-class:: sig-pretty-signature
      
         | stop(): *Promise*
      
      Terminates any active explode operation.
      
      **Returns**\ : *Promise*
      
      
         a promise that resolves when this operation is complete.
      
      




