diff options
Diffstat (limited to 'src/main/java/dev/isxander/yacl/gui/controllers/slider')
9 files changed, 388 insertions, 125 deletions
diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderControl.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderController.java index 5aaa6c4..8d74ceb 100644 --- a/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderControl.java +++ b/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderController.java @@ -6,7 +6,13 @@ import org.apache.commons.lang3.Validate; import java.util.function.Function; -public class DoubleSliderControl implements ISliderControl<Double> { +/** + * {@link ISliderController} for doubles. + */ +public class DoubleSliderController implements ISliderController<Double> { + /** + * Formats doubles to two decimal places + */ public static final Function<Double, Text> DEFAULT_FORMATTER = value -> Text.of(String.format("%.2f", value)); private final Option<Double> option; @@ -15,11 +21,29 @@ public class DoubleSliderControl implements ISliderControl<Double> { private final Function<Double, Text> valueFormatter; - public DoubleSliderControl(Option<Double> option, double min, double max, double interval) { + /** + * Constructs a {@link ISliderController} for doubles + * using the default value formatter {@link DoubleSliderController#DEFAULT_FORMATTER}. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + */ + public DoubleSliderController(Option<Double> option, double min, double max, double interval) { this(option, min, max, interval, DEFAULT_FORMATTER); } - public DoubleSliderControl(Option<Double> option, double min, double max, double interval, Function<Double, Text> valueFormatter) { + /** + * Constructs a {@link ISliderController} for doubles. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + * @param valueFormatter format the value into any {@link Text} + */ + public DoubleSliderController(Option<Double> option, double min, double max, double interval, Function<Double, Text> valueFormatter) { Validate.isTrue(max > min, "`max` cannot be smaller than `min`"); Validate.isTrue(interval > 0, "`interval` must be more than 0"); @@ -30,43 +54,60 @@ public class DoubleSliderControl implements ISliderControl<Double> { this.valueFormatter = valueFormatter; } + /** + * {@inheritDoc} + */ @Override public Option<Double> option() { return option; } + /** + * {@inheritDoc} + */ @Override public Text formatValue() { return valueFormatter.apply(option().pendingValue()); } + /** + * {@inheritDoc} + */ @Override public double min() { return min; } + /** + * {@inheritDoc} + */ @Override public double max() { return max; } + /** + * {@inheritDoc} + */ @Override public double interval() { return interval; } + /** + * {@inheritDoc} + */ @Override public void setPendingValue(double value) { option().requestSet(value); } + /** + * {@inheritDoc} + */ @Override public double pendingValue() { return option().pendingValue(); } - @Override - public Text getValueText(double value) { - return valueFormatter.apply(value); - } } diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/FloatSliderControl.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/FloatSliderController.java index d74ec33..6f4192b 100644 --- a/src/main/java/dev/isxander/yacl/gui/controllers/slider/FloatSliderControl.java +++ b/src/main/java/dev/isxander/yacl/gui/controllers/slider/FloatSliderController.java @@ -6,7 +6,13 @@ import org.apache.commons.lang3.Validate; import java.util.function.Function; -public class FloatSliderControl implements ISliderControl<Float> { +/** + * {@link ISliderController} for floats. + */ +public class FloatSliderController implements ISliderController<Float> { + /** + * Formats floats to one decimal place + */ public static final Function<Float, Text> DEFAULT_FORMATTER = value -> Text.of(String.format("%.1f", value)); private final Option<Float> option; @@ -15,11 +21,29 @@ public class FloatSliderControl implements ISliderControl<Float> { private final Function<Float, Text> valueFormatter; - public FloatSliderControl(Option<Float> option, float min, float max, float interval) { + /** + * Constructs a {@link ISliderController} for floats + * using the default value formatter {@link FloatSliderController#DEFAULT_FORMATTER}. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + */ + public FloatSliderController(Option<Float> option, float min, float max, float interval) { this(option, min, max, interval, DEFAULT_FORMATTER); } - public FloatSliderControl(Option<Float> option, float min, float max, float interval, Function<Float, Text> valueFormatter) { + /** + * Constructs a {@link ISliderController} for floats. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + * @param valueFormatter format the value into any {@link Text} + */ + public FloatSliderController(Option<Float> option, float min, float max, float interval, Function<Float, Text> valueFormatter) { Validate.isTrue(max > min, "`max` cannot be smaller than `min`"); Validate.isTrue(interval > 0, "`interval` must be more than 0"); @@ -30,43 +54,60 @@ public class FloatSliderControl implements ISliderControl<Float> { this.valueFormatter = valueFormatter; } + /** + * {@inheritDoc} + */ @Override public Option<Float> option() { return option; } + /** + * {@inheritDoc} + */ @Override public Text formatValue() { return valueFormatter.apply(option().pendingValue()); } + /** + * {@inheritDoc} + */ @Override public double min() { return min; } + /** + * {@inheritDoc} + */ @Override public double max() { return max; } + /** + * {@inheritDoc} + */ @Override public double interval() { return interval; } + /** + * {@inheritDoc} + */ @Override public void setPendingValue(double value) { option().requestSet((float) value); } + /** + * {@inheritDoc} + */ @Override public double pendingValue() { return option().pendingValue(); } - @Override - public Text getValueText(double value) { - return valueFormatter.apply((float) value); - } } diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/ISliderControl.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/ISliderControl.java deleted file mode 100644 index 8c1cdf8..0000000 --- a/src/main/java/dev/isxander/yacl/gui/controllers/slider/ISliderControl.java +++ /dev/null @@ -1,29 +0,0 @@ -package dev.isxander.yacl.gui.controllers.slider; - -import dev.isxander.yacl.api.Control; -import dev.isxander.yacl.api.utils.Dimension; -import dev.isxander.yacl.gui.controllers.ControlWidget; -import net.minecraft.client.gui.screen.Screen; -import net.minecraft.text.Text; - -public interface ISliderControl<T extends Number> extends Control<T> { - double min(); - - double max(); - - double interval(); - - default double range() { - return max() - min(); - } - - void setPendingValue(double value); - double pendingValue(); - - Text getValueText(double value); - - @Override - default ControlWidget<?> provideWidget(Screen screen, Dimension<Integer> widgetDimension) { - return new SliderControlElement(this, screen, widgetDimension, min(), max(), interval()); - } -} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/ISliderController.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/ISliderController.java new file mode 100644 index 0000000..0f6c2d5 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/slider/ISliderController.java @@ -0,0 +1,54 @@ +package dev.isxander.yacl.gui.controllers.slider; + +import dev.isxander.yacl.api.Controller; +import dev.isxander.yacl.api.utils.Dimension; +import dev.isxander.yacl.gui.controllers.ControllerWidget; +import net.minecraft.client.gui.screen.Screen; + +/** + * Simple custom slider implementation that shifts the current value across when shown. + * <p> + * For simplicity, {@link SliderControllerElement} works in doubles so each + * {@link ISliderController} must cast to double. This is to get around re-writing the element for every type. + */ +public interface ISliderController<T extends Number> extends Controller<T> { + /** + * Gets the minimum value for the slider + */ + double min(); + + /** + * Gets the maximum value for the slider + */ + double max(); + + /** + * Gets the interval (or step size) for the slider. + */ + double interval(); + + /** + * Gets the range of the slider. + */ + default double range() { + return max() - min(); + } + + /** + * Sets the {@link dev.isxander.yacl.api.Option}'s pending value + */ + void setPendingValue(double value); + + /** + * Gets the {@link dev.isxander.yacl.api.Option}'s pending value + */ + double pendingValue(); + + /** + * {@inheritDoc} + */ + @Override + default ControllerWidget<?> provideWidget(Screen screen, Dimension<Integer> widgetDimension) { + return new SliderControllerElement(this, screen, widgetDimension, min(), max(), interval()); + } +} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/IntegerSliderControl.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/IntegerSliderControl.java deleted file mode 100644 index 99c8137..0000000 --- a/src/main/java/dev/isxander/yacl/gui/controllers/slider/IntegerSliderControl.java +++ /dev/null @@ -1,72 +0,0 @@ -package dev.isxander.yacl.gui.controllers.slider; - -import dev.isxander.yacl.api.Option; -import net.minecraft.text.Text; -import org.apache.commons.lang3.Validate; - -import java.util.function.Function; - -public class IntegerSliderControl implements ISliderControl<Integer> { - public static final Function<Integer, Text> DEFAULT_FORMATTER = value -> Text.of(String.valueOf(value)); - - private final Option<Integer> option; - - private final int min, max, interval; - - private final Function<Integer, Text> valueFormatter; - - public IntegerSliderControl(Option<Integer> option, int min, int max, int interval) { - this(option, min, max, interval, DEFAULT_FORMATTER); - } - - public IntegerSliderControl(Option<Integer> option, int min, int max, int interval, Function<Integer, Text> valueFormatter) { - Validate.isTrue(max > min, "`max` cannot be smaller than `min`"); - Validate.isTrue(interval > 0, "`interval` must be more than 0"); - - this.option = option; - this.min = min; - this.max = max; - this.interval = interval; - this.valueFormatter = valueFormatter; - } - - @Override - public Option<Integer> option() { - return option; - } - - @Override - public Text formatValue() { - return valueFormatter.apply(option().pendingValue()); - } - - @Override - public double min() { - return min; - } - - @Override - public double max() { - return max; - } - - @Override - public double interval() { - return interval; - } - - @Override - public void setPendingValue(double value) { - option().requestSet((int) value); - } - - @Override - public double pendingValue() { - return option().pendingValue(); - } - - @Override - public Text getValueText(double value) { - return valueFormatter.apply((int) value); - } -} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/IntegerSliderController.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/IntegerSliderController.java new file mode 100644 index 0000000..0d0d7b9 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/slider/IntegerSliderController.java @@ -0,0 +1,111 @@ +package dev.isxander.yacl.gui.controllers.slider; + +import dev.isxander.yacl.api.Option; +import dev.isxander.yacl.impl.utils.NumberFormatHelper; +import net.minecraft.text.Text; +import org.apache.commons.lang3.Validate; + +import java.util.function.Function; + +/** + * {@link ISliderController} for integers. + */ +public class IntegerSliderController implements ISliderController<Integer> { + public static final Function<Integer, Text> DEFAULT_FORMATTER = value -> Text.of(NumberFormatHelper.formatSmaller(value)); + + private final Option<Integer> option; + + private final int min, max, interval; + + private final Function<Integer, Text> valueFormatter; + + /** + * Constructs a {@link ISliderController} for integers + * using the default value formatter {@link IntegerSliderController#DEFAULT_FORMATTER}. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + */ + public IntegerSliderController(Option<Integer> option, int min, int max, int interval) { + this(option, min, max, interval, DEFAULT_FORMATTER); + } + + /** + * Constructs a {@link ISliderController} for integers. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + * @param valueFormatter format the value into any {@link Text} + */ + public IntegerSliderController(Option<Integer> option, int min, int max, int interval, Function<Integer, Text> valueFormatter) { + Validate.isTrue(max > min, "`max` cannot be smaller than `min`"); + Validate.isTrue(interval > 0, "`interval` must be more than 0"); + + this.option = option; + this.min = min; + this.max = max; + this.interval = interval; + this.valueFormatter = valueFormatter; + } + + /** + * {@inheritDoc} + */ + @Override + public Option<Integer> option() { + return option; + } + + /** + * {@inheritDoc} + */ + @Override + public Text formatValue() { + return valueFormatter.apply(option().pendingValue()); + } + + /** + * {@inheritDoc} + */ + @Override + public double min() { + return min; + } + + /** + * {@inheritDoc} + */ + @Override + public double max() { + return max; + } + + /** + * {@inheritDoc} + */ + @Override + public double interval() { + return interval; + } + + /** + * {@inheritDoc} + */ + @Override + public void setPendingValue(double value) { + option().requestSet((int) value); + } + + /** + * {@inheritDoc} + */ + @Override + public double pendingValue() { + return option().pendingValue(); + } + +} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/LongSliderController.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/LongSliderController.java new file mode 100644 index 0000000..d4c71d1 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/slider/LongSliderController.java @@ -0,0 +1,111 @@ +package dev.isxander.yacl.gui.controllers.slider; + +import dev.isxander.yacl.api.Option; +import dev.isxander.yacl.impl.utils.NumberFormatHelper; +import net.minecraft.text.Text; +import org.apache.commons.lang3.Validate; + +import java.util.function.Function; + +/** + * {@link ISliderController} for longs. + */ +public class LongSliderController implements ISliderController<Long> { + public static final Function<Long, Text> DEFAULT_FORMATTER = value -> Text.of(NumberFormatHelper.formatSmaller(value)); + + private final Option<Long> option; + + private final long min, max, interval; + + private final Function<Long, Text> valueFormatter; + + /** + * Constructs a {@link ISliderController} for longs + * using the default value formatter {@link LongSliderController#DEFAULT_FORMATTER}. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + */ + public LongSliderController(Option<Long> option, long min, long max, long interval) { + this(option, min, max, interval, DEFAULT_FORMATTER); + } + + /** + * Constructs a {@link ISliderController} for longs. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + * @param valueFormatter format the value into any {@link Text} + */ + public LongSliderController(Option<Long> option, long min, long max, long interval, Function<Long, Text> valueFormatter) { + Validate.isTrue(max > min, "`max` cannot be smaller than `min`"); + Validate.isTrue(interval > 0, "`interval` must be more than 0"); + + this.option = option; + this.min = min; + this.max = max; + this.interval = interval; + this.valueFormatter = valueFormatter; + } + + /** + * {@inheritDoc} + */ + @Override + public Option<Long> option() { + return option; + } + + /** + * {@inheritDoc} + */ + @Override + public Text formatValue() { + return valueFormatter.apply(option().pendingValue()); + } + + /** + * {@inheritDoc} + */ + @Override + public double min() { + return min; + } + + /** + * {@inheritDoc} + */ + @Override + public double max() { + return max; + } + + /** + * {@inheritDoc} + */ + @Override + public double interval() { + return interval; + } + + /** + * {@inheritDoc} + */ + @Override + public void setPendingValue(double value) { + option().requestSet((long) value); + } + + /** + * {@inheritDoc} + */ + @Override + public double pendingValue() { + return option().pendingValue(); + } + +} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/SliderControlElement.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/SliderControllerElement.java index b8dab71..139ef39 100644 --- a/src/main/java/dev/isxander/yacl/gui/controllers/slider/SliderControlElement.java +++ b/src/main/java/dev/isxander/yacl/gui/controllers/slider/SliderControllerElement.java @@ -1,14 +1,15 @@ package dev.isxander.yacl.gui.controllers.slider; import dev.isxander.yacl.api.utils.Dimension; -import dev.isxander.yacl.gui.controllers.ControlWidget; +import dev.isxander.yacl.gui.controllers.ControllerWidget; import net.minecraft.client.gui.DrawableHelper; import net.minecraft.client.gui.screen.Screen; import net.minecraft.client.util.math.MatrixStack; -import net.minecraft.text.Text; import net.minecraft.util.math.MathHelper; +import org.jetbrains.annotations.ApiStatus; -public class SliderControlElement extends ControlWidget<ISliderControl<?>> { +@ApiStatus.Internal +public class SliderControllerElement extends ControllerWidget<ISliderController<?>> { private final double min, max, interval; private float interpolation; @@ -17,7 +18,7 @@ public class SliderControlElement extends ControlWidget<ISliderControl<?>> { private boolean mouseDown = false; - public SliderControlElement(ISliderControl<?> option, Screen screen, Dimension<Integer> dim, double min, double max, double interval) { + public SliderControllerElement(ISliderController<?> option, Screen screen, Dimension<Integer> dim, double min, double max, double interval) { super(option, screen, dim); this.min = min; this.max = max; @@ -103,18 +104,13 @@ public class SliderControlElement extends ControlWidget<ISliderControl<?>> { @Override protected int getHoveredControlWidth() { - int textWidth = textRenderer.getWidth(getValueText()); - return hovered ? sliderBounds.width() + textWidth + 6 + getThumbWidth() / 2 : textWidth ; + return sliderBounds.width() + getUnhoveredControlWidth() + 6 + getThumbWidth() / 2; } private void calculateInterpolation() { interpolation = (float) ((control.pendingValue() - control.min()) * 1 / control.range()); } - private Text getValueText() { - return control.getValueText(control.pendingValue()); - } - private int getThumbX() { return (int) (sliderBounds.x() + sliderBounds.width() * interpolation); } diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/package-info.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/package-info.java new file mode 100644 index 0000000..bff0d57 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/slider/package-info.java @@ -0,0 +1,10 @@ +/** + * This package contains implementations of sliders for different number types + * <ul> + * <li>For doubles: {@link dev.isxander.yacl.gui.controllers.slider.DoubleSliderController}</li> + * <li>For floats: {@link dev.isxander.yacl.gui.controllers.slider.FloatSliderController}</li> + * <li>For integers: {@link dev.isxander.yacl.gui.controllers.slider.IntegerSliderController}</li> + * <li>For longs: {@link dev.isxander.yacl.gui.controllers.slider.LongSliderController}</li> + * </ul> + */ +package dev.isxander.yacl.gui.controllers.slider; |