com.jme3.input.AbstractJoystick Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jme3-core Show documentation
jMonkeyEngine is a 3-D game engine for adventurous Java developers
The newest version!
/*
 * Copyright (c) 2009-2021 jMonkeyEngine
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.jme3.input;

import com.jme3.input.controls.JoyAxisTrigger;
import com.jme3.input.controls.JoyButtonTrigger;
import java.util.*;

/**
 * A joystick represents a single joystick that is installed in the system.
 *
 * @author Kirill Vainer, Paul Speed
 */
public abstract class AbstractJoystick implements Joystick {

    final private InputManager inputManager;
    final private JoyInput joyInput;
    final private int joyId;
    final private String name;

    final private List axes = new ArrayList<>();
    final private List buttons = new ArrayList<>();

    /**
     * Creates a new joystick instance. Only used internally.
     *
     * @param inputManager (alias created)
     * @param joyInput (alias created)
     * @param joyId ID to assign to the instance
     * @param name name to assign to the instance
     */
    protected AbstractJoystick(InputManager inputManager, JoyInput joyInput,
                               int joyId, String name) {
        this.inputManager = inputManager;
        this.joyInput = joyInput;
        this.joyId = joyId;
        this.name = name;
    }

    protected InputManager getInputManager() {
        return inputManager;
    }

    protected JoyInput getJoyInput() {
        return joyInput;
    }

    protected void addAxis(JoystickAxis axis) {
        axes.add(axis);
    }

    protected void addButton(JoystickButton button) {
        buttons.add(button);
    }

    /**
     * Rumbles the joystick for the given amount/magnitude.
     *
     * @param amount The amount to rumble. Should be between 0 and 1.
     */
    @Override
    public void rumble(float amount) {
        joyInput.setJoyRumble(joyId, amount);
    }

    /**
     * Assign the mapping name to receive events from the given button index
     * on the joystick.
     *
     * @param mappingName The mapping to receive joystick button events.
     * @param buttonId The button index.
     *
     * @see Joystick#getButtonCount()
     * @deprecated Use JoystickButton.assignButton() instead.
     */
    @Override
    @Deprecated
    public void assignButton(String mappingName, int buttonId) {
        if (buttonId < 0 || buttonId >= getButtonCount())
            throw new IllegalArgumentException();

        inputManager.addMapping(mappingName, new JoyButtonTrigger(joyId, buttonId));
    }

    /**
     * Assign the mappings to receive events from the given joystick axis.
     *
     * @param positiveMapping The mapping to receive events when the axis is negative
     * @param negativeMapping The mapping to receive events when the axis is positive
     * @param axisId The axis index.
     *
     * @see Joystick#getAxisCount()
     * @deprecated Use JoystickAxis.assignAxis() instead.
     */
    @Override
    @Deprecated
    public void assignAxis(String positiveMapping, String negativeMapping, int axisId) {

        // For backwards compatibility
        if (axisId == JoyInput.AXIS_POV_X) {
            axisId = getPovXAxis().getAxisId();
        } else if (axisId == JoyInput.AXIS_POV_Y) {
            axisId = getPovYAxis().getAxisId();
        }

        inputManager.addMapping(positiveMapping, new JoyAxisTrigger(joyId, axisId, false));
        inputManager.addMapping(negativeMapping, new JoyAxisTrigger(joyId, axisId, true));
    }

    @Override
    public JoystickAxis getAxis(String logicalId) {
        for (JoystickAxis axis : axes) {
            if (axis.getLogicalId().equals(logicalId))
                return axis;
        }
        return null;
    }

    /**
     * Returns a read-only list of all joystick axes for this Joystick.
     */
    @Override
    public List getAxes() {
        return Collections.unmodifiableList(axes);
    }

    /**
     * Returns the number of axes on this joystick.
     *
     * @return the number of axes on this joystick.
     */
    @Override
    public int getAxisCount() {
        return axes.size();
    }

    @Override
    public JoystickButton getButton(String logicalId) {
        for (JoystickButton b : buttons) {
            if (b.getLogicalId().equals(logicalId))
                return b;
        }
        return null;
    }

    /**
     * Returns a read-only list of all joystick buttons for this Joystick.
     */
    @Override
    public List getButtons() {
        return Collections.unmodifiableList(buttons);
    }

    /**
     * Returns the number of buttons on this joystick.
     *
     * @return the number of buttons on this joystick.
     */
    @Override
    public int getButtonCount() {
        return buttons.size();
    }

    /**
     * Returns the name of this joystick.
     *
     * @return the name of this joystick.
     */
    @Override
    public String getName() {
        return name;
    }

    /**
     * Returns the joyId of this joystick.
     *
     * @return the joyId of this joystick.
     */
    @Override
    public int getJoyId() {
        return joyId;
    }

    /**
     * Gets the index number for the X axis on the joystick.
     *
     * E.g. for most gamepads, the left control stick X axis will be returned.
     *
     * @return The axis index for the X axis for this joystick.
     *
     * @see Joystick#assignAxis(java.lang.String, java.lang.String, int)
     */
    @Override
    public int getXAxisIndex() {
        return getXAxis().getAxisId();
    }

    /**
     * Gets the index number for the Y axis on the joystick.
     *
     * E.g. for most gamepads, the left control stick Y axis will be returned.
     *
     * @return The axis index for the Y axis for this joystick.
     *
     * @see Joystick#assignAxis(java.lang.String, java.lang.String, int)
     */
    @Override
    public int getYAxisIndex() {
        return getYAxis().getAxisId();
    }

    @Override
    public String toString() {
        return "Joystick[name=" + name + ", id=" + joyId + ", buttons=" + getButtonCount()
                                + ", axes=" + getAxisCount() + "]";
    }
}