com.flash3388.flashlib.robot.systems.Movable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flashlib.robot.systems Show documentation

Robotics development framework (flashlib.robot.systems)

There is a newer version: 3.2.7

Show newest version

package com.flash3388.flashlib.robot.systems;

import com.beans.util.function.Suppliers;
import com.flash3388.flashlib.control.Direction;
import com.flash3388.flashlib.scheduling.Requirement;
import com.flash3388.flashlib.scheduling.actions.Action;

import java.util.function.DoubleSupplier;

/**
 * Describes a component capable of moving along a single axis.
 *
 * @since FlashLib 3.2.0
 */
public interface Movable extends Stoppable, Requirement {

    /**
     * Moves along the axis at a given speed.
     *
     * @param speed supplier of speed of motion [-1..1] describing
     *              percentage of power and direction.
     * @return action to perform motion.
     */
    Action move(DoubleSupplier speed);

    /**
     * Moves along the axis at a given speed.
     *
     * @param speed speed of motion [-1..1] describing
     *              percentage of power and direction.
     * @return action to perform motion.
     */
    default Action move(double speed) {
        return move(Suppliers.of(speed));
    }

    /**
     * Moves along the axis at a given speed and direction.
     *
     * @param speed absolute speed of motion [0...1] describing
     *              percentage of power.
     * @param direction direction of motion.
     * @return action to perform motion.
     */
    default Action move(double speed, Direction direction) {
        return move(Math.abs(speed) * direction.sign());
    }

    /**
     * Moves along the axis forward at a given speed.
     *
     * @param speed supplier absolute speed of motion [0...1] describing
     *              percentage of power.
     * @return action to perform motion.
     */
    default Action forward(DoubleSupplier speed) {
        return move(()-> Math.abs(speed.getAsDouble()));
    }

    /**
     * Moves along the axis forward at a given speed.
     *
     * @param speed absolute speed of motion [0...1] describing
     *              percentage of power.
     * @return action to perform motion.
     */
    default Action forward(double speed) {
        return move(speed, Direction.FORWARD);
    }

    /**
     * Moves along the axis backward at a given speed.
     *
     * @param speed supplier absolute speed of motion [0...1] describing
     *              percentage of power.
     * @return action to perform motion.
     */
    default Action backward(DoubleSupplier speed) {
        return move(()-> -Math.abs(speed.getAsDouble()));
    }

    /**
     * Moves along the axis backward at a given speed.
     *
     * @param speed absolute speed of motion [0...1] describing
     *              percentage of power.
     * @return action to perform motion.
     */
    default Action backward(double speed) {
        return move(speed, Direction.BACKWARD);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    void stop();
}