# LineEntity

class `Selection.``LineEntity`()

  ## Index

  Methods

  - `getBestVertex`
  - `getBounding`
  - `getLineBits`
  - `getLineId`
  - `getPoints`
  - `getPosition`
  - `isCappingGeometry`
  - `overlayIndex`
  - `toJson`
  - `fromJson`

## Methods

`Selection.LineEntity.``getBestVertex`()
  getBestVertex(): (None | `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 | `Point3`)

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

  Gets the bounding box for the line entity

  Returns: `Box`

  > Bounding box for the line entity

`Selection.LineEntity.``getLineBits`()
  getLineBits(): number

  Gets the kine bits for the selection Point.

  Returns: number

  > The bits set on the line/edge.

`Selection.LineEntity.``getLineId`()
  getLineId(): number

  Gets the line identifier

  Returns: number

  > the identifier of the line that was selected

`Selection.LineEntity.``getPoints`()
  getPoints(): `Point3`[]

  Returns: `Point3`[]

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

  Gets the closest point on the selected line

  Returns: `Point3`

  > the closest point on the line

`Selection.LineEntity.``isCappingGeometry`()
  isCappingGeometry(): boolean

  Returns: boolean

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

  Returns: number

  > The index of the overlay the entity belongs to.

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

  Creates an object ready for JSON serialization.

  Returns: object

  > The prepared object.

`static Selection.LineEntity.``fromJson`()

  static

  fromJson(objData: any): `LineEntity`

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

  Parameters

  > objData: any

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

  Returns: `LineEntity`

  > 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...