src/com/jme/input/RelativeMouse.java

   1 /*
   2  * Copyright (c) 2003-2009 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 /*
  34  * EDIT:  02/08/2004 - Added update(boolean updateState) to allow for a
  35  *                      WidgetViewport to update an AbstractInputHandler
  36  *                      without polling the mouse.  GOP
  37  */
  38
  39 package com.jme.input;
  40
  41 import com.jme.input.action.InputAction;
  42 import com.jme.input.action.InputActionEvent;
  43
  44 /**
  45  * <code>RelativeMouse</code> defines a mouse controller that only maintains
  46  * the relative change from one poll to the next. This does not maintain the
  47  * position of a mouse in a rendering window. This type of controller is
  48  * typically useful for a first person mouse look or similar.
  49  *
  50  * @author Mark Powell
  51  * @version $Id: RelativeMouse.java,v 1.18 2006/01/13 19:39:27 renanse Exp $
  52  */
  53 public class RelativeMouse extends Mouse {
  54
  55     private static final long serialVersionUID = 1L;
  56     private InputAction updateAction = new InputAction() {
  57         public void performAction( InputActionEvent evt ) {
  58             localTranslation.x = MouseInput.get().getXDelta() * _speed;
  59             localTranslation.y = MouseInput.get().getYDelta() * _speed;
  60             worldTranslation.set(localTranslation);
  61             hotSpotLocation.set(localTranslation).addLocal(hotSpotOffset);
  62         }
  63     };
  64     private InputHandler registeredInputHandler;
  65     protected float _speed = 1.0f;
  66
  67     /**
  68      * Constructor creates a new <code>RelativeMouse</code> object.
  69      *
  70      * @param name
  71      *            the name of the scene element. This is required for
  72      *            identification and comparision purposes.
  73      */
  74     public RelativeMouse(String name) {
  75         super(name);
  76     }
  77
  78     public void registerWithInputHandler( InputHandler inputHandler ) {
  79
  80         if ( registeredInputHandler != null )
  81         {
  82             registeredInputHandler.removeAction( updateAction );
  83         }
  84         registeredInputHandler = inputHandler;
  85         if ( inputHandler != null )
  86         {
  87             inputHandler.addAction( updateAction, InputHandler.DEVICE_MOUSE, InputHandler.BUTTON_NONE, 0, true );
  88         }
  89     }
  90
  91     /**
  92      * Sets the speed multiplier for updating the cursor position
  93      *
  94      * @param speed
  95      */
  96     public void setSpeed(float speed) {
  97         _speed = speed;
  98     }
  99 }