Home | History | Annotate | Download | only in input 
      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 /**
     36  * A specific API for interfacing with smartphone touch devices
     37  */
     38 public interface TouchInput extends Input {
     39 
     40     /**
     41      * No filter, get all events
     42      */
     43     public static final int ALL = 0x00;
     44     /**
     45      * Home key
     46      */
     47     public static final int KEYCODE_HOME = 0x03;
     48     /**
     49      * Escape key.
     50      */
     51     public static final int KEYCODE_BACK = 0x04;
     52     /**
     53      * Context Menu key.
     54      */
     55     public static final int KEYCODE_MENU = 0x52;
     56     /**
     57      * Search key.
     58      */
     59     public static final int KEYCODE_SEARCH = 0x54;
     60     /**
     61      * Volume up key.
     62      */
     63     public static final int KEYCODE_VOLUME_UP = 0x18;
     64     /**
     65      * Volume down key.
     66      */
     67     public static final int KEYCODE_VOLUME_DOWN = 0x19;
     68 
     69 
     70     /**
     71      * Set if mouse events should be generated
     72      *
     73      * @param simulate if mouse events should be generated
     74      */
     75     public void setSimulateMouse(boolean simulate);
     76 
     77     /**
     78      * Get if mouse events are generated
     79      *
     80      */
     81     public boolean getSimulateMouse();
     82 
     83     /**
     84      * Set if keyboard events should be generated
     85      *
     86      * @param simulate if keyboard events should be generated
     87      */
     88     public void setSimulateKeyboard(boolean simulate);
     89 
     90     /**
     91      * Set if historic android events should be transmitted, can be used to get better performance and less mem
     92      * @see <a href="http://developer.android.com/reference/android/view/MotionEvent.html#getHistoricalX%28int,%20int%29">
     93      * http://developer.android.com/reference/android/view/MotionEvent.html#getHistoricalX%28int,%20int%29</a>
     94      * @param dontSendHistory turn of historic events if true, false else and default
     95      */
     96     public void setOmitHistoricEvents(boolean dontSendHistory);
     97 
     98 }