LineEntity

class Selection.LineEntity()

Methods

getBestVertex

LineEntity.getBestVertex()

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.

Return type

null | Point3

getBounding

LineEntity.getBounding()

Gets the bounding box for the line entity

Returns

Bounding box for the line entity

Return type

Box

getLineBits

LineEntity.getLineBits()

Gets the kine bits for the selection Point.

Returns

The bits set on the line/edge.

Return type

number

getLineId

LineEntity.getLineId()

Gets the line identifier

Returns

the identifier of the line that was selected

Return type

number

getPoints

LineEntity.getPoints()
Return type

[Point3]

getPosition

LineEntity.getPosition()

Gets the closest point on the selected line

Returns

the closest point on the line

Return type

Point3

isCappingGeometry

LineEntity.isCappingGeometry()
Return type

boolean

overlayIndex

LineEntity.overlayIndex()
Returns

The index of the overlay the entity belongs to.

Return type

number

toJson

LineEntity.toJson()

Creates an object ready for JSON serialization.

Returns

The prepared object.

Return type

object

static fromJson

LineEntity.fromJson(objData)
Arguments
  • objData (any()) – An object given by [[toJson]].

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

Returns

The prepared object.

Return type

LineEntity