Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
SoMouseButtonEvent.h
1 #ifndef COIN_SOMOUSEBUTTONEVENT_H
2 #define COIN_SOMOUSEBUTTONEVENT_H
3 
4 /**************************************************************************\
5  * Copyright (c) Kongsberg Oil & Gas Technologies AS
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * Neither the name of the copyright holder nor the names of its
20  * contributors may be used to endorse or promote products derived from
21  * this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 \**************************************************************************/
35 
36 #include <Inventor/events/SoButtonEvent.h>
37 
38 #define SO_MOUSE_PRESS_EVENT(EVENT, BUTTON) \
39  (SoMouseButtonEvent::isButtonPressEvent(EVENT, SoMouseButtonEvent::BUTTON))
40 
41 #define SO_MOUSE_RELEASE_EVENT(EVENT, BUTTON) \
42  (SoMouseButtonEvent::isButtonReleaseEvent(EVENT, SoMouseButtonEvent::BUTTON))
43 
44 class COIN_DLL_API SoMouseButtonEvent : public SoButtonEvent {
45  typedef SoButtonEvent inherited;
46 
47  SO_EVENT_HEADER();
48 
49 public:
50  static void initClass(void);
51 
52  SoMouseButtonEvent(void);
53  virtual ~SoMouseButtonEvent();
54 
55  enum Button {
56  ANY, BUTTON1, BUTTON2, BUTTON3, BUTTON4, BUTTON5
57  };
58 
59  void setButton(Button button);
60  Button getButton(void) const;
61 
62  static SbBool isButtonPressEvent(const SoEvent * e, Button whichButton);
63  static SbBool isButtonReleaseEvent(const SoEvent * e, Button whichButton);
64 
65  static SbBool enumToString(Button enumval, SbString & stringrep);
66 
67 private:
68  Button button;
69 
70 }; // SoMouseButtonEvent
71 
72 #endif // !COIN_SOMOUSEBUTTONEVENT_H
The SoButtonEvent class is the base class for all button events.
Definition: SoButtonEvent.h:40
Button
Definition: SoMouseButtonEvent.h:55
static SbBool enumToString(State enumval, SbString &stringrep)
Definition: SoButtonEvent.cpp:130
static void initClass(void)
Definition: SoButtonEvent.cpp:75
The SoEvent class is the base class for all Coin events.
Definition: SoEvent.h:45
The SoMouseButtonEvent class contains information about mousebutton interaction.
Definition: SoMouseButtonEvent.h:44
The SbString class is a string class with convenience functions for string operations.
Definition: SbString.h:52