Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoVRMLInline.h
Go to the documentation of this file.
1 /**************************************************************************\
2  * Copyright (c) Kongsberg Oil & Gas Technologies AS
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  * Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 \**************************************************************************/
32 
33 #ifndef COIN_SOVRMLINLINE_H
34 #define COIN_SOVRMLINLINE_H
35 
36 #include <Inventor/nodes/SoSubNode.h>
37 #include <Inventor/nodes/SoNode.h>
38 #include <Inventor/fields/SoSFVec3f.h>
39 #include <Inventor/fields/SoMFString.h>
40 
41 #ifndef COIN_INTERNAL
43 #endif // !COIN_INTERNAL
44 
45 class SbColor;
46 class SoVRMLInline;
47 class SoVRMLInlineP;
48 class SoGroup;
49 class SoSensor;
50 
51 typedef void SoVRMLInlineFetchURLCB(const SbString &, void *, SoVRMLInline *);
52 
53 class COIN_DLL_API SoVRMLInline : public SoNode
54 {
55  typedef SoNode inherited;
57 
58 public:
59  static void initClass(void);
60  SoVRMLInline(void);
61 
65  ALWAYS
66  };
67 
68  SoSFVec3f bboxCenter;
69  SoSFVec3f bboxSize;
70  SoMFString url;
71 
72  void setFullURLName(const SbString & url);
73  const SbString & getFullURLName(void);
74 
75  SoGroup * copyChildren(void) const;
76  void requestURLData(void);
77  SbBool isURLDataRequested(void) const;
78  SbBool isURLDataHere(void) const;
79 
80  void cancelURLDataRequest(void);
81  void setChildData(SoNode * urlData);
82  SoNode * getChildData(void) const;
83 
84  static void setFetchURLCallBack(SoVRMLInlineFetchURLCB * f, void * closure);
85  static void setBoundingBoxVisibility(BboxVisibility b);
86  static BboxVisibility getBoundingBoxVisibility(void);
87  static void setBoundingBoxColor(SbColor & color);
88  static SbColor & getBoundingBoxColor(void);
89  static void setReadAsSoFile(SbBool enable);
90  static SbBool getReadAsSoFile(void);
91 
92  virtual void doAction(SoAction * action);
93  virtual void callback(SoCallbackAction * action);
94  virtual void GLRender(SoGLRenderAction * action);
95  virtual void getBoundingBox(SoGetBoundingBoxAction * action);
96  virtual void getMatrix(SoGetMatrixAction * action);
97  virtual void handleEvent(SoHandleEventAction * action);
98  virtual void search(SoSearchAction * action);
99  virtual void pick(SoPickAction * action);
100  virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
101  virtual SoChildList * getChildren(void) const;
102 
103 protected:
104  virtual ~SoVRMLInline();
105 
106 private:
107  virtual void addBoundingBoxChild(SbVec3f center, SbVec3f size);
108  virtual SbBool readInstance(SoInput * in, unsigned short flags);
109  virtual void copyContents(const SoFieldContainer * from, SbBool copyconn);
110  virtual SbBool readLocalFile(SoInput * in);
111 
112  static void urlFieldModified(void * userdata, SoSensor * sensor);
113 
114  SoVRMLInlineP * pimpl;
115 };
116 
117 #endif // ! COIN_SOVRMLINLINE_H
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)
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
virtual void search(SoSearchAction *action)
Definition: SoNode.cpp:1172
The SoPickAction class is the base class for picking actions.
Definition: SoPickAction.h:43
Definition: SoVRMLInline.h:63
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:56
The SoChildList class is a container for node children.
Definition: SoChildList.h:42
The SoSensor class is the abstract base class for all sensors.
Definition: SoSensor.h:43
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition: SoNode.cpp:1490
virtual void getMatrix(SoGetMatrixAction *action)
Definition: SoNode.cpp:1053
The SoAction class is the base class for all traversal actions.
Definition: SoAction.h:77
The SoMFString class is a container for SbString values.
Definition: SoMFString.h:40
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 SoVRMLInline class is used to insert VRML files into a scene.
Definition: SoVRMLInline.h:53
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 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
Definition: SoVRMLInline.h:64
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
BboxVisibility
Definition: SoVRMLInline.h:62
virtual SoChildList * getChildren(void) const
Definition: SoNode.cpp:1317
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition: SoGLRenderAction.h:50