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 import com.jme3.input.event.*;
36 
37 /**
38  * An interface used for receiving raw input from devices.
39  */
40 public interface RawInputListener {
41 
42     /**
43      * Called before a batch of input will be sent to this
44      * <code>RawInputListener</code>.
45      */
beginInput()46     public void beginInput();
47 
48     /**
49      * Called after a batch of input was sent to this
50      * <code>RawInputListener</code>.
51      *
52      * The listener should set the {@link InputEvent#setConsumed() consumed flag}
53      * on any events that have been consumed either at this call or previous calls.
54      */
endInput()55     public void endInput();
56 
57     /**
58      * Invoked on joystick axis events.
59      *
60      * @param evt
61      */
onJoyAxisEvent(JoyAxisEvent evt)62     public void onJoyAxisEvent(JoyAxisEvent evt);
63 
64     /**
65      * Invoked on joystick button presses.
66      *
67      * @param evt
68      */
onJoyButtonEvent(JoyButtonEvent evt)69     public void onJoyButtonEvent(JoyButtonEvent evt);
70 
71     /**
72      * Invoked on mouse movement/motion events.
73      *
74      * @param evt
75      */
onMouseMotionEvent(MouseMotionEvent evt)76     public void onMouseMotionEvent(MouseMotionEvent evt);
77 
78     /**
79      * Invoked on mouse button events.
80      *
81      * @param evt
82      */
onMouseButtonEvent(MouseButtonEvent evt)83     public void onMouseButtonEvent(MouseButtonEvent evt);
84 
85     /**
86      * Invoked on keyboard key press or release events.
87      *
88      * @param evt
89      */
onKeyEvent(KeyInputEvent evt)90     public void onKeyEvent(KeyInputEvent evt);
91 
92 
93     /**
94      * Invoked on touchscreen touch events.
95      *
96      * @param evt
97      */
onTouchEvent(TouchEvent evt)98     public void onTouchEvent(TouchEvent evt);
99 }
100