Coin: SoHandleEventAction.h Source File

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

SoHandleEventAction.h
1#ifndef COIN_SOHANDLEEVENTACTION_H
2#define COIN_SOHANDLEEVENTACTION_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/actions/SoAction.h>
37#include <Inventor/actions/SoSubAction.h>
38
39class SbViewportRegion;
40class SoEvent;
41class SoPickedPoint;
42class SoPickedPointList;
43
44class SoHandleEventActionP;
45
46 class COIN_DLL_API SoHandleEventAction : public SoAction {
47 typedef SoAction inherited;
48
49 SO_ACTION_HEADER(SoHandleEventAction);
50
51public:
52 static void initClass(void);
53
54 SoHandleEventAction(const SbViewportRegion & viewportregion);
55 virtual ~SoHandleEventAction(void);
56
57 void setViewportRegion(const SbViewportRegion & newregion);
58 const SbViewportRegion & getViewportRegion(void) const;
59 void setEvent(const SoEvent * ev);
60 const SoEvent * getEvent(void) const;
61 void setHandled(void);
62 SbBool isHandled(void) const;
63 void setGrabber(SoNode * node);
64 void releaseGrabber(void);
65 SoNode * getGrabber(void) const;
66 void setPickRoot(SoNode * node);
67 SoNode * getPickRoot(void) const;
68 void setPickRadius(const float radiusinpixels);
69 float getPickRadius(void) const;
70 const SoPickedPoint * getPickedPoint(void);
71 const SoPickedPointList & getPickedPointList(void);
72
73protected:
74 virtual void beginTraversal(SoNode * node);
75
76private:
77 SbPimplPtr<SoHandleEventActionP> pimpl;
78
79 // NOT IMPLEMENTED:
80 SoHandleEventAction(const SoHandleEventAction & rhs);
81 SoHandleEventAction & operator = (const SoHandleEventAction & rhs);
82}; // SoHandleEventAction
83
84#ifndef COIN_INTERNAL
85// For SGI / TGS Open Inventor compile-time compatibility.
86#include <Inventor/actions/SoRayPickAction.h>
87#endif // COIN_INTERNAL
88
89#endif // !COIN_SOHANDLEEVENTACTION_H
SbPimplPtr
Definition SbPimplPtr.h:55
SbViewportRegion
The SbViewportRegion class is a viewport within a full window.
Definition SbViewportRegion.h:40
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoAction::initClass
static void initClass(void)
Definition SoAction.cpp:370
SoAction::beginTraversal
virtual void beginTraversal(SoNode *node)
Definition SoAction.cpp:1269
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
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoPickedPointList
The SoPickedPointList class is a container for pointers to SoPickedPoint objects.
Definition SoPickedPointList.h:40
SoPickedPoint
The SoPickedPoint class is used for specifying picked points.
Definition SoPickedPoint.h:48