Coin: SoEventCallback.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoEventCallback.h
1#ifndef COIN_SOEVENTCALLBACK_H
2#define COIN_SOEVENTCALLBACK_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/nodes/SoSubNode.h>
37#include <Inventor/lists/SbList.h>
38
39#ifndef COIN_INTERNAL
40// Added for Inventor compliance
41#include <Inventor/actions/SoHandleEventAction.h>
42#endif // !COIN_INTERNAL
43
44class SoEventCallback;
45class SoPath;
46class SoEvent;
47class SoPickedPoint;
48class SoHandleEventAction;
49
50typedef void SoEventCallbackCB(void * userdata, SoEventCallback * node);
51
52 class COIN_DLL_API SoEventCallback : public SoNode {
53 typedef SoNode inherited;
54
55 SO_NODE_HEADER(SoEventCallback);
56
57public:
58 static void initClass(void);
59 SoEventCallback(void);
60
61 void setPath(SoPath * path);
62 const SoPath * getPath(void);
63
64 void addEventCallback(SoType eventtype, SoEventCallbackCB * f,
65 void * userdata = NULL);
66 void removeEventCallback(SoType eventtype, SoEventCallbackCB * f,
67 void * userdata = NULL);
68
69 SoHandleEventAction * getAction(void) const;
70 const SoEvent * getEvent(void) const;
71 const SoPickedPoint * getPickedPoint(void) const;
72
73 void setHandled(void);
74 SbBool isHandled(void) const;
75
76 void grabEvents(void);
77 void releaseEvents(void);
78
79protected:
80 virtual ~SoEventCallback();
81
82 virtual void handleEvent(SoHandleEventAction * action);
83
84private:
85
86 struct CallbackInfo {
87 SoEventCallbackCB * func;
88 SoType eventtype;
89 void * userdata;
90
91 // AIX native compiler xlC needs equality and inequality operators
92 // to compile templates where these operators are referenced (even
93 // if they are actually never used).
94
95 SbBool operator==(const CallbackInfo & cbi) {
96 return this->func == cbi.func && this->eventtype == cbi.eventtype && this->userdata == cbi.userdata;
97 }
98 SbBool operator!=(const CallbackInfo & cbi) {
99 return !(*this == cbi);
100 }
101 };
102
103 SbList<CallbackInfo> callbacks;
104 SoHandleEventAction * heaction;
105 SoPath * path;
106
107};
108
109#endif // !COIN_SOEVENTCALLBACK_H
SbList
The SbList class is a template container class for lists.
Definition SbList.h:70
SoEventCallback
The SoEventCallback class provides functionality for catching events.
Definition SoEventCallback.h:52
SoEventCallback::removeEventCallback
void removeEventCallback(SoType eventtype, SoEventCallbackCB *f, void *userdata=NULL)
Definition SoEventCallback.cpp:192
SoEventCallback::getPath
const SoPath * getPath(void)
Definition SoEventCallback.cpp:165
SoEventCallback::getEvent
const SoEvent * getEvent(void) const
Definition SoEventCallback.cpp:230
SoEventCallback::isHandled
SbBool isHandled(void) const
Definition SoEventCallback.cpp:282
SoEventCallback::setHandled
void setHandled(void)
Definition SoEventCallback.cpp:264
SoEventCallback::addEventCallback
void addEventCallback(SoType eventtype, SoEventCallbackCB *f, void *userdata=NULL)
Definition SoEventCallback.cpp:177
SoEventCallback::releaseEvents
void releaseEvents(void)
Definition SoEventCallback.cpp:320
SoEventCallback::getPickedPoint
const SoPickedPoint * getPickedPoint(void) const
Definition SoEventCallback.cpp:242
SoEventCallback::grabEvents
void grabEvents(void)
Definition SoEventCallback.cpp:301
SoEventCallback::getAction
SoHandleEventAction * getAction(void) const
Definition SoEventCallback.cpp:216
SoEventCallback::SoEventCallback
SoEventCallback(void)
Definition SoEventCallback.cpp:106
SoEventCallback::setPath
void setPath(SoPath *path)
Definition SoEventCallback.cpp:141
SoEvent
The SoEvent class is the base class for all Coin events.
Definition SoEvent.h:45
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:46
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoNode.cpp:1132
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoPickedPoint
The SoPickedPoint class is used for specifying picked points.
Definition SoPickedPoint.h:48
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
Definition Coin_macros.dox:50