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
35import com.jme3.input.MouseInput;
36
37/**
38 * Mouse button press/release event.
39 *
40 * @author Kirill Vainer
41 */
42public class MouseButtonEvent extends InputEvent {
43
44    private int x;
45    private int y;
46    private int btnIndex;
47    private boolean pressed;
48
49    public MouseButtonEvent(int btnIndex, boolean pressed, int x, int y) {
50        this.btnIndex = btnIndex;
51        this.pressed = pressed;
52        this.x = x;
53        this.y = y;
54    }
55
56    /**
57     * Returns the mouse button index.
58     * <p>
59     * See constants in {@link MouseInput}.
60     *
61     * @return the mouse button index.
62     */
63    public int getButtonIndex() {
64        return btnIndex;
65    }
66
67    /**
68     * Returns true if the mouse button was pressed, false if it was released.
69     *
70     * @return true if the mouse button was pressed, false if it was released.
71     */
72    public boolean isPressed() {
73        return pressed;
74    }
75
76    /**
77     * Returns true if the mouse button was released, false if it was pressed.
78     *
79     * @return true if the mouse button was released, false if it was pressed.
80     */
81    public boolean isReleased() {
82        return !pressed;
83    }
84
85    /**
86     * The X coordinate of the mouse when the event was generated.
87     * @return X coordinate of the mouse when the event was generated.
88     */
89    public int getX() {
90        return x;
91    }
92
93    /**
94     * The Y coordinate of the mouse when the event was generated.
95     * @return Y coordinate of the mouse when the event was generated.
96     */
97    public int getY() {
98        return y;
99    }
100
101    @Override
102    public String toString(){
103        String str = "MouseButton(BTN="+btnIndex;
104        if (pressed){
105            return str + ", PRESSED)";
106        }else{
107            return str + ", RELEASED)";
108        }
109    }
110
111}
112