External module "utils/wellbores/highlight-helper"

Index

Functions

Functions

clearHighlight

clearHighlight(module: WellboreModule, onHighlightOff?: () => void): void

- Defined in utils/wellbores/highlight-helper.ts:78
Parameters
- module: WellboreModule
- Optional onHighlightOff: () => void
  - - (): void
    - Returns void
Returns void

testLabel

testLabel(pos: Vector2, roots: RootData[]): WellboreData[]

- Defined in utils/wellbores/highlight-helper.ts:13
Parameters
- pos: Vector2
- roots: RootData[]
Returns WellboreData[]

testRoot

testRoot(pos: Vector2, radius: number, pointDict: PointDictionary<RootData>): WellboreData[]

- Defined in utils/wellbores/highlight-helper.ts:7
Parameters
- pos: Vector2
- radius: number
- pointDict: PointDictionary<RootData>
Returns WellboreData[]

testWellborePath

testWellborePath(pos: Vector2, lineDict: LineDictionary<WellboreData>, distanceThreshold?: number): WellboreData[]

- Defined in utils/wellbores/highlight-helper.ts:31
Parameters
- pos: Vector2
- lineDict: LineDictionary<WellboreData>
- Default value distanceThreshold: number = 0.5
Returns WellboreData[]

updateHighlighted

updateHighlighted(pos: Vector2, module: WellboreModule, onHighlightOn?: (event: HighlightEvent) => void, onHighlightOff?: () => void, originalEvent?: any): void

- Defined in utils/wellbores/highlight-helper.ts:37
Parameters
- pos: Vector2
- module: WellboreModule
- Optional onHighlightOn: (event: HighlightEvent) => void
  - - (event: HighlightEvent): void
    - Parameters
      - event: HighlightEvent
      Returns void
- Optional onHighlightOff: () => void
  - - (): void
    - Returns void
- Optional originalEvent: any
Returns void

Generated using TypeDoc