• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.controls;
34 
35 /**
36  * <code>ActionListener</code> is used to receive input events in "digital" style.
37  * <p>
38  * Generally all button inputs, such as keyboard, mouse button, and joystick button,
39  * will be represented exactly. Analog inputs will be converted into digital.
40  * <p>
41  * When an action listener is registered to a natively digital input, such as a button,
42  * the event will be invoked when the button is pressed, with <code>value</code>
43  * set to <code>true</code>, and will be invoked again when the button is released,
44  * with <code>value</code> set to <code>false</code>.
45  *
46  * @author Kirill Vainer
47  */
48 public interface ActionListener extends InputListener {
49 
50     /**
51      * Called when an input to which this listener is registered to is invoked.
52      *
53      * @param name The name of the mapping that was invoked
54      * @param isPressed True if the action is "pressed", false otherwise
55      * @param tpf The time per frame value.
56      */
onAction(String name, boolean isPressed, float tpf)57     public void onAction(String name, boolean isPressed, float tpf);
58 }
59