1 /* 2 * Copyright (c) 2009-2010 jMonkeyEngine 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: 8 * 9 * * Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 package com.jme3.input; 34 35 /** 36 * A specific API for interfacing with joysticks or gaming controllers. 37 */ 38 public interface JoyInput extends Input { 39 40 /** 41 * The X axis for POV (point of view hat). 42 */ 43 public static final int AXIS_POV_X = 254; 44 45 /** 46 * The Y axis for POV (point of view hat). 47 */ 48 public static final int AXIS_POV_Y = 255; 49 50 /** 51 * Causes the joystick at <code>joyId</code> index to rumble with 52 * the given amount. 53 * 54 * @param joyId The joystick index 55 * @param amount Rumble amount. Should be between 0 and 1. 56 */ setJoyRumble(int joyId, float amount)57 public void setJoyRumble(int joyId, float amount); 58 59 /** 60 * Loads a list of joysticks from the system. 61 * 62 * @param inputManager The input manager requesting to load joysticks 63 * @return A list of joysticks that are installed. 64 */ loadJoysticks(InputManager inputManager)65 public Joystick[] loadJoysticks(InputManager inputManager); 66 } 67