Class Oscillogram

Tables

oscillogram.instance

Metamethods

oscillogram:__index (index) It is used for iterating over plot points in Lua 5.3+.
oscillogram:__ipairs () It is used for iterating over plot points in Lua 5.2.

Methods

oscillogram:new (kind, length[, default=minimum[, minimum=0[, maximum=1]]])
oscillogram:push (point)
oscillogram:push_with_factor (factor)
oscillogram:push_with_random_factor (factor_limit)
oscillogram:shift ()
oscillogram:update (value)


Tables

oscillogram.instance

Fields:

  • _kind "custom", "linear" or "random"
  • _points {number,...}
  • _default number
  • _minimum number
  • _maximum number

Metamethods

oscillogram:__index (index)
It is used for iterating over plot points in Lua 5.3+.

Parameters:

  • index number [1, ∞)

Returns:

    number
oscillogram:__ipairs ()
It is used for iterating over plot points in Lua 5.2.

Returns:

  1. iterators.inext iterator function
  2. Oscillogram self
  3. number always zero

Methods

oscillogram:new (kind, length[, default=minimum[, minimum=0[, maximum=1]]])

Parameters:

  • kind "custom", "linear" or "random"
  • length number [0, ∞)
  • default number (default minimum)
  • minimum number (default 0)
  • maximum number [minimum, ∞) (default 1)

Returns:

    Oscillogram
oscillogram:push (point)

Parameters:

  • point number
oscillogram:push_with_factor (factor)

Parameters:

  • factor number
oscillogram:push_with_random_factor (factor_limit)

Parameters:

  • factor_limit number
oscillogram:shift ()

Returns:

    number
oscillogram:update (value)

Parameters:

  • value number

Returns:

    number
generated by LDoc 1.5.0 Last updated 2025-01-10 15:12:53