Coin Logo http://www.sim.no
http://www.coin3d.org

SoFieldData.h
1 #ifndef COIN_SOFIELDDATA_H
2 #define COIN_SOFIELDDATA_H
3 
4 /**************************************************************************\
5  *
6  * This file is part of the Coin 3D visualization library.
7  * Copyright (C) 1998-2007 by Systems in Motion. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * ("GPL") version 2 as published by the Free Software Foundation.
12  * See the file LICENSE.GPL at the root directory of this source
13  * distribution for additional information about the GNU GPL.
14  *
15  * For using Coin with software that can not be combined with the GNU
16  * GPL, and for taking advantage of the additional benefits of our
17  * support services, please contact Systems in Motion about acquiring
18  * a Coin Professional Edition License.
19  *
20  * See http://www.coin3d.org/ for more information.
21  *
22  * Systems in Motion, Postboks 1283, Pirsenteret, 7462 Trondheim, NORWAY.
23  * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
24  *
25 \**************************************************************************/
26 
27 #include <Inventor/SbBasic.h>
28 #include <Inventor/lists/SbList.h>
29 
30 class SbName;
31 class SoField;
32 class SoFieldContainer;
33 class SoInput;
34 class SoOutput;
35 
36 class SoEnumEntry;
37 class SoFieldEntry;
38 
39 class COIN_DLL_API SoFieldData {
40 public:
41  SoFieldData(void);
42  SoFieldData(const SoFieldData & fd);
43  SoFieldData(const SoFieldData * fd);
44  SoFieldData(int numfields);
45  ~SoFieldData();
46 
47  void addField(SoFieldContainer * base, const char * name,
48  const SoField * field);
49 
50  void overlay(SoFieldContainer * to, const SoFieldContainer * from,
51  SbBool copyconnections) const;
52 
53  int getNumFields(void) const;
54  const SbName & getFieldName(int index) const;
55  SoField * getField(const SoFieldContainer * object, int index) const;
56  int getIndex(const SoFieldContainer * fc, const SoField * field) const;
57 
58  void addEnumValue(const char * enumname, const char * valuename, int value);
59  void getEnumData(const char * enumname,
60  int & num, const int *& values, const SbName *& names);
61 
62  SbBool read(SoInput * in, SoFieldContainer * object,
63  SbBool erroronunknownfield, SbBool & notbuiltin) const;
64  SbBool read(SoInput * in, SoFieldContainer * object,
65  const SbName & fieldname, SbBool & foundname) const;
66  void write(SoOutput * out, const SoFieldContainer * object) const;
67  void copy(const SoFieldData * src);
68  SbBool isSame(const SoFieldContainer * c1,
69  const SoFieldContainer * c2) const;
70 
71  SbBool readFieldDescriptions(SoInput * in, SoFieldContainer * object,
72  int numdescriptionsexpected,
73  const SbBool readfieldvalues = TRUE) const;
74  void writeFieldDescriptions(SoOutput * out,
75  const SoFieldContainer * object) const;
76 
77 private:
78  SbBool hasField(const char * name) const;
79  SbBool hasEnumValue(const char * enumname, const char * valuename);
80 
81  // Bitflags for control word in the file format.
82  enum ControlWord {
83  NOTBUILTIN = 0x40
84  };
85 
86  int operator==(const SoFieldData * fd) const;
87  int operator!=(const SoFieldData * fd) const { return ! operator==(fd); }
88  int operator==(const SoFieldData & fd) const { return operator==(&fd); }
89  int operator!=(const SoFieldData & fd) const { return ! operator==(&fd); }
90 
91  void freeResources(void);
92 
95 };
96 
97 #endif // !COIN_SOFIELDDATA_H
SoType::badType
static SoType badType(void)
Definition: SoType.cpp:664
SoInput::isFileVRML2
SbBool isFileVRML2(void)
Definition: SoInput.cpp:2730
SoFieldData::getNumFields
int getNumFields(void) const
Definition: SoFieldData.cpp:288
SoReadError::post
static void post(const SoInput *const in, const char *const format,...)
Definition: SoReadError.cpp:110
SbName::getLength
int getLength(void) const
Definition: SbName.cpp:287
SoField::getClassTypeId
static SoType getClassTypeId(void)
Definition: SoField.cpp:680
SoType::fromName
static SoType fromName(const SbName name)
Definition: SoType.cpp:463
SbName
The SbName class stores strings by reference.
Definition: SbName.h:31
SoField::isDefault
SbBool isDefault(void) const
Definition: SoField.cpp:669
SoOutput::write
virtual void write(const char c)
Definition: SoOutput.cpp:757
SoOutput::indent
virtual void indent(void)
Definition: SoOutput.cpp:1074
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition: SoOutput.h:42
SoField::isIgnored
SbBool isIgnored(void) const
Definition: SoField.cpp:638
SbList::truncate
void truncate(const int length, const int dofit=0)
Definition: SbList.h:149
SoFieldData::copy
void copy(const SoFieldData *src)
Definition: SoFieldData.cpp:725
SoField::shouldWrite
SbBool shouldWrite(void) const
Definition: SoField.cpp:1569
SoFieldData::isSame
SbBool isSame(const SoFieldContainer *c1, const SoFieldContainer *c2) const
Definition: SoFieldData.cpp:755
SoDebugError::postWarning
static void postWarning(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:324
SoFieldData::SoFieldData
SoFieldData(void)
Definition: SoFieldData.cpp:141
SoFieldData::getEnumData
void getEnumData(const char *enumname, int &num, const int *&values, const SbName *&names)
Definition: SoFieldData.cpp:407
SoField::setContainer
void setContainer(SoFieldContainer *cont)
Definition: SoField.cpp:1234
SbList::append
void append(const Type item)
Definition: SbList.h:98
SbString
The SbString class is a string class with convenience functions for string operations.
Definition: SbString.h:42
SoField::copyFrom
virtual void copyFrom(const SoField &f)=0
SoFieldData::addEnumValue
void addEnumValue(const char *enumname, const char *valuename, int value)
Definition: SoFieldData.cpp:370
SoField::isNotifyEnabled
SbBool isNotifyEnabled(void) const
Definition: SoField.cpp:1499
SoField::getContainer
SoFieldContainer * getContainer(void) const
Definition: SoField.cpp:1253
SoType::isDerivedFrom
SbBool isDerivedFrom(const SoType type) const
Definition: SoType.cpp:687
SoField
The SoField class is the top-level abstract base class for fields.
Definition: SoField.h:38
SoField::setDefault
void setDefault(SbBool def)
Definition: SoField.cpp:650
SoType
The SoType class is the basis for the run-time type system in Coin.
Definition: SoType.h:50
SoOutput::isBinary
virtual SbBool isBinary(void) const
Definition: SoOutput.cpp:650
SoFieldData::writeFieldDescriptions
void writeFieldDescriptions(SoOutput *out, const SoFieldContainer *object) const
Definition: SoFieldData.cpp:932
SoField::read
virtual SbBool read(SoInput *in, const SbName &name)
Definition: SoField.cpp:1780
SbList< SbName >
SbName::getString
const char * getString(void) const
Definition: SbName.cpp:278
SoDebugError::postInfo
static void postInfo(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:334
SoTexture2
The SoTexture2 class is used to map a 2D texture onto subsequent geometry in the scenegraph.
Definition: SoTexture2.h:38
SbList::getLength
int getLength(void) const
Definition: SbList.h:145
SoInput::putBack
virtual void putBack(const char c)
Definition: SoInput.cpp:1834
SoInput::addProto
void addProto(SoProto *proto)
Definition: SoInput.cpp:611
SoFieldContainer::getIsBuiltIn
SbBool getIsBuiltIn(void) const
Definition: SoFieldContainer.cpp:652
SoFieldData::~SoFieldData
~SoFieldData()
Definition: SoFieldData.cpp:175
SoInput::checkISReference
SbBool checkISReference(SoFieldContainer *container, const SbName &fieldname, SbBool &readok)
Definition: SoInput.cpp:678
SoFieldData
The SoFieldData class is a container for a prototype set of fields.
Definition: SoFieldData.h:39
SoField::setFieldType
void setFieldType(int type)
Definition: SoField.cpp:2465
SoFieldList
The SoFieldList class is a container for pointers to SoField objects.
Definition: SoFieldList.h:31
SoFieldData::overlay
void overlay(SoFieldContainer *to, const SoFieldContainer *from, SbBool copyconnections) const
Definition: SoFieldData.cpp:250
SoField::enableNotify
SbBool enableNotify(SbBool on)
Definition: SoField.cpp:1485
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition: SoFieldContainer.h:35
SoFieldData::addField
void addField(SoFieldContainer *base, const char *name, const SoField *field)
Definition: SoFieldData.cpp:200
SoType::createInstance
void * createInstance(void) const
Definition: SoType.cpp:803
SoField::getTypeId
virtual SoType getTypeId(void) const =0
SbString::sprintf
SbString & sprintf(const char *formatstr,...)
Definition: SbString.h:105
SoOutput::getCurrentProto
SoProto * getCurrentProto(void) const
Definition: SoOutput.cpp:1395
SoBase::readRoute
static SbBool readRoute(SoInput *in)
Definition: SoBase.cpp:1876
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
SoOutput::getStage
Stage getStage(void) const
Definition: SoOutput.cpp:744
SoInput::read
virtual SbBool read(char &c)
Definition: SoInput.cpp:1180
SoField::write
virtual void write(SoOutput *out, const SbName &name) const
Definition: SoField.cpp:1923
SoFieldData::getFieldName
const SbName & getFieldName(int index) const
Definition: SoFieldData.cpp:297
SoField::getFieldType
int getFieldType(void) const
Definition: SoField.cpp:2478
SoInput::isBinary
virtual SbBool isBinary(void)
Definition: SoInput.cpp:1096
SoInput
The SoInput class is an abstraction of file import functionality.
Definition: SoInput.h:55
SoFieldContainer::getFieldData
virtual const SoFieldData * getFieldData(void) const
Definition: SoFieldContainer.cpp:663
SoFieldData::getIndex
int getIndex(const SoFieldContainer *fc, const SoField *field) const
Definition: SoFieldData.cpp:333
SoBase::isOfType
SbBool isOfType(SoType type) const
Definition: SoBase.cpp:710
SoField::copyConnection
void copyConnection(const SoField *fromfield)
Definition: SoField.cpp:1699
SoType::getName
SbName getName(void) const
Definition: SoType.cpp:628
SoField::setIgnored
void setIgnored(SbBool ignore)
Definition: SoField.cpp:625
SoFieldData::readFieldDescriptions
SbBool readFieldDescriptions(SoInput *in, SoFieldContainer *object, int numdescriptionsexpected, const SbBool readfieldvalues=1) const
Definition: SoFieldData.cpp:785
SbString::getString
const char * getString(void) const
Definition: SbString.h:71
SoFieldData::getField
SoField * getField(const SoFieldContainer *object, int index) const
Definition: SoFieldData.cpp:307
SoFieldData::read
SbBool read(SoInput *in, SoFieldContainer *object, SbBool erroronunknownfield, SbBool &notbuiltin) const
Definition: SoFieldData.cpp:446
SoFieldData::write
void write(SoOutput *out, const SoFieldContainer *object) const
Definition: SoFieldData.cpp:634
SoField::fixCopy
virtual void fixCopy(SbBool copyconnections)
Definition: SoField.cpp:1651
SoType::canCreateInstance
SbBool canCreateInstance(void) const
Definition: SoType.cpp:786

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Jul 27 2020 for Coin by Doxygen. 1.8.18