SoFieldData.h
#ifndef COIN_SOFIELDDATA_H
#define COIN_SOFIELDDATA_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/SbBasic.h>
#include <Inventor/lists/SbList.h>
class SbName;
class SoField;
class SoFieldContainer;
class SoInput;
class SoOutput;
class SoEnumEntry;
class SoFieldEntry;
class COIN_DLL_API SoFieldData {
public:
SoFieldData(void);
SoFieldData(const SoFieldData & fd);
SoFieldData(const SoFieldData * fd);
SoFieldData(int numfields);
~SoFieldData();
void addField(SoFieldContainer * base, const char * name,
const SoField * field);
void overlay(SoFieldContainer * to, const SoFieldContainer * from,
SbBool copyconnections) const;
int getNumFields(void) const;
const SbName & getFieldName(int index) const;
SoField * getField(const SoFieldContainer * object, int index) const;
int getIndex(const SoFieldContainer * fc, const SoField * field) const;
void addEnumValue(const char * enumname, const char * valuename, int value);
void getEnumData(const char * enumname,
int & num, const int *& values, const SbName *& names);
SbBool read(SoInput * input, SoFieldContainer * object,
SbBool erroronunknownfield, SbBool & notbuiltin) const;
SbBool read(SoInput * input, SoFieldContainer * object,
const SbName & fieldname, SbBool & foundname) const;
void write(SoOutput * out, const SoFieldContainer * object) const;
void copy(const SoFieldData * src);
SbBool isSame(const SoFieldContainer * c1,
const SoFieldContainer * c2) const;
SbBool readFieldDescriptions(SoInput * input, SoFieldContainer * object,
int numdescriptionsexpected,
const SbBool readfieldvalues = TRUE) const;
void writeFieldDescriptions(SoOutput * out,
const SoFieldContainer * object) const;
private:
SbBool hasField(const char * name) const;
SbBool hasEnumValue(const char * enumname, const char * valuename);
// Bitflags for control word in the file format.
enum ControlWord {
NOTBUILTIN = 0x40
};
int operator==(const SoFieldData * fd) const;
int operator!=(const SoFieldData * fd) const { return ! operator==(fd); }
int operator==(const SoFieldData & fd) const { return operator==(&fd); }
int operator!=(const SoFieldData & fd) const { return ! operator==(&fd); }
void freeResources(void);
SbList<SoFieldEntry *> fields;
SbList<SoEnumEntry *> enums;
};
#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