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

.. role:: clio-static
   :class: clio-flag clio-flag-static


###################
WalkOperatorService
###################

.. js:class:: wvc.WalkOperatorService

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wvc.WalkOperatorService.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~wvc.WalkOperatorService.DefaultConfiguration`
   * :js:data:`~wvc.WalkOperatorService.serviceName`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wvc.WalkOperatorService.keyboardWalkOperator`
   * :js:func:`~wvc.WalkOperatorService.mouseWalkOperator`
   * :js:func:`~wvc.WalkOperatorService.walkModeOperator`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wvc.WalkOperatorService.getElevationSpeed`
   * :js:meth:`~wvc.WalkOperatorService.getFieldOfView`
   * :js:meth:`~wvc.WalkOperatorService.getMouseLookSpeed`
   * :js:meth:`~wvc.WalkOperatorService.getRotationSpeed`
   * :js:meth:`~wvc.WalkOperatorService.getWalkMode`
   * :js:meth:`~wvc.WalkOperatorService.getWalkSpeed`
   * :js:meth:`~wvc.WalkOperatorService.isCollisionDetectionEnabled`
   * :js:meth:`~wvc.WalkOperatorService.isMouseLookEnabled`
   * :js:meth:`~wvc.WalkOperatorService.reset`
   * :js:meth:`~wvc.WalkOperatorService.resetConfiguration`
   * :js:meth:`~wvc.WalkOperatorService.setCollisionDetectionEnabled`
   * :js:meth:`~wvc.WalkOperatorService.setElevationSpeed`
   * :js:meth:`~wvc.WalkOperatorService.setFieldOfView`
   * :js:meth:`~wvc.WalkOperatorService.setMouseLookEnabled`
   * :js:meth:`~wvc.WalkOperatorService.setMouseLookSpeed`
   * :js:meth:`~wvc.WalkOperatorService.setRotationSpeed`
   * :js:meth:`~wvc.WalkOperatorService.setWalkMode`
   * :js:meth:`~wvc.WalkOperatorService.setWalkSpeed`
   
   



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

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


.. js:method:: wvc.WalkOperatorService.constructor

      .. rst-class:: sig-pretty-signature
      
         | WalkOperatorService(**options**\ : { keyboardWalkOperator: *CameraKeyboardWalkOperator*\ , mouseWalkOperator: *CameraWalkOperator*\ , walkModeOperator: *CameraWalkModeOperator* }): :js:class:`WalkOperatorService <wvc.WalkOperatorService>`
      
      **Parameters**
      
      
         **options**\ : { keyboardWalkOperator: *CameraKeyboardWalkOperator*\ , mouseWalkOperator: *CameraWalkOperator*\ , walkModeOperator: *CameraWalkModeOperator* }
      
      
      **Returns**\ : :js:class:`WalkOperatorService <wvc.WalkOperatorService>`
      



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

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


.. js:data:: wvc.WalkOperatorService.DefaultConfiguration

      .. rst-class:: clio-flags
      
         :clio-static:`static`
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | DefaultConfiguration: { collisionDetectionEnabled: *boolean*\ , mouseLookEnabled: *boolean*\ , walkMode: (*"Mouse"* | *"Keyboard"*\ ) }
      



.. js:data:: wvc.WalkOperatorService.serviceName

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



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

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


.. js:method:: wvc.WalkOperatorService.keyboardWalkOperator

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



.. js:method:: wvc.WalkOperatorService.mouseWalkOperator

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



.. js:method:: wvc.WalkOperatorService.walkModeOperator

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



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

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


.. js:method:: wvc.WalkOperatorService.getElevationSpeed

      .. rst-class:: sig-pretty-signature
      
         | getElevationSpeed(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wvc.WalkOperatorService.getFieldOfView

      .. rst-class:: sig-pretty-signature
      
         | getFieldOfView(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wvc.WalkOperatorService.getMouseLookSpeed

      .. rst-class:: sig-pretty-signature
      
         | getMouseLookSpeed(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wvc.WalkOperatorService.getRotationSpeed

      .. rst-class:: sig-pretty-signature
      
         | getRotationSpeed(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wvc.WalkOperatorService.getWalkMode

      .. rst-class:: sig-pretty-signature
      
         | getWalkMode(): (*"Mouse"* | *"Keyboard"*\ )
      
      **Returns**\ : (*"Mouse"* \| *"Keyboard"*\ )
      



.. js:method:: wvc.WalkOperatorService.getWalkSpeed

      .. rst-class:: sig-pretty-signature
      
         | getWalkSpeed(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wvc.WalkOperatorService.isCollisionDetectionEnabled

      .. rst-class:: sig-pretty-signature
      
         | isCollisionDetectionEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.WalkOperatorService.isMouseLookEnabled

      .. rst-class:: sig-pretty-signature
      
         | isMouseLookEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.WalkOperatorService.reset

      .. rst-class:: sig-pretty-signature
      
         | reset(): *void*
      
      **Returns**\ : *void*
      



.. js:method:: wvc.WalkOperatorService.resetConfiguration

      .. rst-class:: sig-pretty-signature
      
         | resetConfiguration(**obj**\ : *object*\ ): *Promise*
      
      **Parameters**
      
      
         **obj**\ : *object*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.WalkOperatorService.setCollisionDetectionEnabled

      .. rst-class:: sig-pretty-signature
      
         | setCollisionDetectionEnabled(**enabled**\ : *boolean*\ ): *Promise*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.WalkOperatorService.setElevationSpeed

      .. rst-class:: sig-pretty-signature
      
         | setElevationSpeed(**value**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **value**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.WalkOperatorService.setFieldOfView

      .. rst-class:: sig-pretty-signature
      
         | setFieldOfView(**value**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **value**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.WalkOperatorService.setMouseLookEnabled

      .. rst-class:: sig-pretty-signature
      
         | setMouseLookEnabled(**enabled**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.WalkOperatorService.setMouseLookSpeed

      .. rst-class:: sig-pretty-signature
      
         | setMouseLookSpeed(**speed**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **speed**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.WalkOperatorService.setRotationSpeed

      .. rst-class:: sig-pretty-signature
      
         | setRotationSpeed(**value**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **value**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.WalkOperatorService.setWalkMode

      .. rst-class:: sig-pretty-signature
      
         | setWalkMode(**mode**\ : (*"Mouse"* | *"Keyboard"*\ )): *Promise*
      
      **Parameters**
      
      
         **mode**\ : (*"Mouse"* \| *"Keyboard"*\ )
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.WalkOperatorService.setWalkSpeed

      .. rst-class:: sig-pretty-signature
      
         | setWalkSpeed(**value**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **value**\ : *number*
      
      
      **Returns**\ : *void*
      




