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


#################
SpaceMouseService
#################

.. js:class:: wvc.SpaceMouseService

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wvc.SpaceMouseService.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~wvc.SpaceMouseService.serviceName`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wvc.SpaceMouseService.spaceMouseOperator`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wvc.SpaceMouseService.connect`
   
   



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

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


.. js:method:: wvc.SpaceMouseService.constructor

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



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

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


.. js:data:: wvc.SpaceMouseService.serviceName

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



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

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


.. js:method:: wvc.SpaceMouseService.spaceMouseOperator

      .. rst-class:: sig-pretty-signature
      
         | *get* spaceMouseOperator(): (*undefined* | *SpaceMouseOperator*\ )
      
      **Returns**\ : (*undefined* \| *SpaceMouseOperator*\ )
      
      .. rst-class:: sig-pretty-signature
      
         | *set* spaceMouseOperator(**spaceMouseOperator**\ : (*undefined* | *SpaceMouseOperator*\ )): *void*
      
      **Parameters**
      
      
         **spaceMouseOperator**\ : (*undefined* \| *SpaceMouseOperator*\ )
      
      
      **Returns**\ : *void*
      



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

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


.. js:method:: wvc.SpaceMouseService.connect

      .. rst-class:: sig-pretty-signature
      
         | connect(): *void*
      
      Connect to the space mouse. To be successful, the canvas where the mouse is to be used must have focus.
      
      Note: If this is called but the 3d connexion software is not running, a connection error will be shown in the console.
      
      **Returns**\ : *void*
      




