Coin: SoBaseKit.h Source File

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

SoBaseKit.h
1#ifndef COIN_SOBASEKIT_H
2#define COIN_SOBASEKIT_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/nodekits/SoSubKit.h>
37#include <Inventor/nodes/SoNode.h>
38#ifdef COIN_INTERNAL
39class SoNodeKitPath;
40#else // !COIN_INTERNAL
41// Include these header files for better Open Inventor compatibility.
42#include <Inventor/SoNodeKitPath.h>
43#include <Inventor/misc/SoChildList.h>
44#endif // !COIN_INTERNAL
45
46class SoGroup;
47class SoNodekitParts;
48class SoNodekitCatalog;
49class SoPath;
50
51// Convenience macros. FIXME: document. 20000113 mortene.
52
53#define SO_GET_PART(_kit_, _name_, _classname_) \
54 ((_classname_ *)_kit_->getPart(_name_, TRUE))
55
56#define SO_CHECK_PART(_kit_, _name_, _classname_) \
57 (static_cast<_classname_ *>(_kit_->getPart(_name_, FALSE)))
58
59#define SO_GET_ANY_PART(_kit_, _name_, _classname_) \
60 (static_cast<_classname_ *>(_kit_->getAnyPart(_name_, TRUE, FALSE, FALSE)))
61
62#define SO_CHECK_ANY_PART(_kit_, _name_, _classname_) \
63 (static_cast<_classname_ *>(_kit_->getAnyPart(_name_, FALSE, FALSE, FALSE)))
64
65
66 class COIN_DLL_API SoBaseKit : public SoNode {
67 typedef SoNode inherited;
68
69 SO_NODE_HEADER(SoBaseKit);
70
71 SO_KIT_CATALOG_ENTRY_HEADER(callbackList);
72
73public:
74 static void initClass(void);
75 SoBaseKit(void);
76
77 static const SoNodekitCatalog * getClassNodekitCatalog(void);
78 virtual const SoNodekitCatalog * getNodekitCatalog(void) const;
79
80 virtual SoNode * getPart(const SbName & partname, SbBool makeifneeded);
81 SbString getPartString(const SoBase * part);
82 virtual SoNodeKitPath * createPathToPart(const SbName & partname,
83 SbBool makeifneeded,
84 const SoPath * pathtoextend = NULL);
85 virtual SbBool setPart(const SbName & partname, SoNode * from);
86 SbBool set(const char * namevaluepairliststring);
87 SbBool set(const char * partnamestring, const char * parameterstring);
88
89 virtual void doAction(SoAction * action);
90 virtual void callback(SoCallbackAction * action);
91 virtual void GLRender(SoGLRenderAction * action);
92 virtual void getBoundingBox(SoGetBoundingBoxAction * action);
93 virtual void getMatrix(SoGetMatrixAction * action);
94 virtual void handleEvent(SoHandleEventAction * action);
95 virtual void rayPick(SoRayPickAction * action);
96 virtual void search(SoSearchAction * action);
97 virtual void write(SoWriteAction * action);
98 virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
99
100 virtual SoChildList * getChildren(void) const;
101
102 void printDiagram(void);
103 void printSubDiagram(const SbName & rootname, int level);
104 void printTable(void);
105
106 virtual void addWriteReference(SoOutput * out, SbBool isfromfield = FALSE);
107 SbBool forceChildDrivenWriteRefs(SoOutput * out);
108
109 static SbBool isSearchingChildren(void);
110 static void setSearchingChildren(const SbBool newval);
111
112protected:
113 virtual ~SoBaseKit();
114
115 static const SoNodekitCatalog ** getClassNodekitCatalogPtr(void);
116
117 virtual SoNode * addToCopyDict(void) const;
118 virtual void copyContents(const SoFieldContainer * fromfc,
119 SbBool copyconnections);
120
121 SoGroup * getContainerNode(const SbName & listname,
122 SbBool makeifneeded = TRUE);
123 virtual SoNode * getAnyPart(const SbName & partname, SbBool makeifneeded,
124 SbBool leafcheck = FALSE,
125 SbBool publiccheck = FALSE);
126 virtual SoNodeKitPath * createPathToAnyPart(const SbName & partname,
127 SbBool makeifneeded,
128 SbBool leafcheck = FALSE,
129 SbBool publiccheck = FALSE,
130 const SoPath * pathtoextend = NULL);
131 virtual SbBool setAnyPart(const SbName & partname, SoNode * from,
132 SbBool anypart = TRUE);
133 void createNodekitPartsList(void); // not part of Coin
134 void createFieldList(void); // replaces above method
135 virtual void createDefaultParts(void);
136 const SoNodekitParts * getNodekitPartsList(void) const; // not part of Coin
137 const SbList<SoSFNode*> & getCatalogInstances(void) const; // replaces above method
138
139 void catalogError(void);
140 virtual SbBool setUpConnections(SbBool onoff, SbBool doitalways = FALSE);
141 virtual SbBool readInstance(SoInput * in, unsigned short flags);
142 virtual void setDefaultOnNonWritingFields(void);
143 void countMyFields(SoOutput * out);
144
145 virtual SbBool setPart(const int partNum, SoNode * node);
146
147 SoChildList * children;
148 SbBool connectionsSetUp;
149
150private:
151 friend class SoInteractionKit;
152 static SbBool findPart(const SbString & partname, SoBaseKit *& kit,
153 int & partnum, SbBool & islist, int & listidx,
154 const SbBool makeifneeded, SoPath * path = NULL,
155 const SbBool recsearch = FALSE);
156 static void atexit_cleanupkit(void);
157
158 SbBool makePart(const int partnum);
159 int getRightSiblingIndex(const int partnum);
160 int findNodeInThisKit(SoNode *node, const int parentnum = -1) const;
161
162 static SoNodekitCatalog * classcatalog;
163 static const SoNodekitCatalog ** parentcatalogptr;
164 static SbBool searchchildren;
165
166 class SoBaseKitP * pimpl;
167 friend class SoBaseKitP;
168};
169
170#endif // !COIN_SOBASEKIT_H
SbList
The SbList class is a template container class for lists.
Definition SbList.h:70
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
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
SoBaseKit
The SoBaseKit class is the top level superclass for nodekits.
Definition SoBaseKit.h:66
SoBaseKit::connectionsSetUp
SbBool connectionsSetUp
Definition SoBaseKit.h:148
SoBaseKit::children
SoChildList * children
Definition SoBaseKit.h:147
SoBase
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition SoBase.h:45
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
SoFieldContainer::set
SbBool set(const char *const fielddata)
Definition SoFieldContainer.cpp:383
SoFieldContainer::addWriteReference
virtual void addWriteReference(SoOutput *out, SbBool isfromfield=FALSE)
Definition SoFieldContainer.cpp:698
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
SoInteractionKit
The SoInteractionKit class is a base class for draggers.
Definition SoInteractionKit.h:50
SoNodeKitPath
The SoNodeKitPath class is a path that contains only nodekit nodes.
Definition SoNodeKitPath.h:42
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::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::addToCopyDict
virtual SoNode * addToCopyDict(void) const
Definition SoNode.cpp:1435
SoNode::rayPick
virtual void rayPick(SoRayPickAction *action)
Definition SoNode.cpp:1188
SoNode::copyContents
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition SoNode.cpp:1483
SoNode::search
virtual void search(SoSearchAction *action)
Definition SoNode.cpp:1221
SoNode::write
virtual void write(SoWriteAction *action)
Definition SoNode.cpp:1290
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
SoNodekitCatalog
The SoNodekitCatalog class is a container for nodekit layouts.
Definition SoNodekitCatalog.h:45
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoRayPickAction
The SoRayPickAction class does ray intersection with scene graphs.
Definition SoRayPickAction.h:50
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42