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


##########
FaceEntity
##########

.. js:class:: wv.Selection.FaceEntity

   Encapsulates a face selection.
   
   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~static wv.Selection.FaceEntity.fromJson`
   * :js:meth:`~wv.Selection.FaceEntity.getBounding`
   * :js:meth:`~wv.Selection.FaceEntity.getCadFaceBits`
   * :js:meth:`~wv.Selection.FaceEntity.getCadFaceIndex`
   * :js:meth:`~wv.Selection.FaceEntity.getNormal`
   * :js:meth:`~wv.Selection.FaceEntity.getPosition`
   * :js:meth:`~wv.Selection.FaceEntity.isCappingGeometry`
   * :js:meth:`~wv.Selection.FaceEntity.isProximityFace`
   * :js:meth:`~wv.Selection.FaceEntity.overlayIndex`
   * :js:meth:`~wv.Selection.FaceEntity.toJson`
   
   



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

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


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

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



.. js:method:: wv.Selection.FaceEntity.getBounding

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



.. js:method:: wv.Selection.FaceEntity.getCadFaceBits

      .. rst-class:: sig-pretty-signature
      
         | getCadFaceBits(): *number*
      
      Gets the cad face bits for the selection Point.
      
      **Returns**\ : *number*
      
      
         The bits set on the cad face.
      
      



.. js:method:: wv.Selection.FaceEntity.getCadFaceIndex

      .. rst-class:: sig-pretty-signature
      
         | getCadFaceIndex(): *number*
      
      Gets the cad face index for the selection Point.
      
      **Returns**\ : *number*
      
      
         The index for the cad face.
      
      



.. js:method:: wv.Selection.FaceEntity.getNormal

      .. rst-class:: sig-pretty-signature
      
         | getNormal(): :js:class:`Point3 <wv.Point3>`
      
      Gets the face normal for the selection Point.
      
      **Returns**\ : :js:class:`Point3 <wv.Point3>`
      
      
         Face normal for the selection position if it can be determined.
      
      



.. js:method:: wv.Selection.FaceEntity.getPosition

      .. rst-class:: sig-pretty-signature
      
         | getPosition(): :js:class:`Point3 <wv.Point3>`
      
      Gets the world space position of the selection point.
      
      **Returns**\ : :js:class:`Point3 <wv.Point3>`
      
      
         World space position of the selection point if it can be determined.
      
      



.. js:method:: wv.Selection.FaceEntity.isCappingGeometry

      .. rst-class:: sig-pretty-signature
      
         | isCappingGeometry(): *boolean*
      
      Returns whether or not this face entity is capping geometry or not.
      
      **Returns**\ : *boolean*
      
      
         True if this face entity is capping geometry and false otherwise.
      
      



.. js:method:: wv.Selection.FaceEntity.isProximityFace

      .. rst-class:: sig-pretty-signature
      
         | isProximityFace(): *boolean*
      
      Returns whether or not this face entity was selected by proximity or was instead selected dead-on.
      
      **Returns**\ : *boolean*
      
      
         True if this face entity was selected by proximity and false otherwise.
      
      



.. js:method:: wv.Selection.FaceEntity.overlayIndex

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



.. js:method:: wv.Selection.FaceEntity.toJson

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




