159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2010 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.input.event; 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>TouchEvent</code> represents a single event from multi-touch input devices 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author larynx 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class TouchEvent extends InputEvent { 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public enum Type { 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Touch down event, fields: posX, posY, pressure 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta DOWN, 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Move/Drag event, fields: posX, posY, deltaX, deltaY, pressure 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta MOVE, 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Touch up event, fields: posX, posY, pressure 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta UP, 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Virtual keyboard or hardware key event down, fields: keyCode, characters 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta KEY_DOWN, 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Virtual keyboard or hardware key event up, fields: keyCode, characters 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta KEY_UP, 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // Single finger gestures 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta FLING, 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta TAP, 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta DOUBLETAP, 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta LONGPRESSED, 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // Two finger scale events 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Two finger scale event start, fields: posX/posY = getFocusX/Y, scaleFactor, scaleSpan 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta SCALE_START, 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Two finger scale event, fields: posX/posY = getFocusX/Y, scaleFactor, scaleSpan 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta SCALE_MOVE, 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Two finger scale event end, fields: posX/posY = getFocusX/Y, scaleFactor, scaleSpan 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta SCALE_END, 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Scroll event 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta SCROLL, 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * The user has performed a down MotionEvent and not performed a move or up yet. This event is commonly used to provide visual feedback to the user to let them know that their action has been recognized i.e. highlight an element. 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta SHOWPRESS, 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // Others 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta OUTSIDE, 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta IDLE 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private Type type = Type.IDLE; 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private int pointerId; 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float posX; 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float posY; 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float deltaX; 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float deltaY; 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float pressure; 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // Used only with KEY* events 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private int keyCode; 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private String characters; 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // Used only with SCALE* events 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float scaleFactor; 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float scaleSpan; 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public TouchEvent() { 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta set(Type.IDLE, 0f, 0f, 0f, 0f); 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public TouchEvent(Type type, float x, float y, float deltax, float deltay) { 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta set(type, x, y, deltax, deltay); 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void set(Type type) { 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta set(type, 0f, 0f, 0f, 0f); 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void set(Type type, float x, float y, float deltax, float deltay) { 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.type = type; 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.posX = x; 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.posY = y; 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.deltaX = deltax; 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.deltaY = deltay; 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta pointerId = 0; 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta pressure = 0; 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta keyCode = 0; 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta scaleFactor = 0; 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta scaleSpan = 0; 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta characters = ""; 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta consumed = false; 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns the type of touch event. 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return the type of touch event. 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Type getType() { 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return type; 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getX() { 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return posX; 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getY() { 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return posY; 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getDeltaX() { 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return deltaX; 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getDeltaY() { 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return deltaY; 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getPressure() 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta { 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return pressure; 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setPressure(float pressure) 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta { 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.pressure = pressure; 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int getPointerId() 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta { 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return pointerId; 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setPointerId(int pointerId) { 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.pointerId = pointerId; 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int getKeyCode() { 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return keyCode; 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setKeyCode(int keyCode) { 18359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.keyCode = keyCode; 18459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public String getCharacters() { 18759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return characters; 18859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setCharacters(String characters) { 19159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.characters = characters; 19259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getScaleFactor() { 19559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return scaleFactor; 19659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setScaleFactor(float scaleFactor) { 19959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.scaleFactor = scaleFactor; 20059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 20259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getScaleSpan() { 20359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return scaleSpan; 20459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 20659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setScaleSpan(float scaleSpan) { 20759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.scaleSpan = scaleSpan; 20859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 210