Class PolyLine<Point>

constructor

• new PolyLine<Point extends TrackCoordinate3D>(
      name: string,
      _api: BimCoreApi,
      options?: { maxPointCount?: number },
  ): PolyLine<Point>

  Polyline constructor.

  Type Parameters

  • Point extends TrackCoordinate3D

  Parameters

  • name: string

    Name of polyline
  • _api: BimCoreApi

    BimCoreApi instance
  • Optionaloptions: { maxPointCount?: number }

    Options for line creation

  Returns PolyLine<Point>

name

ReadonlyonPointTrackableScreen

points

color

• get color(): Color3

  Color of the line.

  Returns Color3

  The color
• set color(c: Color3): void

  Color of the line

  Parameters

  • c: Color3

    The color the line shall have.

  Returns void

apply

• apply(): void

  Apply changes made to the points array. This will mirror the changes in the visual representation of the polygon line. It will also trigger onPointTrackableScreen events.

  Returns void

clear

• clear(): void

  Sets point array to zero and disables visibility for the lines mesh. Also removes coordinate trackers for labels if present.

  Returns void

dispose

• dispose(): void

  Sets point array to zero and disables visibility for the lines mesh. Also removes coordinate trackers for labels if present. And disposes the linemesh.

  Returns void

distance

• distance(o?: { end: Point }): number

  Gets the distance of the polyline.

  Parameters

  • Optionalo: { end: Point }

    Optional. Specifies point where distance calculation should end. That is distance from first point up to this point.

  Returns number

  distance.

forEachLine

• forEachLine(predicate: (start: Point, end: Point) => boolean): void

  Makes it possible to iterate each line that points represents

  Parameters

  • predicate: (start: Point, end: Point) => boolean

    Called for each line with start and end vector. If predicate returns false then iteration is stopped.

  Returns void