SoField.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:
 |      Defines the SoField class, which is the base class for all 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_
#define  _SO_FIELD_
 
#include <Inventor/SbString.h>
#include <Inventor/SoType.h>
#include <Inventor/misc/SoNotification.h>
 
class SoEngineOutput;
class SoFieldContainer;
struct SoFieldAuditorInfo;
class SoFieldConverter;
class SoFieldList;
class SoInput;
class SoNotList;
class SoOutput;
 


 
class INVENTOR_API SoField {
  public:
    virtual ~SoField();

    void                setIgnored(bool ig);
    bool                isIgnored() const       { return flags.ignored; }

    bool                isDefault() const       { return flags.hasDefault; }

    static SoType       getClassTypeId()        { return classTypeId; }

    virtual SoType      getTypeId() const = 0;

    bool                isOfType(SoType type) const;

    void                enableConnection(bool flag);
    bool                isConnectionEnabled() const
        { return flags.connectionEnabled; }

    bool                connectFrom(SoEngineOutput *engineOutput);
    bool                connectFrom(SoField *field);

    void                disconnect();

    bool                isConnected() const     { return flags.connected; }
    bool                isConnectedFromEngine() const
        { return (flags.connected &&   flags.fromEngine); }

    bool                isConnectedFromField() const
        { return (flags.connected && ! flags.fromEngine); }

    bool                getConnectedEngine(SoEngineOutput *&engineOutput) const;
    bool                getConnectedField(SoField *&field) const;

    int                 getForwardConnections(SoFieldList &list) const;

    SoFieldContainer *  getContainer() const;

    bool                set(const char *valueString);

    void                get(SbString &valueString);

    virtual void        touch();

    bool                   operator ==(const SoField &f) const
        { return isSame(f); }

    bool                   operator !=(const SoField &f) const
        { return ! isSame(f); }
 
  SoEXTENDER protected:
    SoField();
 
  SoINTERNAL public:
    static void         initClass();

    static void         initClasses();

    void                setDefault(bool def)  { flags.hasDefault = (def ? 1 : 0 ); }

    virtual void        startNotify();
    virtual void        notify(SoNotList *list);

    void                setContainer(SoFieldContainer *cont);

    bool                shouldWrite() const;

    void                addAuditor(void *auditor, SoNotRec::Type type);
    void                removeAuditor(void *auditor, SoNotRec::Type type);

    bool                enableNotify(bool flag);
    bool                isNotifyEnabled() const
        { return flags.notifyEnabled; }

    bool                enableContainerNotify(bool flag);
    bool                isContainerNotifyEnabled() const
    { return flags.notifyContainerEnabled; }

    virtual void        connectionStatusChanged(int numConnections);

    bool                isReadOnly() const { return flags.readOnly; }

    virtual bool        isSame(const SoField &f) const = 0;

    virtual void        copyFrom(const SoField &f) = 0;

    virtual void        fixCopy(bool copyConnections);

    virtual bool        referencesCopy() const;

    void                copyConnection(const SoField *fromField);

    virtual bool        read(SoInput *in, const SbName &name);

    virtual void        write(SoOutput *out, const SbName &name) const;

    virtual void        countWriteRefs(SoOutput *out) const;

    void                evaluate() const
        { if (flags.dirty) evaluateConnection(); }
 
  protected:
    void                valueChanged(bool resetDefault = TRUE);

    virtual void        evaluateConnection() const;

    virtual bool        readValue(SoInput *in) = 0;

    virtual bool        readConnection(SoInput *in);

    virtual void        writeValue(SoOutput *out) const = 0;

    virtual void        writeConnection(SoOutput *out) const;
 
  private:
    static SoType       classTypeId;

    static char         *fieldBuf;
    static int          fieldBufSize;

    struct {
        unsigned int hasDefault         : 1; 
        unsigned int ignored            : 1; 
        unsigned int connected          : 1; 
        unsigned int converted          : 1; 
        unsigned int fromEngine         : 1; 
        unsigned int connectionEnabled  : 1; 
        unsigned int notifyEnabled      : 1; 
        unsigned int hasAuditors        : 1; 
        unsigned int isEngineModifying  : 1; 
        unsigned int readOnly           : 1; 
        unsigned int dirty              : 1; 
        unsigned int notifyContainerEnabled : 1; 
    } flags;

    union {
        SoFieldContainer *container;
        SoFieldAuditorInfo *auditorInfo;
    };

    void                createAuditorInfo();

    SoFieldConverter    *createConverter(const SoType &fromFieldType) const;

    void                reallyDisconnect();

    SoFieldConverter *  getConverter() const;

    void                getConnectionInfo(SoFieldContainer *&, SbName&) const;

    static void *       reallocFieldBuf(void *ptr, size_t newSize);
 
friend class SoEngineOutput;
};
 


 
class INVENTOR_API SoSField : public SoField {
  public:
    virtual ~SoSField();

    static SoType       getClassTypeId()        { return classTypeId; }
 
  protected:
    SoSField();
 
  SoINTERNAL public:
    static void         initClass();
 
    static void *       createInstance();
 
  private:
    static SoType       classTypeId;

    virtual bool        readValue(SoInput *in) = 0;

    virtual void        writeValue(SoOutput *out) const = 0;
};
 


 
class INVENTOR_API SoMField : public SoField {
 
  public:
    virtual ~SoMField();

    int                 getNum() const { evaluate(); return num; }

    void                setNum(int num);

    virtual void        deleteValues(int start, int num = -1);

    virtual void        insertSpace(int start, int num);

    bool                set1(int index, const char *valueString);
    void                get1(int index, SbString &valueString);

    static SoType       getClassTypeId()        { return classTypeId; }
 
  SoINTERNAL public:
    static void         initClass();
 
    static void *       createInstance();
 
  protected:
    int                 num;            
    int                 maxNum;         

    SoMField();

    virtual void        makeRoom(int newNum);
 
  private:
    static SoType       classTypeId;

    static char         *fieldBuf;
    static int          fieldBufSize;

    virtual void        allocValues(int num) = 0;

    virtual void        deleteAllValues() = 0;

    virtual void        copyValue(int to, int from) = 0;

    virtual bool        readValue(SoInput *in);

    virtual bool        read1Value(SoInput *in, int index) = 0;

    virtual void        writeValue(SoOutput *out) const;

    virtual void        write1Value(SoOutput *out, int index) const = 0;

    virtual bool        readBinaryValues(SoInput *in, int numToRead);

    virtual void        writeBinaryValues(SoOutput *out) const;

    virtual int         getNumValuesPerLine() const;

    static void *       reallocFieldBuf(void *ptr, size_t newSize);
};
 
#endif /* _SO_FIELD_ */