Coin Logo http://www.sim.no/
http://www.coin3d.org/

SoEventCallback.h
1#ifndef COIN_SOEVENTCALLBACK_H
2#define COIN_SOEVENTCALLBACK_H
3
4/**************************************************************************\
5 *
6 * This file is part of the Coin 3D visualization library.
7 * Copyright (C) by Kongsberg Oil & Gas Technologies.
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * ("GPL") version 2 as published by the Free Software Foundation.
12 * See the file LICENSE.GPL at the root directory of this source
13 * distribution for additional information about the GNU GPL.
14 *
15 * For using Coin with software that can not be combined with the GNU
16 * GPL, and for taking advantage of the additional benefits of our
17 * support services, please contact Kongsberg Oil & Gas Technologies
18 * about acquiring a Coin Professional Edition License.
19 *
20 * See http://www.coin3d.org/ for more information.
21 *
22 * Kongsberg Oil & Gas Technologies, Bygdoy Alle 5, 0257 Oslo, NORWAY.
23 * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
24 *
25\**************************************************************************/
26
27#include <Inventor/nodes/SoSubNode.h>
28#include <Inventor/lists/SbList.h>
29
30#ifndef COIN_INTERNAL
31// Added for Inventor compliance
32#include <Inventor/actions/SoHandleEventAction.h>
33#endif // !COIN_INTERNAL
34
35class SoEventCallback;
36class SoPath;
37class SoEvent;
38class SoPickedPoint;
40
41typedef void SoEventCallbackCB(void * userdata, SoEventCallback * node);
42
43class COIN_DLL_API SoEventCallback : public SoNode {
44 typedef SoNode inherited;
45
47
48public:
49 static void initClass(void);
50 SoEventCallback(void);
51
52 void setPath(SoPath * path);
53 const SoPath * getPath(void);
54
55 void addEventCallback(SoType eventtype, SoEventCallbackCB * f,
56 void * userdata = NULL);
57 void removeEventCallback(SoType eventtype, SoEventCallbackCB * f,
58 void * userdata = NULL);
59
60 SoHandleEventAction * getAction(void) const;
61 const SoEvent * getEvent(void) const;
62 const SoPickedPoint * getPickedPoint(void) const;
63
64 void setHandled(void);
65 SbBool isHandled(void) const;
66
67 void grabEvents(void);
68 void releaseEvents(void);
69
70protected:
71 virtual ~SoEventCallback();
72
73 virtual void handleEvent(SoHandleEventAction * action);
74
75private:
76
77 struct CallbackInfo {
78 SoEventCallbackCB * func;
79 SoType eventtype;
80 void * userdata;
81
82 // AIX native compiler xlC needs equality and inequality operators
83 // to compile templates where these operators are referenced (even
84 // if they are actually never used).
85
86 SbBool operator==(const CallbackInfo & cbi) {
87 return this->func == cbi.func && this->eventtype == cbi.eventtype && this->userdata == cbi.userdata;
88 }
89 SbBool operator!=(const CallbackInfo & cbi) {
90 return !(*this == cbi);
91 }
92 };
93
94 SbList<CallbackInfo> callbacks;
95 SoHandleEventAction * heaction;
96 SoPath * path;
97
98};
99
100#endif // !COIN_SOEVENTCALLBACK_H
The SbList class is a template container class for lists.
Definition SbList.h:61
The SoEventCallback class provides functionality for catching events.
Definition SoEventCallback.h:43
The SoEvent class is the base class for all Coin events.
Definition SoEvent.h:34
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:37
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:47
virtual void handleEvent(SoHandleEventAction *action)
Definition SoNode.cpp:1059
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:43
The SoPickedPoint class is used for specifying picked points.
Definition SoPickedPoint.h:39
The SoType class is the basis for the run-time type system in Coin.
Definition SoType.h:50
#define SO_NODE_HEADER(classname)
Definition macros.dox:43

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on Wed Jul 17 2024 for Coin by Doxygen 1.12.0.