Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoEventManager.h
1 #ifndef COIN_SOEVENTMANAGER_H
2 #define COIN_SOEVENTMANAGER_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/SbBasic.h>
37 #include <Inventor/tools/SbPimplPtr.h>
38 
39 class SoCamera;
40 class SbVec2s;
41 class SoEvent;
42 class SoNode;
43 class SbViewportRegion;
46 
47 class COIN_DLL_API SoEventManager {
48 public:
49  SoEventManager(void);
50  virtual ~SoEventManager();
51 
55  MIXED_NAVIGATION
56  };
57 
58  virtual void setSceneGraph(SoNode * const sceneroot);
59  virtual SoNode * getSceneGraph(void) const;
60 
61  virtual void setCamera(SoCamera * camera);
62  virtual SoCamera * getCamera(void) const;
63 
64  virtual SbBool processEvent(const SoEvent * const event);
65 
66  virtual void setNavigationState(NavigationState state);
67  virtual NavigationState getNavigationState(void) const;
68 
69  int getNumSoScXMLStateMachines(void) const;
70  SoScXMLStateMachine * getSoScXMLStateMachine(int idx) const;
71  void addSoScXMLStateMachine(SoScXMLStateMachine * sm);
72  void removeSoScXMLStateMachine(SoScXMLStateMachine * sm);
73 
74  virtual void setSize(const SbVec2s & newsize);
75  virtual void setOrigin(const SbVec2s & newOrigin);
76  virtual void setViewportRegion(const SbViewportRegion & newregion);
77  const SbViewportRegion & getViewportRegion(void) const;
78 
79  virtual void setHandleEventAction(SoHandleEventAction * hea);
80  virtual SoHandleEventAction * getHandleEventAction(void) const;
81 
82 protected:
83  virtual SbBool actuallyProcessEvent(const SoEvent * const event);
84 
85 private:
86  class PImpl;
87  SbPimplPtr<PImpl> pimpl;
88 
89  SoEventManager(const SoEventManager & rhs); // N/A
90  SoEventManager & operator = (const SoEventManager & rhs); // N/A
91 
92 }; // SoEventManager
93 
94 #endif // !COIN_SOEVENTMANAGER_H
The SoCamera class is the abstract base class for camera definition nodes.
Definition: SoCamera.h:64
Definition: SoEventManager.h:54
Integration level for using Coin events with SCXML-based state machines.
Definition: SoScXMLStateMachine.h:43
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:56
Definition: SoEventManager.h:53
The SoEventManager class provides event handling for a Coin3D viewer.
Definition: SoEventManager.h:47
NavigationState
Definition: SoEventManager.h:52
The SoHandleEventAction class distributes user events to the scene.
Definition: SoHandleEventAction.h:46
The SoEvent class is the base class for all Coin events.
Definition: SoEvent.h:45
The SbViewportRegion class is a viewport within a full window.
Definition: SbViewportRegion.h:40
The SbVec2s class is a 2 dimensional vector with short integer coordinates.
Definition: SbVec2s.h:51