SoFieldData.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Definition of the SoFieldData class, which is used by all objects
 |      that have fields.
 |
 |   Author(s)          : Paul S. Strauss, Nick Thompson, Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
 
#ifndef  _SO_FIELD_DATA_
#define  _SO_FIELD_DATA_
 
#include <Inventor/misc/SoBasic.h>
#include <Inventor/SbPList.h>
#include <Inventor/SbString.h>
 
#include <vector>
 
class SoField;
class SoInput;
class SoFieldContainer;
class SoOutput;

 
SoINTERNAL class INVENTOR_API SoFieldData {
  public:
    SoFieldData() {}

    SoFieldData(const SoFieldData &);
    SoFieldData(const SoFieldData *);

    SoFieldData(int numFields) : fields(numFields) {}

    ~SoFieldData();

    void                addField(SoFieldContainer *defObject,
                                 const char *fieldName,
                                 const SoField *field);

    void                overlay(SoFieldContainer *to,
                                const SoFieldContainer *from,
                                bool copyConnections) const;

    int                 getNumFields() const    { return fields.getLength(); }

    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 *typeName,
                                     const char *valName, int val);
    void                getEnumData(const char *typeName, int &num,
                                    int *&vals, SbName *&names);

    const std::vector<SbString>& getRemovedFieldNames() const { return removedFields; }

    void                addRemovedFieldName(const SbString& name);
 
  SoINTERNAL public:

    bool                read(SoInput *in, SoFieldContainer *object,
                             bool errorOnUnknownField,
                             bool &notBuiltIn) const;

    bool                read(SoInput *in, SoFieldContainer *object,
                             const SbName &fieldName,
                             bool &foundName) const;

    void                write(SoOutput *out,
                              const SoFieldContainer *object) const;

    void                copy(const SoFieldData *from);

    bool                isSame(const SoFieldContainer *c1,
                               const SoFieldContainer *c2) const;

    bool                readFieldDescriptions(
                                SoInput *in, SoFieldContainer *object,
                                int numDescriptionsExpected) const;

    void                writeFieldDescriptions(
                                SoOutput *out,
                                const SoFieldContainer *object) const;
 
  private:
    bool                readFields(
                                SoInput *in, SoFieldContainer *object,
                                int numFieldsWritten) const;
 
    SbPList             fields;         
    SbPList             enums;          
    std::vector<SbString> removedFields;
};    
 
#endif /* _SO_FIELD_DATA_ */