MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/SoDB.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 SoDB class
 |
 |   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_DB_
#define  _SO_DB_

#include <Inventor/system/SbSystem.h>
#include <Inventor/sensors/SoSensorManager.h>
#include <Inventor/SoType.h>
#include <Inventor/SbPList.h>

class SoBase;
class SoSFRealTime;
class SoSeparator;
class SoInput;
class SoPath;
class SoNode;
class SoField;

typedef void SoDBHeaderCB(void *userData, SoInput *in);





class INVENTOR_API SoDB {

  public:

    static void         init();

    static const char   *getVersion();

    static SbBool       read(SoInput *in, SoNode *&rootNode);

    static SbBool       read(SoInput *in, SoPath *&path);

    static SoSeparator  *readAll(SoInput *in);

    static SbBool       registerHeader(const SbString &headerString,
                                        SbBool isBinary, 
                                        float ivVersion, 
                                        SoDBHeaderCB *preCB,
                                        SoDBHeaderCB *postCB,
                                        void *userData = NULL);

    static SbBool       getHeaderData(const SbString &string,
                                        SbBool &isBinary,  
                                        float &ivVersion,
                                        SoDBHeaderCB *&preCB, 
                                        SoDBHeaderCB *&postCB, 
                                        void *&userData, 
                                        SbBool substringOK = FALSE);                                        
    static int          getNumHeaders();
    static SbString     getHeaderString(int i);

    static SbBool       isValidHeader(const char *testString);

    static SoField *    createGlobalField(const SbName &name,
                                          SoType type);

    static SoField *    getGlobalField(const SbName &name);

    static void         renameGlobalField(const SbName &oldName,
                                          const SbName &newName);

    static void         setRealTimeInterval(const SbTime &deltaT);
    static const SbTime &getRealTimeInterval();

    static void         setDelaySensorTimeout(const SbTime &t);
    static const SbTime &getDelaySensorTimeout();

    static int          doSelect(int nfds, fd_set *readfds, fd_set *writefds,
                                 fd_set *exceptfds,
                                 struct timeval *userTimeOut);

  SoEXTENDER public:
    static void         addConverter(SoType fromField, SoType toField,
                                     SoType converterEngine);

    static SoType       getConverter(SoType fromField, SoType toField);

  SoINTERNAL public:
    static SoSensorManager *    getSensorManager();

    static SbBool       isInitialized() { return (globalDB != NULL); }

    static void         startNotify()           { notifyCount++; }
    static SbBool       isNotifying()           { return (notifyCount > 0); }
    static void         endNotify()
        { if (--notifyCount == 0)
              globalDB->sensorManager.processImmediateQueue(); }

    static void         enableRealTimeSensor(SbBool enable);

    static SbBool       read(SoInput *in, SoBase *&base);
    
  private:
    static const char   *versionString; 
    static SoDB         *globalDB;      
    SoSensorManager     sensorManager;  

    static int          notifyCount;    

    static SoTimerSensor *realTimeSensor;
    static void         realTimeSensorCallback();
    static SoSFRealTime *realTime;
    
    static SbPList      *headerList;

    static SbDict       *conversionDict;

    static uint32_t     getConversionKey(SoType fromField, SoType toField)
        { return (fromField.getKey() << 16) | toField.getKey(); }

    static void         iv2_1PreCallback(void *userData, SoInput *in);
    static void         iv2_0PreCallback(void *userData, SoInput *in);
    static void         iv1_0PreCallback(void *userData, SoInput *in);
    static void         iv2_0PostCallback(void *userData, SoInput *in);
    static void         iv1_0PostCallback(void *userData, SoInput *in);
    
};

#endif /* _SO_DB_ */