Class PolygonalSelection

constructor

• new PolygonalSelection(
      points: [number, number][],
      closed?: boolean,
  ): PolygonalSelection

  Parameters

  • points: [number, number][]
  • Optionalclosed: boolean

  Returns PolygonalSelection

closed

ReadonlydefaultClosedColour

ReadonlydefaultColour

ReadonlydefaultOpenColour

points

getPoint

• getPoint(i: number): null | Vector3

  Parameters

  • i: number

  Returns null | Vector3

getPoints

• getPoints(): Vector3[]

  retrieve points

  Returns Vector3[]

onHandleChange

• onHandleChange(
      i: number,
      pos: [undefined | number, undefined | number],
  ): PolygonalSelection

  callback for drag handle movements

  Parameters

  • i: number
  • pos: [undefined | number, undefined | number]

  Returns PolygonalSelection

Staticclicks

• clicks(): number[]

  Returns number[]

StaticcreateFromPoints

• createFromPoints(closed: boolean, points: Vector3[]): PolygonalSelection

  Parameters

  • closed: boolean
  • points: Vector3[]

  Returns PolygonalSelection

StaticcreateFromSelection

• createFromSelection(s: PolygonalSelection): PolygonalSelection

  Parameters

  • s: PolygonalSelection

  Returns PolygonalSelection

StaticisShape

• isShape(s: SelectionBase | PolygonalSelection): s is PolygonalSelection

  Parameters

  • s: SelectionBase | PolygonalSelection

  Returns s is PolygonalSelection