Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoType.h
Go to the documentation of this file.
1 #ifndef COIN_SOTYPE_H
2 #define COIN_SOTYPE_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/SbBasic.h>
37 #include <cstdlib> // For NULL definition.
38 
39 #ifndef COIN_INTERNAL
40 // The next include for Open Inventor compatibility.
41 //
42 // FIXME: I haven't checked that this is actually required -- test vs
43 // SGI Inventor. 20050524 mortene.
44 #include <Inventor/SbDict.h>
45 #endif // COIN_INTERNAL
46 
47 // *************************************************************************
48 
49 class SbName;
50 class SoTypedObject;
51 class SoTypeList;
52 class SoFieldData;
53 class SbDict;
54 struct SoTypeData;
55 template <class Type> class SbList;
56 
57 // *************************************************************************
58 
59 class COIN_DLL_API SoType {
60 public:
61  typedef void * (*instantiationMethod)(void);
62 
63  static SoType fromName(const SbName name);
64  SbName getName(void) const;
65  const SoType getParent(void) const;
66  SbBool isDerivedFrom(const SoType type) const;
67 
68  static int getAllDerivedFrom(const SoType type, SoTypeList & list);
69 
70  SbBool canCreateInstance(void) const;
71  void * createInstance(void) const;
72 
73  uint16_t getData(void) const;
74  int16_t getKey(void) const;
75 
76  SbBool operator == (const SoType type) const;
77  SbBool operator != (const SoType type) const;
78 
79  SbBool operator < (const SoType type) const;
80  SbBool operator <= (const SoType type) const;
81  SbBool operator >= (const SoType type) const;
82  SbBool operator > (const SoType type) const;
83 
84  static const SoType createType(const SoType parent, const SbName name,
85  const instantiationMethod method = NULL,
86  const uint16_t data = 0);
87 
88  static const SoType overrideType(const SoType originalType,
89  const instantiationMethod method = NULL);
90 
91  static SbBool removeType(const SbName & name);
92 
93  static void init(void);
94 
95  static SoType fromKey(uint16_t key);
96  static SoType badType(void);
97  SbBool isBad(void) const;
98 
99  void makeInternal(void);
100  SbBool isInternal(void) const;
101 
102  static int getNumTypes(void);
103 
104  instantiationMethod getInstantiationMethod(void) const;
105 
106 private:
107  static void clean(void);
108 
109  int16_t index;
110 
111  static SbList<SoTypeData *> * typedatalist;
112 };
113 
114 /* inline methods ************************************************/
115 
116 inline int16_t
117 SoType::getKey(void) const
118 {
119  return this->index;
120 }
121 
122 inline SbBool
123 SoType::operator != (const SoType type) const
124 {
125  return (this->getKey() != type.getKey());
126 }
127 
128 inline SbBool
129 SoType::operator == (const SoType type) const
130 {
131  return (this->getKey() == type.getKey());
132 }
133 
134 inline SbBool
135 SoType::operator < (const SoType type) const
136 {
137  return (this->getKey() < type.getKey());
138 }
139 
140 inline SbBool
141 SoType::operator <= (const SoType type) const
142 {
143  return (this->getKey() <= type.getKey());
144 }
145 
146 inline SbBool
147 SoType::operator >= (const SoType type) const
148 {
149  return (this->getKey() >= type.getKey());
150 }
151 
152 inline SbBool
153 SoType::operator > (const SoType type) const
154 {
155  return (this->getKey() > type.getKey());
156 }
157 
158 inline SbBool
159 SoType::isBad(void) const
160 {
161  return (this->index == 0);
162 }
163 
164 #endif // !COIN_SOTYPE_H
The SbList class is a template container class for lists.
Definition: SoType.h:55
SbBool isBad(void) const
Definition: SoType.h:159
The SbDict class organizes a dictionary of keys and values.
Definition: SbDict.h:63
SbBool operator<=(const SoType type) const
Definition: SoType.h:141
The SoTypeList class is a container class for arrays of SoType objects.
Definition: SoTypeList.h:39
SbBool operator==(const SoType type) const
Definition: SoType.h:129
SbBool operator>(const SoType type) const
Definition: SoType.h:153
SbBool operator!=(const SoType type) const
Definition: SoType.h:123
int16_t getKey(void) const
Definition: SoType.h:117
The SoFieldData class is a container for a prototype set of fields.
Definition: SoFieldData.h:48
The SoType class is the basis for the runtime type system in Coin.
Definition: SoType.h:59
The SbName class stores strings by reference.
Definition: SbName.h:40
SbBool operator<(const SoType type) const
Definition: SoType.h:135
SbBool operator>=(const SoType type) const
Definition: SoType.h:147