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.controls;
34
35import com.jme3.input.MouseInput;
36
37/**
38 * A <code>MouseButtonTrigger</code> is used as a mapping to receive events
39 * from mouse buttons. It is generally expected for a mouse to have at least
40 * a left and right mouse button, but some mice may have a lot more buttons
41 * than that.
42 *
43 * @author Kirill Vainer
44 */
45public class MouseButtonTrigger implements Trigger {
46
47    private final int mouseButton;
48
49    /**
50     * Create a new <code>MouseButtonTrigger</code> to receive mouse button events.
51     *
52     * @param mouseButton Mouse button index. See BUTTON_*** constants in
53     * {@link MouseInput}.
54     */
55    public MouseButtonTrigger(int mouseButton) {
56        if  (mouseButton < 0)
57            throw new IllegalArgumentException("Mouse Button cannot be negative");
58
59        this.mouseButton = mouseButton;
60    }
61
62    public int getMouseButton() {
63        return mouseButton;
64    }
65
66    public String getName() {
67        return "Mouse Button " + mouseButton;
68    }
69
70    public static int mouseButtonHash(int mouseButton){
71        assert mouseButton >= 0 && mouseButton <= 255;
72        return 256 | (mouseButton & 0xff);
73    }
74
75    public int triggerHashCode() {
76        return mouseButtonHash(mouseButton);
77    }
78
79}
80