Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoWWWInline.h
Go to the documentation of this file.
1 #ifndef COIN_SOWWWINLINE_H
2 #define COIN_SOWWWINLINE_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/nodes/SoSubNode.h>
37 #include <Inventor/fields/SoSFString.h>
38 #include <Inventor/fields/SoSFVec3f.h>
39 #include <Inventor/fields/SoSFNode.h>
40 
41 #ifndef COIN_INTERNAL
43 #endif // !COIN_INTERNAL
44 
45 class SbColor;
46 class SoGroup;
47 class SoWWWInlineP;
48 
49 // *************************************************************************
50 
51 class SoWWWInline;
52 typedef void SoWWWInlineFetchURLCB(const SbString & url, void * userData,
53  SoWWWInline * node);
54 
55 // *************************************************************************
56 
57 class COIN_DLL_API SoWWWInline : public SoNode {
58  typedef SoNode inherited;
59 
61 
62 public:
63  static void initClass(void);
64  SoWWWInline(void);
65 
70 
74  ALWAYS
75  };
76 
77  void setFullURLName(const SbString & url);
78  const SbString & getFullURLName(void);
79 
80  SoGroup * copyChildren(void) const;
81 
82  void requestURLData(void);
83  SbBool isURLDataRequested(void) const;
84  SbBool isURLDataHere(void) const;
85  void cancelURLDataRequest(void);
86 
87  void setChildData(SoNode * urldata);
88  SoNode * getChildData(void) const;
89 
90  virtual SoChildList * getChildren(void) const;
91 
92  static void setFetchURLCallBack(SoWWWInlineFetchURLCB * f, void * userdata);
93 
94  static void setBoundingBoxVisibility(BboxVisibility b);
95  static BboxVisibility getBoundingBoxVisibility(void);
96 
97  static void setBoundingBoxColor(SbColor & c);
98  static const SbColor & getBoundingBoxColor(void);
99 
100  static void setReadAsSoFile(SbBool onoff);
101  static SbBool getReadAsSoFile(void);
102 
103  virtual void doAction(SoAction * action);
104  virtual void doActionOnKidsOrBox(SoAction * action);
105  virtual void callback(SoCallbackAction * action);
106  virtual void GLRender(SoGLRenderAction * action);
107  virtual void getBoundingBox(SoGetBoundingBoxAction * action);
108  virtual void getMatrix(SoGetMatrixAction * action);
109  virtual void handleEvent(SoHandleEventAction * action);
110  virtual void search(SoSearchAction * action);
111  virtual void pick(SoPickAction * action);
112  virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
113  virtual void audioRender(SoAudioRenderAction * action);
114 
115 protected:
116  virtual ~SoWWWInline();
117 
118  virtual void addBoundingBoxChild(SbVec3f center, SbVec3f size);
119  virtual SbBool readInstance(SoInput * in, unsigned short flags);
120  virtual void copyContents(const SoFieldContainer * fromfC,
121  SbBool copyconnections);
122 
123 private:
124  friend class SoWWWInlineP;
125  static SoWWWInlineFetchURLCB * fetchurlcb;
126  static void * fetchurlcbdata;
127  static SbBool readassofile;
128  static SbColor * bboxcolor;
129  static BboxVisibility bboxvisibility;
130 
131  static void cleanup(void);
132 
133  SoWWWInlineP * pimpl;
134 };
135 
136 #endif // !COIN_SOWWWINLINE_H
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition: SoBase.h:45
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition: SoNode.cpp:1434
The SbColor class contains the red, green and blue components which make up a color value...
Definition: SbColor.h:39
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition: SoNode.cpp:894
The SoGetMatrixAction class is an action for accumulating the transformation matrix of a subgraph...
Definition: SoGetMatrixAction.h:46
#define SO_NODE_HEADER(classname)
SoSFString name
Definition: SoWWWInline.h:66
The SoFieldContainer class is a base class for all classes that contain fields.
Definition: SoFieldContainer.h:43
The SoSearchAction class provides methods for searching through scene graphs.
Definition: SoSearchAction.h:44
Definition: SoWWWInline.h:73
The SoSFString class is a container for an SbString.
Definition: SoSFString.h:40
virtual void search(SoSearchAction *action)
Definition: SoNode.cpp:1172
SoSFVec3f bboxSize
Definition: SoWWWInline.h:68
The SoPickAction class is the base class for picking actions.
Definition: SoPickAction.h:43
Definition: SoWWWInline.h:72
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:56
virtual void audioRender(SoAudioRenderAction *action)
Definition: SoNode.cpp:1307
The SoChildList class is a container for node children.
Definition: SoChildList.h:42
The SoSFNode class is a container for a single node.
Definition: SoSFNode.h:47
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition: SoNode.cpp:1490
virtual void getMatrix(SoGetMatrixAction *action)
Definition: SoNode.cpp:1053
BboxVisibility
Definition: SoWWWInline.h:71
The SoAudioRenderAction class renders the aural parts of the scene graph.
Definition: SoAudioRenderAction.h:42
The SoAction class is the base class for all traversal actions.
Definition: SoAction.h:77
virtual void pick(SoPickAction *action)
Definition: SoNode.cpp:1109
The SbVec3f class is a 3 dimensional vector with floating point coordinates.
Definition: SbVec3f.h:51
The SoGroup class is a node which managed other node instances.
Definition: SoGroup.h:40
virtual void doAction(SoAction *action)
Definition: SoNode.cpp:809
The SoHandleEventAction class distributes user events to the scene.
Definition: SoHandleEventAction.h:46
The SoGetPrimitiveCountAction class counts the primitives in a scene.
Definition: SoGetPrimitiveCountAction.h:44
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition: SoGetBoundingBoxAction.h:45
The SoCallbackAction class invokes callbacks at specific nodes.
Definition: SoCallbackAction.h:80
The SoWWWInline class is a node used to include data from an URL.
Definition: SoWWWInline.h:57
SoSFVec3f bboxCenter
Definition: SoWWWInline.h:67
The SoInput class is an abstraction of file import functionality.
Definition: SoInput.h:61
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition: SoNode.cpp:865
The SoSFVec3f class is a container for an SbVec3f vector.
Definition: SoSFVec3f.h:40
SoSFNode alternateRep
Definition: SoWWWInline.h:69
virtual void GLRender(SoGLRenderAction *action)
Definition: SoNode.cpp:954
The SbString class is a string class with convenience functions for string operations.
Definition: SbString.h:52
virtual void callback(SoCallbackAction *action)
Definition: SoNode.cpp:1026
virtual void handleEvent(SoHandleEventAction *action)
Definition: SoNode.cpp:1083
virtual SoChildList * getChildren(void) const
Definition: SoNode.cpp:1317
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition: SoGLRenderAction.h:50