Coin: SoProto.h Source File

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

SoProto.h
1#ifndef COIN_SOPROTO_H
2#define COIN_SOPROTO_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/SoNode.h>
37
38class SoProto;
39class SoInput;
40class SoProtoInstance;
41class SoProtoP;
42
43typedef SoProto * SoFetchExternProtoCB(SoInput * in,
44 const SbString * urls,
45 const int numurls,
46 void * closure);
47
48// We need to inherit SoNode to be able to insert the PROTO definition
49// into the scene graph.
50 class COIN_DLL_API SoProto : public SoNode {
51public:
52 SoProto(const SbBool externproto = FALSE);
53
54 static void setFetchExternProtoCallback(SoFetchExternProtoCB * cb,
55 void * closure);
56
57 virtual SoType getTypeId(void) const;
58 static SoType getClassTypeId(void);
59
60 static SoProto * findProto(const SbName & name);
61 static void initClass(void);
62
63 SoProtoInstance * createProtoInstance(void);
64 void addISReference(SoNode * container,
65 const SbName & fieldname,
66 const SbName & interfacename);
67 SbName findISReference(const SoFieldContainer * container,
68 const SbName & fieldname);
69
70 void addReference(const SbName & name, SoBase * base);
71 void removeReference(const SbName & name);
72 SoBase * findReference(const SbName & name) const;
73
74 void addRoute(const SbName & fromnode, const SbName & fromfield,
75 const SbName & tonode, const SbName & tofield);
76
77 SbName getProtoName(void) const;
78
79 virtual SbBool readInstance(SoInput * input, unsigned short flags);
80 virtual void write(SoWriteAction * action);
81
82protected:
83
84 virtual ~SoProto();
85 virtual void destroy(void);
86
87private:
88 SbBool writeInterface(SoOutput * out);
89 SbBool writeDefinition(SoWriteAction * action);
90
91 SbBool readInterface(SoInput * in);
92 SbBool readDefinition(SoInput * in);
93
94 SbBool writeURLs(SoOutput * out);
95 SoProtoP * pimpl;
96 friend class SoProtoP;
97
98 SbBool setupExtern(SoInput * in, SoProto * externproto);
99
100 SoNode * createInstanceRoot(SoProtoInstance * inst) const;
101 void connectISRefs(SoProtoInstance * inst, SoNode * src, SoNode * dst) const;
102};
103
104#endif // !COIN_SOPROTO_H
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
SoBase::SoBase
SoBase(void)
Definition SoBase.cpp:190
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
Returns the type identification of an object derived from a class inheriting SoBase....
SoBase::destroy
virtual void destroy(void)
Definition SoBase.cpp:299
SoFieldContainer::SoFieldContainer
SoFieldContainer(void)
Definition SoFieldContainer.cpp:133
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::getClassTypeId
static SoType getClassTypeId(void)
Definition SoNode.cpp:361
SoNode::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoNode.cpp:1542
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
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoProtoInstance
The SoProtoInstance class handles PROTO instances.
Definition SoProtoInstance.h:46
SoProto
The SoProto class handles PROTO definitions.
Definition SoProto.h:50
SoProto::SoProto
SoProto(const SbBool externproto=FALSE)
Definition SoProto.cpp:271
SoProto::addRoute
void addRoute(const SbName &fromnode, const SbName &fromfield, const SbName &tonode, const SbName &tofield)
Definition SoProto.cpp:689
SoProto::findProto
static SoProto * findProto(const SbName &name)
Definition SoProto.cpp:325
SoProto::findISReference
SbName findISReference(const SoFieldContainer *container, const SbName &fieldname)
Definition SoProto.cpp:643
SoProto::removeReference
void removeReference(const SbName &name)
Definition SoProto.cpp:668
SoProto::addReference
void addReference(const SbName &name, SoBase *base)
Definition SoProto.cpp:659
SoProto::createProtoInstance
SoProtoInstance * createProtoInstance(void)
Definition SoProto.cpp:344
SoProto::addISReference
void addISReference(SoNode *container, const SbName &fieldname, const SbName &interfacename)
Definition SoProto.cpp:627
SoProto::getProtoName
SbName getProtoName(void) const
Definition SoProto.cpp:359
SoProto::findReference
SoBase * findReference(const SbName &name) const
Definition SoProto.cpp:677
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42