Class Layer

Represents a layer of terrain with SVG elements.

Hierarchy (view full)

Structure
- Layer

Implements

ILayer

Index

Constructors

Properties

elements range tag x y

Methods

add addAtStart render

Constructors

constructor

new Layer(tag?, x?, y?): Layer
Initializes a new instance with specified coordinates and tag.
Parameters
- Optional tag: LayerType
  The tag for the layer.
- Optional x: number = 0
  The x-coordinate.
- Optional y: number = 0
  The y-coordinate.
Returns Layer
Overrides Structure.constructor
- Defined in src/classes/Layer.ts:17

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 Structure.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 Structure.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.
- Defined in src/classes/Layer.ts:32