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.MouseInput; 36 37 /** 38 * A <code>MouseAxisTrigger</code> is used as a mapping to mouse axis, 39 * a mouse axis is movement along the X axis (left/right), Y axis (up/down) 40 * and the mouse wheel (scroll up/down). 41 * 42 * @author Kirill Vainer 43 */ 44 public class MouseAxisTrigger implements Trigger { 45 46 private int mouseAxis; 47 private boolean negative; 48 49 /** 50 * Create a new <code>MouseAxisTrigger</code>. 51 * <p> 52 * @param mouseAxis Mouse axis. See AXIS_*** constants in {@link MouseInput} 53 * @param negative True if listen to negative axis events, false if 54 * listen to positive axis events. 55 */ MouseAxisTrigger(int mouseAxis, boolean negative)56 public MouseAxisTrigger(int mouseAxis, boolean negative){ 57 if (mouseAxis < 0 || mouseAxis > 2) 58 throw new IllegalArgumentException("Mouse Axis must be between 0 and 2"); 59 60 this.mouseAxis = mouseAxis; 61 this.negative = negative; 62 } 63 getMouseAxis()64 public int getMouseAxis(){ 65 return mouseAxis; 66 } 67 isNegative()68 public boolean isNegative() { 69 return negative; 70 } 71 getName()72 public String getName() { 73 String sign = negative ? "Negative" : "Positive"; 74 switch (mouseAxis){ 75 case MouseInput.AXIS_X: return "Mouse X Axis " + sign; 76 case MouseInput.AXIS_Y: return "Mouse Y Axis " + sign; 77 case MouseInput.AXIS_WHEEL: return "Mouse Wheel " + sign; 78 default: throw new AssertionError(); 79 } 80 } 81 mouseAxisHash(int mouseAxis, boolean negative)82 public static int mouseAxisHash(int mouseAxis, boolean negative){ 83 assert mouseAxis >= 0 && mouseAxis <= 255; 84 return (negative ? 768 : 512) | (mouseAxis & 0xff); 85 } 86 triggerHashCode()87 public int triggerHashCode() { 88 return mouseAxisHash(mouseAxis, negative); 89 } 90 } 91