@equinor/videx-map
    Preparing search index...

    Class FieldModule

    Module for displaying fields.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    config dict fields highlighter labelManager pixiOverlay prevField root visibility fragmentShaderFill fragmentShaderOutline vertexShaderFill vertexShaderOutline

    Methods

    destroy drawPolygons getFieldStyle highlight onAdd onRemove projectPolygons resize set setVisibility toggle tryUnselect

    Constructors

    Properties

    config: Config = ...

    Settings for how to render fields.

    dict: TriangleDictionary<number> = ...
    fields: FieldMesh[] = []

    Collection of fields with meshes.

    highlighter: Hightlighter
    labelManager: LabelManager
    pixiOverlay: pixiOverlayBase

    Function for pixi overlay.

    prevField: number = -1

    Index of previously highlighted field

    root: Container

    Root container for layer.

    visibility: boolean = true

    True if layer is currently visible.

    fragmentShaderFill: string

    Fragment shader for the fill.

    fragmentShaderOutline: string

    Fragment shader for the outlines.

    vertexShaderFill: string

    Vertex shader for the fill.

    vertexShaderOutline: string

    Vertex shader for the outlines.

    Methods

    • Draw each polygon in a polygon collection.

      Parameters

      • meshData: MeshData
      • outlineData: MeshNormalData
      • fieldStyle: FieldStyle
      • zIndex: number

      Returns FieldMesh

    • Get the fill color of a field.

      Parameters

      • guid: number
      • hctype: string

      Returns FieldStyle

      Color used to fill

    • Parameters

      • lat: number
      • long: number

      Returns boolean

    • Project a collection of polygons.

      Parameters

      • points: [number, number][]

        Points within polygons

      Returns Vector2[]

      Projected polygons

    • Set visibility of the root PIXI container to a given value.

      Parameters

      • visible: boolean

        Should layer be visible?

      Returns boolean

      True if new visibility was set

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods