# FaceEntity

class `Selection.``FaceEntity`()

  Encapsulates a face selection.

  ## Index

  Methods

  - `getBounding`
  - `getCadFaceBits`
  - `getCadFaceIndex`
  - `getNormal`
  - `getPosition`
  - `isCappingGeometry`
  - `isProximityFace`
  - `overlayIndex`
  - `toJson`
  - `fromJson`

## Methods

`Selection.FaceEntity.``getBounding`()
  getBounding(): `Box`

  Gets the bounding box for the face entity

  Returns: `Box`

  > Bounding box for the face entity

`Selection.FaceEntity.``getCadFaceBits`()
  getCadFaceBits(): number

  Gets the cad face bits for the selection Point.

  Returns: number

  > The bits set on the cad face.

`Selection.FaceEntity.``getCadFaceIndex`()
  getCadFaceIndex(): number

  Gets the cad face index for the selection Point.

  Returns: number

  > The index for the cad face.

`Selection.FaceEntity.``getNormal`()
  getNormal(): `Point3`

  Gets the face normal for the selection Point.

  Returns: `Point3`

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

`Selection.FaceEntity.``getPosition`()
  getPosition(): `Point3`

  Gets the world space position of the selection point.

  Returns: `Point3`

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

`Selection.FaceEntity.``isCappingGeometry`()
  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.

`Selection.FaceEntity.``isProximityFace`()
  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.

`Selection.FaceEntity.``overlayIndex`()
  overlayIndex(): number

  Returns: number

  > The index of the overlay the entity belongs to.

`Selection.FaceEntity.``toJson`()
  toJson(): object

  Creates an object ready for JSON serialization.

  Returns: object

  > The prepared object.

`static Selection.FaceEntity.``fromJson`()

  static

  fromJson(objData: any): `FaceEntity`

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

  Parameters

  > objData: any

  > > An object given by [[toJson]].

  Returns: `FaceEntity`

  > The prepared object.

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize Web or choose a sample question below to start a conversation:

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...