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.InputManager;
     36 import com.jme3.input.Joystick;
     37 
     38 /**
     39  * Joystick axis event.
     40  *
     41  * @author Kirill Vainer
     42  */
     43 public class JoyAxisEvent extends InputEvent {
     44 
     45     private int joyIdx;
     46     private int axisIdx;
     47     private float value;
     48 
     49     public JoyAxisEvent(int joyIdx, int axisIdx, float value) {
     50         this.joyIdx = joyIdx;
     51         this.axisIdx = axisIdx;
     52         this.value = value;
     53     }
     54 
     55     /**
     56      * Returns the joystick axis index.
     57      *
     58      * @return joystick axis index.
     59      *
     60      * @see Joystick#assignAxis(java.lang.String, java.lang.String, int)
     61      */
     62     public int getAxisIndex() {
     63         return axisIdx;
     64     }
     65 
     66     /**
     67      * The joystick index.
     68      *
     69      * @return joystick index.
     70      *
     71      * @see InputManager#getJoysticks()
     72      */
     73     public int getJoyIndex() {
     74         return joyIdx;
     75     }
     76 
     77     /**
     78      * The value of the axis.
     79      *
     80      * @return value of the axis.
     81      */
     82     public float getValue() {
     83         return value;
     84     }
     85 }
     86