src/main/java/dev/isxander/yacl3/gui/controllers/cycling/ICyclingController.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

package dev.isxander.yacl3.gui.controllers.cycling;

import dev.isxander.yacl3.api.Controller;
import dev.isxander.yacl3.api.utils.Dimension;
import dev.isxander.yacl3.gui.AbstractWidget;
import dev.isxander.yacl3.gui.YACLScreen;

/**
 * This interface simply generifies setting and getting of
 * the pending value, using an ordinal so elements can cycle through
 * without knowing the content.
 */
public interface ICyclingController<T> extends Controller<T> {
    /**
     * Sets the pending value to whatever corresponds to the ordinal
     * @param ordinal index of element to set
     */
    void setPendingValue(int ordinal);

    /**
     * Gets the pending ordinal that corresponds to the actual value
     * @return ordinal
     */
    int getPendingValue();

    /**
     * Allows the element when it should wrap-around back to zeroth ordinal
     */
    int getCycleLength();

    /**
     * {@inheritDoc}
     */
    @Override
    default AbstractWidget provideWidget(YACLScreen screen, Dimension<Integer> widgetDimension) {
        return new CyclingControllerElement(this, screen, widgetDimension);
    }
}