SoFieldContainer.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,92   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:
 |      Defines the SoFieldContainer class, which is the base class of
 |      all classes that contain fields (engines and nodes)
 |
 |   Classes:
 |      SoFieldContainer
 |
 |   Author(s)          : Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_FIELD_CONTAINER_
#define  _SO_FIELD_CONTAINER_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/misc/SoBase.h>
 
 
class SbDict;
class SoFieldData;
class SoFieldList;
class SoSensor;
 
 
 
class INVENTOR_API SoFieldContainer : public SoBase {
 
  public:
 
    static SoType       getClassTypeId()        { return classTypeId; }
 
    void                setToDefaults();
 
    bool                hasDefaultValues() const;
 
    bool                fieldsAreEqual(const SoFieldContainer *fc) const;
 
    void                copyFieldValues(const SoFieldContainer *fc,
                                        bool copyConnections = FALSE);
 
    bool                set(const char *fieldDataString)
        { return set(fieldDataString, NULL); }
 
    void                get(SbString &fieldDataString)
        { get(fieldDataString, NULL); }
 
    virtual int         getFields(SoFieldList &list) const;
 
    virtual SoField *   getField(const SbName &fieldName) const;
 
    bool                getFieldName(const SoField *field,
                                     SbName &fieldName) const;
 
    bool                enableNotify(bool flag)       // returns old value
        { bool e = notifyEnabled; notifyEnabled = flag; return e; }
    bool                isNotifyEnabled() const    { return notifyEnabled; }
 
  SoINTERNAL public:
    static void         initClass();
 
    bool                set(const char *fieldDataString, SoInput *dictIn);
    void                get(SbString &fieldDataString, SoOutput *dictOut);
 
    virtual void        notify(SoNotList *);
 
    virtual void        addWriteReference(SoOutput *out,
                                          bool isFromField = FALSE);
 
    virtual void        writeInstance(SoOutput *out);
 
    bool                getIsBuiltIn() const { return isBuiltIn; }
 
    virtual const SoFieldData * getFieldData() const;
 
 
    static void                 initCopyDict();
 
    static void                 addCopy(const SoFieldContainer *orig,
                                        const SoFieldContainer *copy);
 
    static SoFieldContainer *   checkCopy(const SoFieldContainer *orig);
 
    static SoFieldContainer *   findCopy(const SoFieldContainer *orig,
                                         bool copyConnections);
 
    static void                 copyDone();
 
 
    virtual void                copyContents(const SoFieldContainer *fromFC,
                                             bool copyConnections);
 
    virtual SoFieldContainer *  copyThroughConnection() const;
 
    void addManagedSensor(SoSensor* sensor);
 
  protected:
 
    bool                isBuiltIn;
 
    SoFieldContainer();
    ~SoFieldContainer();
 
    virtual bool        readInstance(SoInput *in, unsigned short flags);
 
  private:
    static SoType       classTypeId;
    bool                notifyEnabled;  
 
    SbPList*            _managedSensors;
 
    static SbPList      *copyDictList;
 
    static void         unrefCopy(size_t key, void *instPtr);
 
    static char         *fieldBuf;
    static size_t       fieldBufSize;
 
    static void *       reallocFieldBuf(void *ptr, size_t newSize);
};
 
#endif  /* _SO_FIELD_CONTAINER_ */