MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/misc/SoBase.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:
 |      Definition of SoBase, the base class for several other Inventor
 |      classes. This class handles reference counting and
 |      notification and is the main entry point for reading and
 |      writing derived classes.
 |
 |   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_BASE_
#define  _SO_BASE_

#include <Inventor/system/SbSystem.h>
#include <Inventor/misc/SoBasic.h>
#include <Inventor/misc/SoAuditorList.h>
#include <Inventor/SbString.h>
#include <Inventor/SoType.h>

class SoBaseList;
class SoInput;
class SoNode;
class SoNotList;
class SoOutput;
class SoPath;





class INVENTOR_API SoBase {
  public:

    void                        ref() const;

    void                        unref() const;

    void                        unrefNoDelete() const;

    void                        touch()         { startNotify(); }

    static SoType               getClassTypeId() { return classTypeId; }

    virtual SoType              getTypeId() const = 0;

    SbBool                      isOfType(SoType type) const;

    virtual SbName              getName() const;

    virtual void                setName(const SbName &name);

  protected:
    SoBase();

    virtual ~SoBase();

    virtual void                destroy();

    static uint32_t     getCurrentWriteCounter()
        { return currentWriteCounter; }

    SbBool                      hasMultipleWriteRefs() const
        { return writeStuff.multWriteRef; }

    SbBool      writeHeader(SoOutput *out,
                            SbBool isGroup, SbBool isEngine) const;
    void        writeFooter(SoOutput *out) const;

    virtual const char *getFileFormatName() const;

    enum BaseFlags {
        IS_ENGINE        = 1,
        IS_GROUP         = 2
    };

    virtual SbBool      readInstance(SoInput *in, unsigned short flags) = 0;

  SoINTERNAL public:

    static void         initClass();

    static void         incrementCurrentWriteCounter()
        { currentWriteCounter++; }

    static void         decrementCurrentWriteCounter()
        { currentWriteCounter--; }

    virtual void        startNotify();

    virtual void        notify(SoNotList *list);

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

    const SoAuditorList &getAuditors() { return auditors; }

    static SbBool       traceRefs;

    static void         addName(SoBase *, const char *);
    static void         removeName(SoBase *, const char *);

    static SoBase       *getNamedBase(const SbName &, SoType);
    static int          getNamedBases(const SbName &, SoBaseList &,
                                      SoType);

    int                 getRefCount() const     { return refCount; }

    static SbBool       read(SoInput *in, SoBase *&base,
                             SoType expectedType);

    virtual void        addWriteReference(SoOutput *out,
                                          SbBool isFromField = FALSE);

    SbBool              shouldWrite();

    static void         setInstancePrefix(const SbString &c) { instancePrefix = c; }
  
  private:

    static SoType       classTypeId;
    
    static SbString     instancePrefix;

    static uint32_t currentWriteCounter;

    int                 refCount;

    SoAuditorList       auditors;    

    struct {

        unsigned int writeCounter : 29;

        unsigned int hasName : 1;

        unsigned int multWriteRef : 1;

        unsigned int writeRefFromField : 1;

    } writeStuff;

    void                writeDef(SoOutput *, int) const;
    void                writeRef(SoOutput *, int) const;
    void                writeAnnotation(SoOutput *) const;

    static SbBool       readReference(SoInput *in, SoBase *&base);
    static SbBool       readBase(SoInput *in, SbName &className,
                                 SoBase *&base);
    static SbBool       readBaseInstance(SoInput *in, const SbName &className,
                                         const SbName &refName, SoBase *&base);
    static SoBase       *createInstance(SoInput *in, SbName className,
                                        unsigned short ioFlags);
    static void         flushInput(SoInput *in);

    static SbDict       *nameObjDict;

    static SbDict       *objNameDict;
};

#endif /* _SO_BASE_ */