Home | History | Annotate | Download | only in controls 
      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 import com.jme3.input.KeyInput;
     36 
     37 /**
     38  * A <code>KeyTrigger</code> is used as a mapping to keyboard keys.
     39  *
     40  * @author Kirill Vainer
     41  */
     42 public class KeyTrigger implements Trigger {
     43 
     44     private final int keyCode;
     45 
     46     /**
     47      * Create a new <code>KeyTrigger</code> for the given keycode.
     48      *
     49      * @param keyCode the code for the key, see constants in {@link KeyInput}.
     50      */
     51     public KeyTrigger(int keyCode){
     52         this.keyCode = keyCode;
     53     }
     54 
     55     public String getName() {
     56         return "KeyCode " + keyCode;
     57     }
     58 
     59     public int getKeyCode(){
     60         return keyCode;
     61     }
     62 
     63     public static int keyHash(int keyCode){
     64         assert keyCode >= 0 && keyCode <= 255;
     65         return keyCode & 0xff;
     66     }
     67 
     68     public int triggerHashCode() {
     69         return keyHash(keyCode);
     70     }
     71 
     72 }
     73