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.Input; 36 37 /** 38 * An abstract input event. 39 */ 40 public abstract class InputEvent { 41 42 protected long time; 43 44 45 protected boolean consumed = false; 46 47 /** 48 * The time when the event occurred. This is relative to 49 * {@link Input#getInputTimeNanos() }. 50 * 51 * @return time when the event occured 52 */ getTime()53 public long getTime(){ 54 return time; 55 } 56 57 /** 58 * Set the time when the event occurred. 59 * 60 * @param time time when the event occurred. 61 */ setTime(long time)62 public void setTime(long time){ 63 this.time = time; 64 } 65 66 /** 67 * Returns true if the input event has been consumed, meaning it is no longer valid 68 * and should not be forwarded to input listeners. 69 * 70 * @return true if the input event has been consumed 71 */ isConsumed()72 public boolean isConsumed() { 73 return consumed; 74 } 75 76 /** 77 * Call to mark this input event as consumed, meaning it is no longer valid 78 * and should not be forwarded to input listeners. 79 */ setConsumed()80 public void setConsumed() { 81 this.consumed = true; 82 } 83 84 } 85