Class WaterLayer

Class representing a water chunk with undulating waves.

Hierarchy (view full)

Layer
- WaterLayer

Index

Constructors

Properties

elements range tag x y

Methods

add addAtStart render

Constructors

constructor

new WaterLayer(xOffset, yOffset, width?, height?, waveClusters?): WaterLayer
Creates an instance of WaterChunk.
Parameters
- xOffset: number
  X-coordinate offset for the chunk.
- yOffset: number
  Y-coordinate offset for the chunk.
- Optional width: number
  Width of the waves.
- Optional height: number
  Height of the waves.
- Optional waveClusters: number = DEFAULT_WAVECLUSTERS
  Number of clusters of waves.
Returns WaterLayer
Overrides Layer.constructor
- Defined in src/classes/layers/WaterLayer.ts:26

Properties

elements

elements: Element[] = []

An array of Elements.

range

range: Range = ...

tag

The tag for the layer.

x

x: number = 0

The x-coordinate.

y

y: number = 0

The y-coordinate.

Methods

add

add(object): void
Adds an object to the elements array.
Parameters
- object: Element | Structure
  The object to be added to this.elements
Returns void
Inherited from Layer.add
- Defined in src/classes/Structure.ts:19

addAtStart

addAtStart(object): void
Adds an object at the beginning of elements array. This way object will be rendered first, thus being a background.
Parameters
- object: Element | Structure
  The object to be added to this.elements
Returns void
Inherited from Layer.addAtStart
- Defined in src/classes/Structure.ts:41

render

render(frameNum, layerNum): Promise<string>
Renders the layer asynchronously using a web worker.
Parameters
- frameNum: number
  The frame number.
- layerNum: number
  The layer number.
Returns Promise<string>
A promise that resolves to the rendered layer as an SVG string.
Inherited from Layer.render
- Defined in src/classes/Layer.ts:32