Class OutlineModule

Module for displaying outlines.

Hierarchy (view full)

Constructors

constructor

Properties

config outlineDict pixiOverlay root scaling spawned state visibility fragmentShader vertexShader

Methods

clear destroy onAdd onRemove resize set setVisibility setVisibleLayers toggle

Constructors

constructor

Properties

config

config: Config = ...

Default config.

outlineDict

outlineDict: {
    [key: string]: Uniforms;
} = {}

Mapping outline collection name with corresponding uniforms.

pixiOverlay

pixiOverlay: pixiOverlayBase

Function for pixi overlay.

root

root: Container<DisplayObject>

Root container for layer.

scaling

scaling: ((zoom: number) => number)

spawned

spawned: Mesh<MeshMaterial>[] = []

Graphic elements currently existing in world space.

state

state: State = ...

visibility

visibility: boolean = true

True if layer is currently visible.

StaticfragmentShader

fragmentShader: string

Fragment shader for the outlines.

StaticvertexShader

vertexShader: string

Vertex shader for the outlines.

Methods

clear

destroy

onAdd

onRemove

resize

set

  • set(data): void

  • Set collection of outlines to display. Clears previous content on execution.

    Parameters

    • data: OutlineData[]

      Outlines to draw

    Returns void

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

setVisibleLayers

  • setVisibleLayers(names): void

  • Set visibility for outline layers.

    Parameters

    • names: string[]

      Names of collections to modify

    Returns void

    Example

    setVisibleLayers(['OWC', 'GOC']);

toggle

Settings

Member Visibility

On This Page

Constructors
Properties
Methods