SoEventCallback.h Source File

| http://www.sim.no/ http://www.coin3d.org/

- Main Page
- Related Pages
- Modules
- Classes
- Files

- File List
- File Members

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
35 class SoEventCallback;
36 class SoPath;
37 class SoEvent;
38 class SoPickedPoint;
39 class SoHandleEventAction;
40
41 typedef void SoEventCallbackCB(void * userdata, SoEventCallback * node);
42
43 class COIN_DLL_API SoEventCallback : public SoNode {
44 typedef SoNode inherited;
45
46 SO_NODE_HEADER(SoEventCallback);
47
48 public:
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
70 protected:
71 virtual ~SoEventCallback();
72
73 virtual void handleEvent(SoHandleEventAction * action);
74
75 private:
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
SoBase
The SoBase class is the top-level superclass for a number of class-hierarchies.SoBase provides the ba...
Definition: SoBase.h:36
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
SbList< CallbackInfo >
SoNode
The SoNode class is the base class for nodes used in scene graphs.Coin is a retained mode 3D visualiz...
Definition: SoNode.h:47
SoPath
The SoPath class is a container class for traversal path descriptions.SoPath objects contain a list o...
Definition: SoPath.h:43
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.This is the action used by the GUI...
Definition: SoHandleEventAction.h:37
SoPickedPoint
The SoPickedPoint class is used for specifying picked points.It holds miscellaneous information about...
Definition: SoPickedPoint.h:39
SoEventCallback
The SoEventCallback class provides functionality for catching events.Use SoEventCallback nodes in the...
Definition: SoEventCallback.h:43
SoEvent
The SoEvent class is the base class for all Coin events.Coin contains its own set of event classes...
Definition: SoEvent.h:34
SoType
The SoType class is the basis for the run-time type system in Coin.Many of the classes in the Coin li...
Definition: SoType.h:50
SoNode::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition: SoNode.cpp:1059

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