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;
34
35/**
36 * A specific API for interfacing with the mouse.
37 */
38public interface MouseInput extends Input {
39
40    /**
41     * Mouse X axis.
42     */
43    public static final int AXIS_X = 0;
44
45    /**
46     * Mouse Y axis.
47     */
48    public static final int AXIS_Y = 1;
49
50    /**
51     * Mouse wheel axis.
52     */
53    public static final int AXIS_WHEEL = 2;
54
55    /**
56     * Left mouse button.
57     */
58    public static final int BUTTON_LEFT   = 0;
59
60    /**
61     * Right mouse button.
62     */
63    public static final int BUTTON_RIGHT  = 1;
64
65    /**
66     * Middle mouse button.
67     */
68    public static final int BUTTON_MIDDLE = 2;
69
70    /**
71     * Set whether the mouse cursor should be visible or not.
72     *
73     * @param visible Whether the mouse cursor should be visible or not.
74     */
75    public void setCursorVisible(boolean visible);
76
77    /**
78     * Returns the number of buttons the mouse has. Typically 3 for most mice.
79     *
80     * @return the number of buttons the mouse has.
81     */
82    public int getButtonCount();
83}
84