Class FieldModule

Module for displaying fields.

Hierarchy (view full)

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

constructor

Properties

config

config: Config = ...

Settings for how to render fields.

dict

dict: TriangleDictionary<number> = ...

fields

fields: FieldMesh[] = []

Collection of fields with meshes.

highlighter

highlighter: Hightlighter

labelManager

labelManager: LabelManager

pixiOverlay

pixiOverlay: pixiOverlayBase

Function for pixi overlay.

prevField

prevField: number = -1

Index of previously highlighted field

root

root: Container<DisplayObject>

Root container for layer.

visibility

visibility: boolean = true

True if layer is currently visible.

StaticfragmentShaderFill

fragmentShaderFill: string

Fragment shader for the fill.

StaticfragmentShaderOutline

fragmentShaderOutline: string

Fragment shader for the outlines.

StaticvertexShaderFill

vertexShaderFill: string

Vertex shader for the fill.

StaticvertexShaderOutline

vertexShaderOutline: string

Vertex shader for the outlines.

Methods

destroy

drawPolygons

  • drawPolygons(meshData, outlineData, fieldStyle, zIndex): FieldMesh

  • Draw each polygon in a polygon collection.

    Parameters

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

    Returns FieldMesh

getFieldStyle

  • getFieldStyle(guid, hctype): FieldStyle

  • Get the fill color of a field.

    Parameters

    • guid: number
    • hctype: string

    Returns FieldStyle

    Color used to fill

highlight

  • highlight(lat, long): boolean

  • Parameters

    • lat: number
    • long: number

    Returns boolean

onAdd

onRemove

projectPolygons

  • projectPolygons(points): Vector2[]

  • Project a collection of polygons.

    Parameters

    • points: [number, number][]

      Points within polygons

    Returns Vector2[]

    Projected polygons

resize

set

setVisibility

  • setVisibility(visible): boolean

  • 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

toggle

tryUnselect

Settings

Member Visibility

On This Page

Constructors
Properties
Methods