Coin Logo http://www.coin3d.org/
http://www.kongsberg.com/kogt/

SoProto.h
Go to the documentation of this file.
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 
38 class SoProto;
39 class SoInput;
40 class SoProtoInstance;
41 class SoProtoP;
42 
43 typedef 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 {
51 public:
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 
82 protected:
83 
84  virtual ~SoProto();
85  virtual void destroy(void);
86 
87 private:
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
The SoBase class is the top-level superclass for a number of class-hierarchies.SoBase provides the ba...
Definition: SoBase.h:45
The SoOutput class is an abstraction of an output stream.SoOutput offers the ability to write basic t...
Definition: SoOutput.h:51
The SoFieldContainer class is a base class for all classes that contain fields.The classes containing...
Definition: SoFieldContainer.h:43
virtual SoType getTypeId(void) const =0
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.
The SoNode class is the base class for nodes used in scene graphs.Coin is a retained mode 3D visualiz...
Definition: SoNode.h:56
The SoProtoInstance class handles PROTO instances.
Definition: SoProtoInstance.h:46
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition: SoNode.cpp:1476
The SoProto class handles PROTO definitions.
Definition: SoProto.h:50
virtual void destroy(void)
Definition: SoBase.cpp:295
The SoWriteAction class writes a scene graph to file.When applied to a scene, this action writes its ...
Definition: SoWriteAction.h:42
The SoInput class is an abstraction of file import functionality.This class takes care of most of the...
Definition: SoInput.h:61
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
The SoType class is the basis for the run-time type system in Coin.Many of the classes in the Coin li...
Definition: SoType.h:59
virtual void write(SoWriteAction *action)
Definition: SoNode.cpp:1227
The SbName class stores strings by reference.The class is used by Coin for storing keywords...
Definition: SbName.h:40

Copyright © by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated for Coin by Doxygen