159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2010 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.input; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.input.event.*; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * An interface used for receiving raw input from devices. 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic interface RawInputListener { 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Called before a batch of input will be sent to this 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>RawInputListener</code>. 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void beginInput(); 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Called after a batch of input was sent to this 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>RawInputListener</code>. 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * The listener should set the {@link InputEvent#setConsumed() consumed flag} 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * on any events that have been consumed either at this call or previous calls. 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void endInput(); 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Invoked on joystick axis events. 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param evt 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onJoyAxisEvent(JoyAxisEvent evt); 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Invoked on joystick button presses. 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param evt 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onJoyButtonEvent(JoyButtonEvent evt); 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Invoked on mouse movement/motion events. 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param evt 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onMouseMotionEvent(MouseMotionEvent evt); 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Invoked on mouse button events. 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param evt 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onMouseButtonEvent(MouseButtonEvent evt); 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Invoked on keyboard key press or release events. 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param evt 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onKeyEvent(KeyInputEvent evt); 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Invoked on touchscreen touch events. 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param evt 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void onTouchEvent(TouchEvent evt); 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 100