Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/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 
39 class SoFieldSensor;
40 class SoGroup;
41 class SoSensor;
42 
43 class COIN_DLL_API SoFile : public SoNode {
44  typedef SoNode inherited;
45 
47 
48 public:
49  static void initClass(void);
50  SoFile(void);
51 
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 
75 protected:
76  virtual ~SoFile();
77 
78  virtual SbBool readInstance(SoInput * in, unsigned short flags);
79  virtual SbBool readNamedFile(SoInput * in);
80 
81 private:
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
The SoBase class is the top-level superclass for a number of class-hierarchies.SoBase provides the ba...
Definition: SoBase.h:45
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition: SoNode.cpp:1421
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition: SoNode.cpp:881
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: SoFile.h:52
The SoFieldContainer class is a base class for all classes that contain fields.The classes containing...
Definition: SoFieldContainer.h:43
The SoSearchAction class provides methods for searching through scene graphs.Nodes can be searched fo...
Definition: SoSearchAction.h:44
The SoSFString class is a container for an SbString.This field is used where nodes, engines or other field containers needs to store a single string.
Definition: SoSFString.h:40
virtual void search(SoSearchAction *action)
Definition: SoNode.cpp:1159
The SoPickAction class is the base class for picking actions.The basis for all interaction features t...
Definition: SoPickAction.h:43
The SoNode class is the base class for nodes used in scene graphs.Coin is a retained mode 3D visualiz...
Definition: SoNode.h:56
virtual void audioRender(SoAudioRenderAction *action)
Definition: SoNode.cpp:1294
The SoChildList class is a container for node children.This class does automatic notification on the ...
Definition: SoChildList.h:42
The SoSensor class is the abstract base class for all sensors.Sensors is a mechanism in Coin for sche...
Definition: SoSensor.h:43
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition: SoNode.cpp:1477
virtual void getMatrix(SoGetMatrixAction *action)
Definition: SoNode.cpp:1040
The SoAudioRenderAction class renders the aural parts of the scene graph.Applying this method at a ro...
Definition: SoAudioRenderAction.h:42
The SoAction class is the base class for all traversal actions.Applying actions is the basic mechanis...
Definition: SoAction.h:77
virtual void pick(SoPickAction *action)
Definition: SoNode.cpp:1096
The SoFieldSensor class detects changes to a field.Attach a field to a sensor of this type to put it ...
Definition: SoFieldSensor.h:38
The SoGroup class is a node which managed other node instances.The internal scene data structures in ...
Definition: SoGroup.h:40
virtual void doAction(SoAction *action)
Definition: SoNode.cpp:796
The SoHandleEventAction class distributes user events to the scene.This is the action used by the GUI...
Definition: SoHandleEventAction.h:46
The SoGetPrimitiveCountAction class counts the primitives in a scene.Apply this action to a scene if ...
Definition: SoGetPrimitiveCountAction.h:44
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.If this action is applied to a path or scene graph root, it will calculate the bounding box and the center point of the geometry contained within the scene.
Definition: SoGetBoundingBoxAction.h:45
The SoCallbackAction class invokes callbacks at specific nodes.This action has mechanisms for trackin...
Definition: SoCallbackAction.h:80
The SoInput class is an abstraction of file import functionality.This class takes care of most of the...
Definition: SoInput.h:61
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition: SoNode.cpp:852
The SoFile class is node container for another model file.This node provides a way to split your mode...
Definition: SoFile.h:43
virtual void GLRender(SoGLRenderAction *action)
Definition: SoNode.cpp:941
The SbString class is a string class with convenience functions for string operations.This is the class used for storing and working with character strings. It automatically takes care of supporting all the "bookkeeping" tasks usually associated with working with character strings, like memory allocation and deallocation etc.
Definition: SbString.h:52
virtual void callback(SoCallbackAction *action)
Definition: SoNode.cpp:1013
virtual void handleEvent(SoHandleEventAction *action)
Definition: SoNode.cpp:1070
virtual SoChildList * getChildren(void) const
Definition: SoNode.cpp:1304
The SoGLRenderAction class renders the scene graph with OpenGL calls.Applying this method at a root n...
Definition: SoGLRenderAction.h:50