Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoMouseButtonEvent.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : David Mott (MMM yyyy)
25** Modified by : Gavin Bell (MMM yyyy)
26**=======================================================================*/
27/*=======================================================================
28 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
29 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
30 *** ***
31 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
32 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
33 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
34 *** ***
35 *** RESTRICTED RIGHTS LEGEND ***
36 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
37 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
38 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
39 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
40 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
41 *** ***
42 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
43 *** BORDEAUX, FRANCE ***
44 *** ALL RIGHTS RESERVED ***
45**=======================================================================*/
46/*=======================================================================
47** Modified by : VSG (MMM YYYY)
48**=======================================================================*/
49
50
51#ifndef _SO_MOUSE_BUTTON_EVENT_
52#define _SO_MOUSE_BUTTON_EVENT_
53
54#include <Inventor/SbBasic.h>
55#include <Inventor/events/SoButtonEvent.h>
56
57// some convenience macros for determining if an event matches
58
59#define SO_MOUSE_PRESS_EVENT(EVENT,BUTTON) \
60 (SoMouseButtonEvent::isButtonPressEvent(EVENT,SoMouseButtonEvent::BUTTON))
61
62#define SO_MOUSE_RELEASE_EVENT(EVENT,BUTTON) \
63 (SoMouseButtonEvent::isButtonReleaseEvent(EVENT,SoMouseButtonEvent::BUTTON))
64
65
66
67
105
106 SO_EVENT_HEADER();
107
108 public:
109
111 enum Button {
115 ANY = 0,
127 BUTTON3 = 3
128 };
129
134
135#ifndef HIDDEN_FROM_DOC
136 virtual ~SoMouseButtonEvent();
137#endif // HIDDEN_FROM_DOC
138
142 void setButton(SoMouseButtonEvent::Button b) { button = b; }
146 SoMouseButtonEvent::Button getButton() const { return button; }
147
154 const SoEvent *e,
155 SoMouseButtonEvent::Button whichButton);
156
163 SoMouseButtonEvent::Button whichButton );
164
171 const SoEvent *e,
172 SoMouseButtonEvent::Button whichButton);
173
174 private:
175 static void initClass();
176 static void exitClass();
177
178 private:
179 Button button; // which button
180
181};
182
183
184#endif /* _SO_MOUSE_BUTTON_EVENT_ */
185
Base class for all button events.
Base class for all events.
Definition SoEvent.h:116
Mouse button press and release events.
static SbBool isButtonPressEvent(const SoEvent *e, SoMouseButtonEvent::Button whichButton)
Returns whether the passed event is a mouse button press event of the passed button.
void setButton(SoMouseButtonEvent::Button b)
Sets which mouse button generated the event.
static SbBool isButtonDoubleClickEvent(const SoEvent *e, SoMouseButtonEvent::Button whichButton)
Returns whether the passed event is a mouse button double click event of the passed button.
static SbBool isButtonReleaseEvent(const SoEvent *e, SoMouseButtonEvent::Button whichButton)
Returns whether the passed event is a mouse button release event of the passed button.
@ BUTTON2
Second mouse button.
@ BUTTON1
First mouse button.
@ BUTTON3
Third mouse button.
SoMouseButtonEvent()
Constructor.
SoMouseButtonEvent::Button getButton() const
Gets which mouse button generated the event.
int SbBool
Boolean type.
Definition SbBase.h:87