.. role:: ts-api-decorator

###########
PointEntity
###########

.. js:module:: Selection
   :noindex:

.. container:: ts-api-section

   .. js:class:: PointEntity



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~Selection.PointEntity.getPointBits`
   * :js:meth:`~Selection.PointEntity.getPointId`
   * :js:meth:`~Selection.PointEntity.getPosition`
   * :js:meth:`~Selection.PointEntity.overlayIndex`
   * :js:meth:`~Selection.PointEntity.toJson`
   * :js:meth:`~Selection.PointEntity.fromJson`





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

Methods
=======

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

getPointBits
------------

.. js:method:: PointEntity.getPointBits()



   Gets the cad bits for the selection Point.

   :returns: The bits set on the point.


   :rtype: number

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

getPointId
----------

.. js:method:: PointEntity.getPointId()



   Gets the point identifier

   :returns: the identifier of the point that was selected


   :rtype: number

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

getPosition
-----------

.. js:method:: PointEntity.getPosition()



   Gets the world space position of the selection point.

   :returns: World space position of the selection point if it can be determined.


   :rtype: Point3

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

overlayIndex
------------

.. js:method:: PointEntity.overlayIndex()





   :returns: The index of the overlay the entity belongs to.


   :rtype: number

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

toJson
------

.. js:method:: PointEntity.toJson()



   Creates an object ready for JSON serialization.

   :returns: The prepared object.


   :rtype: object

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

:ts-api-decorator:`static` fromJson
-----------------------------------

.. js:method:: PointEntity.fromJson( objData)

   :param objData: An object given by [[toJson]].
   :type objData: any


   Creates a new [[PointEntity]] from an object given by [[toJson]].

   :returns: The prepared object.


   :rtype: PointEntity

