Coin: SoScXMLStateMachine.h Source File

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

SoScXMLStateMachine.h
1#ifndef COIN_SOSCXMLSTATEMACHINE_H
2#define COIN_SOSCXMLSTATEMACHINE_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/scxml/ScXMLStateMachine.h>
37
38class SoEvent;
39class SoNode;
40class SoCamera;
41class SbViewportRegion;
42
43 class COIN_DLL_API SoScXMLStateMachine : public ScXMLStateMachine {
44 typedef ScXMLStateMachine inherited;
45 SCXML_OBJECT_HEADER(SoScXMLStateMachine)
46
47public:
48 static void initClass(void);
49 static void cleanClass(void);
50
51 SoScXMLStateMachine(void);
52 virtual ~SoScXMLStateMachine(void);
53
54 virtual void setSceneGraphRoot(SoNode * root);
55 virtual SoNode * getSceneGraphRoot(void) const;
56
57 virtual void setActiveCamera(SoCamera * camera);
58 virtual SoCamera * getActiveCamera(void) const;
59
60 virtual void setViewportRegion(const SbViewportRegion & vp);
61 virtual const SbViewportRegion & getViewportRegion(void) const;
62
63 virtual void preGLRender(void);
64 virtual void postGLRender(void);
65
66 virtual SbBool processSoEvent(const SoEvent * event);
67
68 virtual const char * getVariable(const char * key) const;
69
70private:
71 SoScXMLStateMachine(const SoScXMLStateMachine & rhs); // N/A
72 SoScXMLStateMachine & operator = (const SoScXMLStateMachine & rhs); // N/A
73
74 class PImpl;
75 SbPimplPtr<PImpl> pimpl;
76
77}; // SoScXMLStateMachine
78
79#endif // !COIN_SOSCXMLSTATEMACHINE_H
SbPimplPtr
Definition SbPimplPtr.h:55
SbViewportRegion
The SbViewportRegion class is a viewport within a full window.
Definition SbViewportRegion.h:40
ScXMLObject::cleanClass
static void cleanClass(void)
Does the opposite of initClass, deallocates any class specific resources and resets the class to an u...
Definition ScXMLObject.cpp:115
ScXMLObject::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition ScXMLObject.cpp:102
SoCamera
The SoCamera class is the abstract base class for camera definition nodes.
Definition SoCamera.h:64
SoEvent
The SoEvent class is the base class for all Coin events.
Definition SoEvent.h:45
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoScXMLStateMachine::getVariable
virtual const char * getVariable(const char *key) const
Definition SoScXMLStateMachine.cpp:187
SoScXMLStateMachine::processSoEvent
virtual SbBool processSoEvent(const SoEvent *event)
Definition SoScXMLStateMachine.cpp:166