.. role:: ts-api-decorator

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

.. js:module:: Selection
   :noindex:

.. container:: ts-api-section

   .. js:class:: FaceEntity

      Encapsulates a face selection.



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~Selection.FaceEntity.getBounding`
   * :js:meth:`~Selection.FaceEntity.getCadFaceBits`
   * :js:meth:`~Selection.FaceEntity.getCadFaceIndex`
   * :js:meth:`~Selection.FaceEntity.getNormal`
   * :js:meth:`~Selection.FaceEntity.getPosition`
   * :js:meth:`~Selection.FaceEntity.isCappingGeometry`
   * :js:meth:`~Selection.FaceEntity.isProximityFace`
   * :js:meth:`~Selection.FaceEntity.overlayIndex`
   * :js:meth:`~Selection.FaceEntity.toJson`
   * :js:meth:`~Selection.FaceEntity.fromJson`





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

Methods
=======

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

getBounding
-----------

.. js:method:: FaceEntity.getBounding()



   Gets the bounding box for the face entity

   :returns: Bounding box for the face entity


   :rtype: Box

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

getCadFaceBits
--------------

.. js:method:: FaceEntity.getCadFaceBits()



   Gets the cad face bits for the selection Point.

   :returns: The bits set on the cad face.


   :rtype: number

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

getCadFaceIndex
---------------

.. js:method:: FaceEntity.getCadFaceIndex()



   Gets the cad face index for the selection Point.

   :returns: The index for the cad face.


   :rtype: number

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

getNormal
---------

.. js:method:: FaceEntity.getNormal()



   Gets the face normal for the selection Point.

   :returns: Face normal for the selection position if it can be determined.


   :rtype: Point3

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

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

.. js:method:: FaceEntity.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

isCappingGeometry
-----------------

.. js:method:: FaceEntity.isCappingGeometry()



   Returns whether or not this face entity is capping geometry or not.

   :returns: True if this face entity is capping geometry and false otherwise.


   :rtype: boolean

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

isProximityFace
---------------

.. js:method:: FaceEntity.isProximityFace()



   Returns whether or not this face entity was selected by proximity or was instead selected dead-on.

   :returns: True if this face entity was selected by proximity and false otherwise.


   :rtype: boolean

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

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

.. js:method:: FaceEntity.overlayIndex()





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


   :rtype: number

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

toJson
------

.. js:method:: FaceEntity.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:: FaceEntity.fromJson( objData)

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


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

   :returns: The prepared object.


   :rtype: FaceEntity

