Coin: SoFieldData.h Source File

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

SoFieldData.h
1#ifndef COIN_SOFIELDDATA_H
2#define COIN_SOFIELDDATA_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 <Inventor/lists/SbList.h>
38
39class SbName;
40class SoField;
41class SoFieldContainer;
42class SoInput;
43class SoOutput;
44
45class SoEnumEntry;
46class SoFieldEntry;
47
48 class COIN_DLL_API SoFieldData {
49public:
50 SoFieldData(void);
51 SoFieldData(const SoFieldData & fd);
52 SoFieldData(const SoFieldData * fd);
53 SoFieldData(int numfields);
54 ~SoFieldData();
55
56 void addField(SoFieldContainer * base, const char * name,
57 const SoField * field);
58
59 void overlay(SoFieldContainer * to, const SoFieldContainer * from,
60 SbBool copyconnections) const;
61
62 int getNumFields(void) const;
63 const SbName & getFieldName(int index) const;
64 SoField * getField(const SoFieldContainer * object, int index) const;
65 int getIndex(const SoFieldContainer * fc, const SoField * field) const;
66
67 void addEnumValue(const char * enumname, const char * valuename, int value);
68 void getEnumData(const char * enumname,
69 int & num, const int *& values, const SbName *& names);
70
71 SbBool read(SoInput * input, SoFieldContainer * object,
72 SbBool erroronunknownfield, SbBool & notbuiltin) const;
73 SbBool read(SoInput * input, SoFieldContainer * object,
74 const SbName & fieldname, SbBool & foundname) const;
75 void write(SoOutput * out, const SoFieldContainer * object) const;
76 void copy(const SoFieldData * src);
77 SbBool isSame(const SoFieldContainer * c1,
78 const SoFieldContainer * c2) const;
79
80 SbBool readFieldDescriptions(SoInput * input, SoFieldContainer * object,
81 int numdescriptionsexpected,
82 const SbBool readfieldvalues = TRUE) const;
83 void writeFieldDescriptions(SoOutput * out,
84 const SoFieldContainer * object) const;
85
86private:
87 SbBool hasField(const char * name) const;
88 SbBool hasEnumValue(const char * enumname, const char * valuename);
89
90 // Bitflags for control word in the file format.
91 enum ControlWord {
92 NOTBUILTIN = 0x40
93 };
94
95 int operator==(const SoFieldData * fd) const;
96 int operator!=(const SoFieldData * fd) const { return ! operator==(fd); }
97 int operator==(const SoFieldData & fd) const { return operator==(&fd); }
98 int operator!=(const SoFieldData & fd) const { return ! operator==(&fd); }
99
100 void freeResources(void);
101
102 SbList<SoFieldEntry *> fields;
103 SbList<SoEnumEntry *> enums;
104};
105
106#endif // !COIN_SOFIELDDATA_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
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
SoFieldData::getNumFields
int getNumFields(void) const
Definition SoFieldData.cpp:312
SoFieldData::readFieldDescriptions
SbBool readFieldDescriptions(SoInput *input, SoFieldContainer *object, int numdescriptionsexpected, const SbBool readfieldvalues=TRUE) const
Definition SoFieldData.cpp:774
SoFieldData::read
SbBool read(SoInput *input, SoFieldContainer *object, SbBool erroronunknownfield, SbBool &notbuiltin) const
Definition SoFieldData.cpp:437
SoFieldData::addField
void addField(SoFieldContainer *base, const char *name, const SoField *field)
Definition SoFieldData.cpp:208
SoFieldData::writeFieldDescriptions
void writeFieldDescriptions(SoOutput *out, const SoFieldContainer *object) const
Definition SoFieldData.cpp:921
SoFieldData::write
void write(SoOutput *out, const SoFieldContainer *object) const
Definition SoFieldData.cpp:625
SoFieldData::copy
void copy(const SoFieldData *src)
Definition SoFieldData.cpp:714
SoFieldData::getEnumData
void getEnumData(const char *enumname, int &num, const int *&values, const SbName *&names)
Definition SoFieldData.cpp:398
SoFieldData::SoFieldData
SoFieldData(void)
Definition SoFieldData.cpp:150
SoFieldData::getFieldName
const SbName & getFieldName(int index) const
Definition SoFieldData.cpp:321
SoFieldData::getIndex
int getIndex(const SoFieldContainer *fc, const SoField *field) const
Definition SoFieldData.cpp:344
SoFieldData::isSame
SbBool isSame(const SoFieldContainer *c1, const SoFieldContainer *c2) const
Definition SoFieldData.cpp:744
SoFieldData::overlay
void overlay(SoFieldContainer *to, const SoFieldContainer *from, SbBool copyconnections) const
Definition SoFieldData.cpp:274
SoFieldData::addEnumValue
void addEnumValue(const char *enumname, const char *valuename, int value)
Definition SoFieldData.cpp:361
SoFieldData::getField
SoField * getField(const SoFieldContainer *object, int index) const
Definition SoFieldData.cpp:331
SoField
The SoField class is the top-level abstract base class for fields.
Definition SoField.h:47
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51