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


##########
LineEntity
##########

.. js:class:: Selection.LineEntity

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Selection.LineEntity.getBestVertex`
   * :js:meth:`~Selection.LineEntity.getBounding`
   * :js:meth:`~Selection.LineEntity.getLineBits`
   * :js:meth:`~Selection.LineEntity.getLineId`
   * :js:meth:`~Selection.LineEntity.getPoints`
   * :js:meth:`~Selection.LineEntity.getPosition`
   * :js:meth:`~Selection.LineEntity.isCappingGeometry`
   * :js:meth:`~Selection.LineEntity.overlayIndex`
   * :js:meth:`~Selection.LineEntity.toJson`
   * :js:meth:`~static Selection.LineEntity.fromJson`
   
   




Methods
=======

.. js:method:: Selection.LineEntity.getBestVertex

   .. rst-class:: sig-pretty-signature
   
      | getBestVertex(): (*None* \| :js:class:`~Point3`\ )
   
   Returns the vertex of the line that is closest to the selection point.
   
   Clipped vertices are skipped. If the vertex is occluded, then ``null`` is returned.
   
   **Returns**\ : (*None* \| :js:class:`~Point3`\ )
   



.. js:method:: Selection.LineEntity.getBounding

   .. rst-class:: sig-pretty-signature
   
      | getBounding(): :js:class:`~Box`
   
   Gets the bounding box for the line entity
   
   **Returns**\ : :js:class:`~Box`
   
      Bounding box for the line entity
   
   



.. js:method:: Selection.LineEntity.getLineBits

   .. rst-class:: sig-pretty-signature
   
      | getLineBits(): *number*
   
   Gets the kine bits for the selection Point.
   
   **Returns**\ : *number*
   
      The bits set on the line/edge.
   
   



.. js:method:: Selection.LineEntity.getLineId

   .. rst-class:: sig-pretty-signature
   
      | getLineId(): *number*
   
   Gets the line identifier
   
   **Returns**\ : *number*
   
      the identifier of the line that was selected
   
   



.. js:method:: Selection.LineEntity.getPoints

   .. rst-class:: sig-pretty-signature
   
      | getPoints(): :js:class:`~Point3`\ []
   
   **Returns**\ : :js:class:`~Point3`\ []
   



.. js:method:: Selection.LineEntity.getPosition

   .. rst-class:: sig-pretty-signature
   
      | getPosition(): :js:class:`~Point3`
   
   Gets the closest point on the selected line
   
   **Returns**\ : :js:class:`~Point3`
   
      the closest point on the line
   
   



.. js:method:: Selection.LineEntity.isCappingGeometry

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



.. js:method:: Selection.LineEntity.overlayIndex

   .. rst-class:: sig-pretty-signature
   
      | overlayIndex(): *number*
   
   **Returns**\ : *number*
   
      The index of the overlay the entity belongs to.
   
   



.. js:method:: Selection.LineEntity.toJson

   .. rst-class:: sig-pretty-signature
   
      | toJson(): *object*
   
   Creates an object ready for JSON serialization.
   
   **Returns**\ : *object*
   
      The prepared object.
   
   



.. js:method:: static Selection.LineEntity.fromJson

   .. rst-class:: clio-flags
   
      :clio-static:`static`
   
   .. rst-class:: sig-pretty-signature
   
      | fromJson(**objData**\ : *any*\ ): :js:class:`LineEntity <Selection.LineEntity>`
   
   Creates a new [[LineEntity]] from an object given by [[toJson]].
   
   **Parameters**
   
      **objData**\ : *any*
   
         An object given by [[toJson]].
   
   
   
   **Returns**\ : :js:class:`LineEntity <Selection.LineEntity>`
   
      The prepared object.
   
   





