Class FaultlineModule

Module for displaying faultlines.

Hierarchy (view full)

ModuleInterface
- FaultlineModule

Index

Constructors

Properties

config pixiOverlay pool root spawned visibility

Methods

clear destroy onAdd onRemove resize set setVisibility toggle

Constructors

constructor

new FaultlineModule(config?): FaultlineModule
Parameters
- Optionalconfig: InputConfig
Returns FaultlineModule
Overrides ModuleInterface.constructor
- Defined in src/FaultlineModule.ts:55

Properties

config

config: Config = ...

Default config.

pixiOverlay

pixiOverlay: pixiOverlayBase

Function for pixi overlay.

pool

pool: Graphics[] = []

Pool of initialized graphic elements.

root

root: Container<DisplayObject>

Root container for layer.

spawned

spawned: Graphics[] = []

Graphic elements currently existing in world space.

visibility

visibility: boolean = true

True if layer is currently visible.

Methods

clear

clear(): void
Clear all spawned graphic elements and return to pool.

Returns void
- Defined in src/FaultlineModule.ts:126

destroy

destroy(): void
Returns void
Overrides ModuleInterface.destroy
- Defined in src/FaultlineModule.ts:66

onAdd

onAdd(_map): void
Parameters
- _map: Map
Returns void
Inherited from ModuleInterface.onAdd
- Defined in src/ModuleInterface.ts:48

onRemove

onRemove(_map): void
Parameters
- _map: Map
Returns void
Inherited from ModuleInterface.onRemove
- Defined in src/ModuleInterface.ts:50

resize

resize(_zoom): void
Parameters
- _zoom: number
Returns void
Overrides ModuleInterface.resize
- Defined in src/FaultlineModule.ts:136

set

set(data): void
Set collection of faultlines to display. Clears previous content on execution.
Parameters
- data: FaultlineData[]
  Faultlines to draw
Returns void
- Defined in src/FaultlineModule.ts:77

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
Inherited from ModuleInterface.setVisibility
- Defined in src/ModuleInterface.ts:39

toggle

toggle(): void
Toggle the visibility of the root PIXI container.

Returns void
Inherited from ModuleInterface.toggle
- Defined in src/ModuleInterface.ts:29