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


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

.. js:class:: wv.Selection.LineEntity

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



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

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


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

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



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

      .. rst-class:: sig-pretty-signature
      
         | getBestVertex(): (*None* | :js:class:`Point3 <wv.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 <wv.Point3>`\ )
      



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

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



.. js:method:: wv.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:: wv.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:: wv.Selection.LineEntity.getPoints

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



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

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



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

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



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

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



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

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




