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
33package com.jme3.input.event;
34
35/**
36 * Mouse movement event.
37 * <p>
38 * Movement events are only generated if the mouse is on-screen.
39 *
40 * @author Kirill Vainer
41 */
42public class MouseMotionEvent extends InputEvent {
43
44    private int x, y, dx, dy, wheel, deltaWheel;
45
46    public MouseMotionEvent(int x, int y, int dx, int dy, int wheel, int deltaWheel) {
47        this.x = x;
48        this.y = y;
49        this.dx = dx;
50        this.dy = dy;
51        this.wheel = wheel;
52        this.deltaWheel = deltaWheel;
53    }
54
55    /**
56     * The change in wheel rotation.
57     *
58     * @return change in wheel rotation.
59     */
60    public int getDeltaWheel() {
61        return deltaWheel;
62    }
63
64    /**
65     * The change in X coordinate
66     * @return change in X coordinate
67     */
68    public int getDX() {
69        return dx;
70    }
71
72    /**
73     * The change in Y coordinate
74     *
75     * @return change in Y coordinate
76     */
77    public int getDY() {
78        return dy;
79    }
80
81    /**
82     * Current mouse wheel value
83     * @return Current mouse wheel value
84     */
85    public int getWheel() {
86        return wheel;
87    }
88
89    /**
90     * Current X coordinate
91     * @return Current X coordinate
92     */
93    public int getX() {
94        return x;
95    }
96
97    /**
98     * Current Y coordinate
99     * @return Current Y coordinate
100     */
101    public int getY() {
102        return y;
103    }
104
105    @Override
106    public String toString(){
107        return "MouseMotion(X="+x+", Y="+y+", DX="+dx+", DY="+dy+")";
108    }
109
110}
111