it.unibo.alchemist.boundary.ui.impl.AbstractSlideInputManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-ui-tooling Show documentation

Classes and resources for developing Alchemist UIs

There is a newer version: 35.0.1

/*
 * Copyright (C) 2010-2022, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */
package it.unibo.alchemist.boundary.ui.impl;

import it.unibo.alchemist.boundary.ui.api.SlideInputManager;

/**
 * ASlideInputManager is the base class for any class whose aim is
 * to handle the the sliding of any physical/virtual device/control.
 * 
 * 
 */
public class AbstractSlideInputManager implements SlideInputManager {

    private double value;
    private final double min, max;

    /**
     * Creates a new ASlideInputManager with the value in input.
     * 

     * This is useful if you want to have an initial output.
     * 
     * @param initialValue
     *            is the hypothetical initial amound of 'slides'
     * @param min
     *            the minimum allowed
     * @param max
     *            the maximum allowed
     */
    public AbstractSlideInputManager(final double initialValue, final double min, final double max) {
        value = initialValue;
        this.min = min;
        this.max = max;
    }

    @Override
    public final void dec(final double val) {
        setValue(value - val);
    }

    /**
     * Allow any child class to see the current value.
     * 
     * @return the current amount of 'slides'
     */
    protected double getValue() {
        return value;
    }

    @Override
    public final void inc(final double val) {
        setValue(value + val);
    }

    /**
     * Allow any child class to modify the value directly.
     * 
     * @param val
     *            is the new value
     */
    protected void setValue(final double val) {
        value = val < min ? min : val > max ? max : val;
    }

}