Coin: SoFile.h Source File

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

SoFile.h
1#ifndef COIN_SOFILE_H
2#define COIN_SOFILE_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
39class SoFieldSensor;
40class SoGroup;
41class SoSensor;
42
43 class COIN_DLL_API SoFile : public SoNode {
44 typedef SoNode inherited;
45
46 SO_NODE_HEADER(SoFile);
47
48public:
49 static void initClass(void);
50 SoFile(void);
51
52 SoSFString name;
53
54 virtual void doAction(SoAction * action);
55 virtual void callback(SoCallbackAction * action);
56 virtual void GLRender(SoGLRenderAction * action);
57 virtual void getBoundingBox(SoGetBoundingBoxAction * action);
58 virtual void getMatrix(SoGetMatrixAction * action);
59 virtual void handleEvent(SoHandleEventAction * action);
60 virtual void pick(SoPickAction * action);
61 virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
62 virtual void audioRender(SoAudioRenderAction * action);
63 virtual void search(SoSearchAction * action);
64
65 SoGroup * copyChildren(void) const;
66 virtual SoChildList * getChildren(void) const;
67 virtual void copyContents(const SoFieldContainer * from,
68 SbBool copyconnections);
69
70 const SbString & getFullName(void) const;
71
72 static void setSearchOK(SbBool dosearch);
73 static SbBool getSearchOK();
74
75protected:
76 virtual ~SoFile();
77
78 virtual SbBool readInstance(SoInput * in, unsigned short flags);
79 virtual SbBool readNamedFile(SoInput * in);
80
81private:
82 static void nameFieldModified(void * userdata, SoSensor * sensor);
83
84 SoChildList * children;
85 SoFieldSensor * namesensor;
86 SbString fullname;
87};
88
89#endif // !COIN_SOFILE_H
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
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::SoFieldContainer
SoFieldContainer(void)
Definition SoFieldContainer.cpp:133
SoFieldSensor
The SoFieldSensor class detects changes to a field.
Definition SoFieldSensor.h:38
SoFile::getSearchOK
static SbBool getSearchOK()
Definition SoFile.cpp:469
SoFile::readNamedFile
virtual SbBool readNamedFile(SoInput *in)
Definition SoFile.cpp:223
SoFile::SoFile
SoFile(void)
Definition SoFile.cpp:107
SoFile::setSearchOK
static void setSearchOK(SbBool dosearch)
Definition SoFile.cpp:460
SoFile::name
SoSFString name
Definition SoFile.h:52
SoFile::getFullName
const SbString & getFullName(void) const
Definition SoFile.cpp:148
SoFile::copyChildren
SoGroup * copyChildren(void) const
Definition SoFile.cpp:342
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::getChildren
virtual SoChildList * getChildren(void) const
Definition SoNode.cpp:1366
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
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
SoSFString
The SoSFString class is a container for an SbString.
Definition SoSFString.h:40
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44
SoSensor
The SoSensor class is the abstract base class for all sensors.
Definition SoSensor.h:43
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
Definition Coin_macros.dox:50