Home | History | Annotate | Download | only in event 
      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.event;
     34 
     35 import com.jme3.input.Joystick;
     36 
     37 /**
     38  * Joystick button event.
     39  *
     40  * @author Kirill Vainer
     41  */
     42 public class JoyButtonEvent extends InputEvent {
     43 
     44     private int joyIdx;
     45     private int btnIdx;
     46     private boolean pressed;
     47 
     48     public JoyButtonEvent(int joyIdx, int btnIdx, boolean pressed) {
     49         this.joyIdx = joyIdx;
     50         this.btnIdx = btnIdx;
     51         this.pressed = pressed;
     52     }
     53 
     54     /**
     55      * The button index.
     56      *
     57      * @return button index.
     58      *
     59      * @see Joystick#assignButton(java.lang.String, int)
     60      */
     61     public int getButtonIndex() {
     62         return btnIdx;
     63     }
     64 
     65     /**
     66      * The joystick index.
     67      *
     68      * @return joystick index.
     69      *
     70      * @see InputManager#getJoysticks()
     71      */
     72     public int getJoyIndex() {
     73         return joyIdx;
     74     }
     75 
     76     /**
     77      * Returns true if the event was a button press,
     78      * returns false if the event was a button release.
     79      *
     80      * @return true if the event was a button press,
     81      * false if the event was a button release.
     82      */
     83     public boolean isPressed() {
     84         return pressed;
     85     }
     86 
     87 
     88 
     89 }
     90