Struct Section::Scroll

Nested Relationships

This struct is a nested type of Class Section.

Struct Documentation

struct Scroll

Sets the Section’s scrolling behavior.

Public Functions

void remove_timer_x()

Removes the x axis timer.

void remove_timer_y()

Removes the y axis timer.

void set(uint16_t refresh_interval, Point *dimensions, uint16_t interval_x, uint16_t interval_y, bool reverse_x = false, bool reverse_y = false)

Sets the scrolling behavior. The step count is calculated by factoring in the Pixel grid size and Maestro refresh rate.

Parameters

  • refresh_interval: Amount of time between Maestro refreshes.

  • dimensions: The dimensions of the parent Section.

  • interval_x: The amount of time to complete a scroll along the x axis.

  • interval_y: The amount of time to complete a scroll along the y axis.

  • reverse_x: If true, reverses the scrolling direction along the x axis.

  • reverse_y: If true, reverses the scrolling direction along the y axis.

~Scroll()

Public Members

uint16_t interval_x = 0

The original x interval. This is really just storage for use in Cues.

uint16_t interval_y = 0

The original y interval.

bool reverse_x = false

If true, reverses the scrolling direction along the x axis.

bool reverse_y = false

If true, reverses the scrolling direction along the y axis.

Timer *timer_x = nullptr

Sets the amount of time between a single x-axis step. Overrides step_x when step_x is less than 1.

Timer *timer_y = nullptr

Sets the amount of time between a single y-axis step. Overrides step_y when step_y is less than 1.

uint16_t step_x = 0

Sets the number of y-axis steps to take with each update. Overridden by timer_x when this is calculated to be less than 1.

uint16_t step_y = 0

Sets the number of y-axis steps to take with each update. Overridden by timer_y when this is calculated to be less than 1.