Coin: SoWWWInline.h Source File

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

SoWWWInline.h
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
42#include <Inventor/actions/SoCallbackAction.h>
43#endif // !COIN_INTERNAL
44
45class SbColor;
46class SoGroup;
47class SoWWWInlineP;
48
49// *************************************************************************
50
51class SoWWWInline;
52typedef 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
60 SO_NODE_HEADER(SoWWWInline);
61
62public:
63 static void initClass(void);
64 SoWWWInline(void);
65
66 SoSFString name;
67 SoSFVec3f bboxCenter;
68 SoSFVec3f bboxSize;
69 SoSFNode alternateRep;
70
71 enum BboxVisibility {
72 NEVER,
73 UNTIL_LOADED,
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
115protected:
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
123private:
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
SbColor
The SbColor class contains the red, green and blue components which make up a color value.
Definition SbColor.h:39
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
SbVec3f
The SbVec3f class is a 3 dimensional vector with floating point coordinates.
Definition SbVec3f.h:51
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoAudioRenderAction
The SoAudioRenderAction class renders the aural parts of the scene graph.
Definition SoAudioRenderAction.h:42
SoCallbackAction
The SoCallbackAction class invokes callbacks at specific nodes.
Definition SoCallbackAction.h:80
SoChildList
The SoChildList class is a container for node children.
Definition SoChildList.h:42
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
SoGLRenderAction
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
SoGetBoundingBoxAction
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition SoGetBoundingBoxAction.h:45
SoGetMatrixAction
The SoGetMatrixAction class is an action for accumulating the transformation matrix of a subgraph.
Definition SoGetMatrixAction.h:46
SoGetPrimitiveCountAction
The SoGetPrimitiveCountAction class counts the primitives in a scene.
Definition SoGetPrimitiveCountAction.h:44
SoGroup
The SoGroup class is a node which managed other node instances.
Definition SoGroup.h:40
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:46
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoNode::getChildren
virtual SoChildList * getChildren(void) const
Definition SoNode.cpp:1366
SoNode::getPrimitiveCount
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition SoNode.cpp:943
SoNode::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoNode.cpp:1132
SoNode::getBoundingBox
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition SoNode.cpp:914
SoNode::audioRender
virtual void audioRender(SoAudioRenderAction *action)
Definition SoNode.cpp:1356
SoNode::doAction
virtual void doAction(SoAction *action)
Definition SoNode.cpp:858
SoNode::callback
virtual void callback(SoCallbackAction *action)
Definition SoNode.cpp:1075
SoNode::getMatrix
virtual void getMatrix(SoGetMatrixAction *action)
Definition SoNode.cpp:1102
SoNode::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoNode.cpp:1542
SoNode::copyContents
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition SoNode.cpp:1483
SoNode::pick
virtual void pick(SoPickAction *action)
Definition SoNode.cpp:1158
SoNode::search
virtual void search(SoSearchAction *action)
Definition SoNode.cpp:1221
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoNode::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoNode.cpp:1003
SoPickAction
The SoPickAction class is the base class for picking actions.
Definition SoPickAction.h:43
SoSFNode
The SoSFNode class is a container for a single node.
Definition SoSFNode.h:47
SoSFString
The SoSFString class is a container for an SbString.
Definition SoSFString.h:40
SoSFVec3f
The SoSFVec3f class is a container for an SbVec3f vector.
Definition SoSFVec3f.h:40
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44
SoWWWInline
The SoWWWInline class is a node used to include data from an URL.
Definition SoWWWInline.h:57
SoWWWInline::name
SoSFString name
Definition SoWWWInline.h:66
SoWWWInline::BboxVisibility
BboxVisibility
Definition SoWWWInline.h:71
SoWWWInline::NEVER
@ NEVER
Definition SoWWWInline.h:72
SoWWWInline::UNTIL_LOADED
@ UNTIL_LOADED
Definition SoWWWInline.h:73
SoWWWInline::alternateRep
SoSFNode alternateRep
Definition SoWWWInline.h:69
SoWWWInline::bboxCenter
SoSFVec3f bboxCenter
Definition SoWWWInline.h:67
SoWWWInline::bboxSize
SoSFVec3f bboxSize
Definition SoWWWInline.h:68