Coin: SoScXMLNavigationTarget.h Source File

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

SoScXMLNavigationTarget.h
1#ifndef COIN_SOSCXMLNAVIGATIONTARGET_H
2#define COIN_SOSCXMLNAVIGATIONTARGET_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/ScXMLEventTarget.h>
37
38#include <Inventor/tools/SbPimplPtr.h>
39
40class SbVec2f;
41class SbVec3f;
42class SbRotation;
43class SoCamera;
44class ScXMLEvent;
45class ScXMLStateMachine;
46class SoScXMLStateMachine;
47
48#define COIN_NAVIGATION_EVENT_PREFIX "x-coin-navigation"
49
50 class COIN_DLL_API SoScXMLNavigationTarget : public ScXMLEventTarget {
51 typedef ScXMLEventTarget inherited;
52 SCXML_OBJECT_ABSTRACT_HEADER(SoScXMLNavigationTarget)
53
54public:
55 static void initClass(void);
56 static void cleanClass(void);
57
58 class COIN_DLL_API Data { // virtual base for subclasses using getSessionData()...
59 public:
60 virtual ~Data(void);
61 };
62
63protected:
64 SoScXMLNavigationTarget(void);
65 virtual ~SoScXMLNavigationTarget(void);
66
67 typedef Data * NewDataFunc(void);
68 Data * getSessionData(SbName sessionid, NewDataFunc * constructor);
69 void freeSessionData(SbName sessionid);
70
71 static SbName getSessionId(const ScXMLEvent * event);
72 static ScXMLStateMachine * getStateMachine(const ScXMLEvent * event, SbName sessionid);
73 static SoScXMLStateMachine * getSoStateMachine(const ScXMLEvent * event, SbName sessionid);
74 static SoCamera * getActiveCamera(const ScXMLEvent * event, SbName sessionid);
75
76 static SbBool getEventDouble(const ScXMLEvent * event, const char * label, double & dbl_out, SbBool required = TRUE);
77 static SbBool getEventString(const ScXMLEvent * event, const char * label, SbString & str_out, SbBool required = TRUE);
78 static SbBool getEventSbBool(const ScXMLEvent * event, const char * label, SbBool & bool_out, SbBool required = TRUE);
79 static SbBool getEventSbVec2f(const ScXMLEvent * event, const char * label, SbVec2f & vec_out, SbBool required = TRUE);
80 static SbBool getEventSbVec3f(const ScXMLEvent * event, const char * label, SbVec3f & vec_out, SbBool required = TRUE);
81 static SbBool getEventSbRotation(const ScXMLEvent * event, const char * label, SbRotation & rot_out, SbBool required = TRUE);
82
83private:
84 class PImpl;
85 SbPimplPtr<PImpl> pimpl;
86
87}; // SoScXMLNavigationTarget
88
89#endif // !COIN_SOSCXMLNAVIGATIONTARGET_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SbPimplPtr
Definition SbPimplPtr.h:55
SbRotation
The SbRotation class represents a rotation in 3D space.
Definition SbRotation.h:44
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
SbVec2f
The SbVec2f class is a 2 dimensional vector with floating point coordinates.
Definition SbVec2f.h:49
SbVec3f
The SbVec3f class is a 3 dimensional vector with floating point coordinates.
Definition SbVec3f.h:51
ScXMLEvent
Base class for events sent to SCXML state machines.
Definition ScXMLEvent.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
ScXMLStateMachine
Manager for processing events and setting states in SCXML structures.
Definition ScXMLStateMachine.h:61
SoCamera
The SoCamera class is the abstract base class for camera definition nodes.
Definition SoCamera.h:64
SoScXMLNavigationTarget::Data
Definition SoScXMLNavigationTarget.h:58
SoScXMLNavigationTarget::getEventSbRotation
static SbBool getEventSbRotation(const ScXMLEvent *event, const char *label, SbRotation &rot_out, SbBool required=TRUE)
Definition SoScXMLNavigationTarget.cpp:446
SoScXMLNavigationTarget::getSoStateMachine
static SoScXMLStateMachine * getSoStateMachine(const ScXMLEvent *event, SbName sessionid)
Definition SoScXMLNavigationTarget.cpp:207
SoScXMLNavigationTarget::freeSessionData
void freeSessionData(SbName sessionid)
Definition SoScXMLNavigationTarget.cpp:145
SoScXMLNavigationTarget::getEventSbVec3f
static SbBool getEventSbVec3f(const ScXMLEvent *event, const char *label, SbVec3f &vec_out, SbBool required=TRUE)
Definition SoScXMLNavigationTarget.cpp:409
SoScXMLNavigationTarget::getEventString
static SbBool getEventString(const ScXMLEvent *event, const char *label, SbString &str_out, SbBool required=TRUE)
Definition SoScXMLNavigationTarget.cpp:286
SoScXMLNavigationTarget::getEventSbBool
static SbBool getEventSbBool(const ScXMLEvent *event, const char *label, SbBool &bool_out, SbBool required=TRUE)
Definition SoScXMLNavigationTarget.cpp:335
SoScXMLNavigationTarget::getEventDouble
static SbBool getEventDouble(const ScXMLEvent *event, const char *label, double &dbl_out, SbBool required=TRUE)
Definition SoScXMLNavigationTarget.cpp:249
SoScXMLNavigationTarget::getSessionData
Data * getSessionData(SbName sessionid, NewDataFunc *constructor)
Definition SoScXMLNavigationTarget.cpp:122
SoScXMLNavigationTarget::getStateMachine
static ScXMLStateMachine * getStateMachine(const ScXMLEvent *event, SbName sessionid)
Definition SoScXMLNavigationTarget.cpp:188
SoScXMLNavigationTarget::getActiveCamera
static SoCamera * getActiveCamera(const ScXMLEvent *event, SbName sessionid)
Definition SoScXMLNavigationTarget.cpp:228
SoScXMLNavigationTarget::getSessionId
static SbName getSessionId(const ScXMLEvent *event)
Definition SoScXMLNavigationTarget.cpp:163
SoScXMLNavigationTarget::getEventSbVec2f
static SbBool getEventSbVec2f(const ScXMLEvent *event, const char *label, SbVec2f &vec_out, SbBool required=TRUE)
Definition SoScXMLNavigationTarget.cpp:372
SoScXMLStateMachine
Integration level for using Coin events with SCXML-based state machines.
Definition SoScXMLStateMachine.h:43