# FaceEntity

class Selection.FaceEntity()

  Encapsulates a face selection.

Methods

- `getBounding()`

- `getCadFaceBits()`

- `getCadFaceIndex()`

- `getNormal()`

- `getPosition()`

- `isCappingGeometry()`

- `isProximityFace()`

- `overlayIndex()`

- `toJson()`

- `fromJson()`

## Methods

### getBounding

FaceEntity.getBounding()

  Gets the bounding box for the face entity

  Returns

    Bounding box for the face entity

  Return type

    Box

### getCadFaceBits

FaceEntity.getCadFaceBits()

  Gets the cad face bits for the selection Point.

  Returns

    The bits set on the cad face.

  Return type

    number

### getCadFaceIndex

FaceEntity.getCadFaceIndex()

  Gets the cad face index for the selection Point.

  Returns

    The index for the cad face.

  Return type

    number

### getNormal

FaceEntity.getNormal()

  Gets the face normal for the selection Point.

  Returns

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

  Return type

    Point3

### getPosition

FaceEntity.getPosition()

  Gets the world space position of the selection point.

  Returns

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

  Return type

    Point3

### isCappingGeometry

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.

  Return type

    boolean

### isProximityFace

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.

  Return type

    boolean

### overlayIndex

FaceEntity.overlayIndex()
  Returns

    The index of the overlay the entity belongs to.

  Return type

    number

### toJson

FaceEntity.toJson()

  Creates an object ready for JSON serialization.

  Returns

    The prepared object.

  Return type

    object

### static fromJson

FaceEntity.fromJson(objData)
  Arguments

    - objData (`any()`) – An object given by [[toJson]].

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

  Returns

    The prepared object.

  Return type

    FaceEntity