.. role:: ts-api-decorator

###########
PointCursor
###########

.. js:module:: Operators.Measure
   :noindex:

.. container:: ts-api-section

   .. js:class:: PointCursor



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Operators.Measure.PointCursor.constructor`



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-class

   * :js:attr:`~Operators.Measure.PointCursor._cursorMarkup`
   * :js:attr:`~Operators.Measure.PointCursor.snappingConfig`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Operators.Measure.PointCursor.activateCursorSprite`
   * :js:meth:`~Operators.Measure.PointCursor.draw`
   * :js:meth:`~Operators.Measure.PointCursor.getSelectionCursorPoints`
   * :js:meth:`~Operators.Measure.PointCursor.onOperatorActivate`
   * :js:meth:`~Operators.Measure.PointCursor.onOperatorDeactivate`
   * :js:meth:`~Operators.Measure.PointCursor.updateCursorSprite`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: PointCursor.constructor( viewer, view)

      :param viewer: None
      :type viewer: WebViewer
      :param view: None
      :type view: View


      :rtype: PointCursor



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: PointCursor._cursorMarkup

      :type: null | CursorMarkup





.. container:: ts-api-section

   .. js:attribute:: PointCursor.snappingConfig

      :type: SnappingConfig





Methods
=======

.. rst-class:: ts-api-section

activateCursorSprite
--------------------

.. js:method:: PointCursor.activateCursorSprite( enable)

   :param enable: None
   :type enable: boolean


   :rtype: void

.. rst-class:: ts-api-section

draw
----

.. js:method:: PointCursor.draw()



   :rtype: void

.. rst-class:: ts-api-section

getSelectionCursorPoints
------------------------

.. js:method:: PointCursor.getSelectionCursorPoints( mousePosition, useSnapping, previousPickPoint)

   :param mousePosition: None
   :type mousePosition: Point2
   :param useSnapping: None
   :type useSnapping: boolean
   :param previousPickPoint: None
   :type previousPickPoint: null | Point3


   :rtype: Promise <null | SelectionPoints>

.. rst-class:: ts-api-section

onOperatorActivate
------------------

.. js:method:: PointCursor.onOperatorActivate()



   :rtype: void

.. rst-class:: ts-api-section

onOperatorDeactivate
--------------------

.. js:method:: PointCursor.onOperatorDeactivate()



   :rtype: void

.. rst-class:: ts-api-section

updateCursorSprite
------------------

.. js:method:: PointCursor.updateCursorSprite( mousePosition, useSnapping, firstSelectedPoint)

   :param mousePosition: None
   :type mousePosition: Point2
   :param useSnapping: None
   :type useSnapping: boolean
   :param firstSelectedPoint: None
   :type firstSelectedPoint: null | Point3


   :rtype: void

