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 
40 class SbVec2f;
41 class SbVec3f;
42 class SbRotation;
43 class SoCamera;
44 class ScXMLEvent;
45 class ScXMLStateMachine;
46 class 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 
54 public:
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 
63 protected:
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 
83 private:
84   class PImpl;
85   SbPimplPtr<PImpl> pimpl;
86 
87 }; // SoScXMLNavigationTarget
88 
89 #endif // !COIN_SOSCXMLNAVIGATIONTARGET_H
90