Class PerlinNoisePattern

id

• get id(): string

  Returns string

options

• get options(): TOptions

  Returns TOptions

isDirty

• get isDirty(): boolean

  Returns boolean

• set isDirty(value: boolean): void

  Parameters

  • value: boolean

  Returns void

constructor

• new PerlinNoisePattern(
      options?: Partial<PerlinNoisePatternOptions>,
  ): PerlinNoisePattern

  Parameters

  • options: Partial<PerlinNoisePatternOptions> = {}

  Returns PerlinNoisePattern

initialize

• initialize(_region: RenderRegion): void

  Called when the pattern is initialized or resized. Use this to set up any internal state or precompute values.

  Parameters

  • _region: RenderRegion

    the rendering region including visible area and padding.

  Returns void

destroy

• destroy(): void

  Called when the pattern is destroyed. Use this to clean up resources, cancel timers, etc.

  Returns void

onMouseInteraction

• onMouseInteraction(_x: number, _y: number, _clicked: boolean): void

  Handle mouse interactions with the pattern. Override to implement custom mouse effects.

  Parameters

  • _x: number

    mouse X position relative to canvas.
  • _y: number

    mouse Y position relative to canvas.
  • _clicked: boolean

    Whether mouse was clicked this frame.

  Returns void

setOptions

• setOptions(newOptions: Partial<PerlinNoisePatternOptions>): void

  Update options while preserving expensive permutation table when possible.

  Parameters

  • newOptions: Partial<PerlinNoisePatternOptions>

  Returns void

update

• update(_context: PatternContext): PerlinNoisePattern

  Update pattern state between frames. Called before generate() on each frame.

  Parameters

  • _context: PatternContext

    current rendering context.

  Returns PerlinNoisePattern

generate

• generate(context: PatternContext): CharacterData[]

  Generate characters for the current frame using Perlin noise.

  Parameters

  • context: PatternContext

    the current rendering context with time and region info

  Returns CharacterData[]

  Array of character data for rendering

_noise3D

• _noise3D(x: number, y: number, z: number): number

  Generate 3D Perlin noise at given coordinates.

  Parameters

  • x: number
  • y: number
  • z: number

  Returns number

_fractalNoise

• _fractalNoise(x: number, y: number, time?: number): number

  Generate fractal noise using multiple octaves. This creates more natural-looking, organic patterns.

  Parameters

  • x: number
  • y: number
  • time: number = 0

  Returns number

_animatedNoise

• _animatedNoise(x: number, y: number, time: number): number

  Generate animated noise that changes over time. This creates flowing, organic motion patterns.

  Parameters

  • x: number
  • y: number
  • time: number

  Returns number

_getNoiseFunction

• _getNoiseFunction(
      direction?: "left" | "right" | "up" | "down",
  ): (x: number, y: number, time: number) => number

  Generate a noise function suitable for ASCII pattern generation.

  Parameters

  • direction: "left" | "right" | "up" | "down" = 'down'

  Returns (x: number, y: number, time: number) => number

Static ReadonlyID