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  * Abstract interface for an input device.
     37  *
     38  * @see MouseInput
     39  * @see KeyInput
     40  * @see JoyInput
     41  */
     42 public interface Input {
     43 
     44     /**
     45      * Initializes the native side to listen into events from the device.
     46      */
     47     public void initialize();
     48 
     49     /**
     50      * Queries the device for input. All events should be sent to the
     51      * RawInputListener set with setInputListener.
     52      *
     53      * @see #setInputListener(com.jme3.input.RawInputListener)
     54      */
     55     public void update();
     56 
     57     /**
     58      * Ceases listening to events from the device.
     59      */
     60     public void destroy();
     61 
     62     /**
     63      * @return True if the device has been initialized and not destroyed.
     64      * @see #initialize()
     65      * @see #destroy()
     66      */
     67     public boolean isInitialized();
     68 
     69     /**
     70      * Sets the input listener to receive events from this device. The
     71      * appropriate events should be dispatched through the callbacks
     72      * in RawInputListener.
     73      * @param listener
     74      */
     75     public void setInputListener(RawInputListener listener);
     76 
     77     /**
     78      * @return The current absolute time as nanoseconds. This time is expected
     79      * to be relative to the time given in InputEvents time property.
     80      */
     81     public long getInputTimeNanos();
     82 }
     83