Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoWriterefCounter.h
1#ifndef COIN_SOWRITEREFCOUNTER_H
2#define COIN_SOWRITEREFCOUNTER_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
36class SoWriterefCounterP;
37class SoOutput;
38class SoBase;
39class SbString;
40
41#ifndef COIN_INTERNAL
42#error this is a private header file
43#endif
44
45#include <Inventor/SbBasic.h>
46#include <Inventor/SbName.h>
47
48class SoWriterefCounter {
49public:
50 static void initClass(void);
51
52 static void setInstancePrefix(const SbString & s);
53
54 static void create(SoOutput * out, SoOutput * copyfrom);
55 static void destruct(SoOutput * out);
56
57 static SoWriterefCounter * instance(SoOutput * out);
58
59 SbBool shouldWrite(const SoBase * base) const;
60 SbName getWriteName(const SoBase * base) const;
61 SbBool hasMultipleWriteRefs(const SoBase * base) const;
62 int getWriteref(const SoBase * base) const;
63 void setWriteref(const SoBase * base, const int ref);
64 void removeWriteref(const SoBase * base);
65 void decrementWriteref(const SoBase * base);
66
67 SbBool isInGraph(const SoBase * base) const;
68 void setInGraph(const SoBase * base, const SbBool ingraph);
69 void debugCleanup(void);
70
71 enum RefId {
72 // Reference id if we don't need to add a suffix to the node name
73 NOSUFFIX = -2,
74 // Reference id if no DEF instance of a node is written yet
75 FIRSTWRITE = -1
76 };
77
78 int addReference(const SoBase * base);
79 int findReference(const SoBase * base) const;
80 void setReference(const SoBase * base, int refid);
81 void removeSoBase2IdRef(const SoBase * base);
82
83 static SbBool debugWriterefs(void);
84
85protected:
86 SoWriterefCounter(SoOutput * out, SoOutput * copyfrom);
87 ~SoWriterefCounter();
88
89private:
90 void cleanup(void);
91
92 SoWriterefCounterP * pimpl;
93
94};
95
96#endif // COIN_SOWRITERREFCOUNTER_H
The SbName class stores strings by reference.
Definition SbName.h:40
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition SoBase.h:45
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51