Coin Logo http://www.sim.no
http://www.coin3d.org

SoDB.h
1 #ifndef COIN_SODB_H
2 #define COIN_SODB_H
3 
4 /**************************************************************************\
5  *
6  * This file is part of the Coin 3D visualization library.
7  * Copyright (C) 1998-2007 by Systems in Motion. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * ("GPL") version 2 as published by the Free Software Foundation.
12  * See the file LICENSE.GPL at the root directory of this source
13  * distribution for additional information about the GNU GPL.
14  *
15  * For using Coin with software that can not be combined with the GNU
16  * GPL, and for taking advantage of the additional benefits of our
17  * support services, please contact Systems in Motion about acquiring
18  * a Coin Professional Edition License.
19  *
20  * See http://www.coin3d.org/ for more information.
21  *
22  * Systems in Motion, Postboks 1283, Pirsenteret, 7462 Trondheim, NORWAY.
23  * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
24  *
25 \**************************************************************************/
26 
27 #include <Inventor/SbBasic.h>
28 #include <Inventor/SbString.h>
29 #include <Inventor/SoType.h>
30 #include <Inventor/sensors/SoSensorManager.h>
31 
32 class SbName;
33 class SbTime;
34 class SoBase;
35 class SoField;
36 class SoInput;
37 class SoNode;
38 class SoPath;
39 class SoSeparator;
40 class SoVRMLGroup;
41 class SoGroup;
42 
43 typedef void SoDBHeaderCB(void * data, SoInput * in);
44 
45 
46 class COIN_DLL_API SoDB {
47 public:
48  static void init(void);
49  static void finish(void);
50  static void cleanup(void);
51 
52  static const char * getVersion(void);
53  static SbBool read(SoInput * in, SoPath *& path);
54  static SbBool read(SoInput * in, SoBase *& base);
55  static SbBool read(SoInput * in, SoNode *& rootnode);
56  static SoSeparator * readAll(SoInput * in);
57  static SoVRMLGroup * readAllVRML(SoInput * in);
58  static SbBool isValidHeader(const char * teststring);
59  static SbBool registerHeader(const SbString & headerstring,
60  SbBool isbinary,
61  float ivversion,
62  SoDBHeaderCB * precallback,
63  SoDBHeaderCB * postcallback,
64  void * userdata = NULL);
65  static SbBool getHeaderData(const SbString & headerstring,
66  SbBool & isbinary,
67  float & ivversion,
68  SoDBHeaderCB *& precallback,
69  SoDBHeaderCB *& postcallback,
70  void *& userdata,
71  SbBool substringok = FALSE);
72  static int getNumHeaders(void);
73  static SbString getHeaderString(const int i);
74  static SoField * createGlobalField(const SbName & name, SoType type);
75  static SoField * getGlobalField(const SbName & name);
76  static void renameGlobalField(const SbName & from, const SbName & to);
77 
78  static void setRealTimeInterval(const SbTime & interval);
79  static const SbTime & getRealTimeInterval(void);
80  static void enableRealTimeSensor(SbBool on);
81 
82  static SoSensorManager * getSensorManager(void);
83  static void setDelaySensorTimeout(const SbTime & t);
84  static const SbTime & getDelaySensorTimeout(void);
85  static int doSelect(int nfds, void * readfds, void * writefds,
86  void * exceptfds, struct timeval * usertimeout);
87 
88  static void addConverter(SoType from, SoType to, SoType converter);
89  static SoType getConverter(SoType from, SoType to);
90 
91  static SbBool isInitialized(void);
92 
93  static void startNotify(void);
94  static SbBool isNotifying(void);
95  static void endNotify(void);
96 
97  typedef SbBool ProgressCallbackType(const SbName & itemid, float fraction,
98  SbBool interruptible, void * userdata);
99  static void addProgressCallback(ProgressCallbackType * func, void * userdata);
100  static void removeProgressCallback(ProgressCallbackType * func, void * userdata);
101 
102  static SbBool isMultiThread(void);
103  static void readlock(void);
104  static void readunlock(void);
105  static void writelock(void);
106  static void writeunlock(void);
107 
108  static void createRoute(SoNode * from, const char * eventout,
109  SoNode * to, const char * eventin);
110  static void removeRoute(SoNode * from, const char * eventout,
111  SoNode * to, const char * eventin);
112 
113 private:
114  static SoGroup * readAllWrapper(SoInput * in, const SoType & grouptype);
115 };
116 
117 #endif // !COIN_SODB_H
SoDB::getGlobalField
static SoField * getGlobalField(const SbName &name)
Definition: SoDB.cpp:1297
SoType::badType
static SoType badType(void)
Definition: SoType.cpp:664
SoDB::isNotifying
static SbBool isNotifying(void)
Definition: SoDB.cpp:1529
SoReadError::post
static void post(const SoInput *const in, const char *const format,...)
Definition: SoReadError.cpp:110
SoDB::doSelect
static int doSelect(int nfds, void *readfds, void *writefds, void *exceptfds, struct timeval *usertimeout)
Definition: SoDB.cpp:1442
SoFieldContainer::getField
virtual SoField * getField(const SbName &name) const
Definition: SoFieldContainer.cpp:364
SbName
The SbName class stores strings by reference.
Definition: SbName.h:31
SoDB::getRealTimeInterval
static const SbTime & getRealTimeInterval(void)
Definition: SoDB.cpp:1388
SoTimerSensor::getInterval
const SbTime & getInterval(void) const
Definition: SoTimerSensor.cpp:128
SoDB::renameGlobalField
static void renameGlobalField(const SbName &from, const SbName &to)
Definition: SoDB.cpp:1311
SoDebugError::post
static void post(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:314
SoType::fromKey
static SoType fromKey(uint16_t key)
Definition: SoType.cpp:614
SoSensor
The SoSensor class is the abstract base class for all sensors.
Definition: SoSensor.h:34
SoEngineOutput
The SoEngineOutput class is the output slots in SoEngine instances.
Definition: SoEngineOutput.h:36
SoDB::getConverter
static SoType getConverter(SoType from, SoType to)
Definition: SoDB.cpp:1494
SoDB::getVersion
static const char * getVersion(void)
Definition: SoDB.cpp:874
SoInput::init
static void init(void)
Definition: SoInput.cpp:2144
SoSensorManager::setChangedCallback
void setChangedCallback(void(*sensorQueueChangedCB)(void *), void *data)
Definition: SoSensorManager.cpp:789
SoType::init
static void init(void)
Definition: SoType.cpp:210
SoBase::getName
virtual SbName getName(void) const
Definition: SoBase.cpp:730
SbRWMutex::readUnlock
int readUnlock(void)
Definition: SbRWMutex.h:58
SoInput::popFile
virtual SbBool popFile(void)
Definition: SoInput.cpp:2448
SoSensorManager::getDelaySensorTimeout
const SbTime & getDelaySensorTimeout(void)
Definition: SoSensorManager.cpp:774
SbString::getSubString
SbString getSubString(int startidx, int endidx=-1) const
Definition: SbString.h:73
SoDB::isValidHeader
static SbBool isValidHeader(const char *teststring)
Definition: SoDB.cpp:1078
SoBase::getClassTypeId
static SoType getClassTypeId(void)
Definition: SoBase.cpp:720
SoDB::registerHeader
static SbBool registerHeader(const SbString &headerstring, SbBool isbinary, float ivversion, SoDBHeaderCB *precallback, SoDBHeaderCB *postcallback, void *userdata=NULL)
Definition: SoDB.cpp:1116
SoDebugError::postWarning
static void postWarning(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:324
SoSensor::setFunction
void setFunction(SoSensorCB *callbackfunction)
Definition: SoSensor.cpp:138
SoDB::cleanup
static void cleanup(void)
Definition: SoDB.cpp:864
SoInput::get
virtual SbBool get(char &c)
Definition: SoInput.cpp:1113
SoEngineOutput::getForwardConnections
int getForwardConnections(SoFieldList &fl) const
Definition: SoEngineOutput.cpp:109
SoDB::removeProgressCallback
static void removeProgressCallback(ProgressCallbackType *func, void *userdata)
Definition: SoDB.cpp:1781
SoDB::setDelaySensorTimeout
static void setDelaySensorTimeout(const SbTime &t)
Definition: SoDB.cpp:1400
SoGroup::addChild
virtual void addChild(SoNode *node)
Definition: SoGroup.cpp:393
SbList::append
void append(const Type item)
Definition: SbList.h:98
SbString
The SbString class is a string class with convenience functions for string operations.
Definition: SbString.h:42
SoDB::endNotify
static void endNotify(void)
Definition: SoDB.cpp:1538
SoType::isDerivedFrom
SbBool isDerivedFrom(const SoType type) const
Definition: SoType.cpp:687
SoDB::addProgressCallback
static void addProgressCallback(ProgressCallbackType *func, void *userdata)
Definition: SoDB.cpp:1766
SoDB::isMultiThread
static SbBool isMultiThread(void)
Definition: SoDB.cpp:1796
SoBase::unref
void unref(void) const
Definition: SoBase.cpp:627
SoField
The SoField class is the top-level abstract base class for fields.
Definition: SoField.h:38
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition: SoPath.h:43
SoDB::getHeaderData
static SbBool getHeaderData(const SbString &headerstring, SbBool &isbinary, float &ivversion, SoDBHeaderCB *&precallback, SoDBHeaderCB *&postcallback, void *&userdata, SbBool substringok=0)
Definition: SoDB.cpp:1164
SoElement::initClass
static void initClass(void)
Definition: SoElement.cpp:483
SoType
The SoType class is the basis for the run-time type system in Coin.
Definition: SoType.h:50
SbList< SoDB_HeaderInfo * >
SbName::getString
const char * getString(void) const
Definition: SbName.cpp:278
SoDebugError::postInfo
static void postInfo(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:334
SoDB::createRoute
static void createRoute(SoNode *from, const char *eventout, SoNode *to, const char *eventin)
Definition: SoDB.cpp:1934
SoField::initClass
static void initClass(void)
Definition: SoField.cpp:600
SoDB::writeunlock
static void writeunlock(void)
Definition: SoDB.cpp:1879
SoBase::read
static SbBool read(SoInput *in, SoBase *&base, SoType expectedtype)
Definition: SoBase.cpp:1146
SbList::getLength
int getLength(void) const
Definition: SbList.h:145
SoInput::putBack
virtual void putBack(const char c)
Definition: SoInput.cpp:1834
SoDB::isInitialized
static SbBool isInitialized(void)
Definition: SoDB.cpp:1508
SoDB::read
static SbBool read(SoInput *in, SoPath *&path)
Definition: SoDB.cpp:894
SoTimerSensor::setInterval
void setInterval(const SbTime &interval)
Definition: SoTimerSensor.cpp:117
SoDB::getDelaySensorTimeout
static const SbTime & getDelaySensorTimeout(void)
Definition: SoDB.cpp:1412
SoHardCopy::init
static void init(void)
Definition: HardCopy.cpp:134
SoType::getKey
int16_t getKey(void) const
Definition: SoType.h:110
SoFieldList
The SoFieldList class is a container for pointers to SoField objects.
Definition: SoFieldList.h:31
SoBase
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition: SoBase.h:41
SoInput::isValidFile
virtual SbBool isValidFile(void)
Definition: SoInput.cpp:892
SoDetail::initClass
static void initClass(void)
Definition: SoDetail.cpp:130
SoTimerSensor
The SoTimerSensor class is a sensor which will trigger at given intervals.
Definition: SoTimerSensor.h:29
SoEngineOutput::getConnectionType
SoType getConnectionType(void) const
Definition: SoEngineOutput.cpp:88
SoDB::readlock
static void readlock(void)
Definition: SoDB.cpp:1828
SoDB::removeRoute
static void removeRoute(SoNode *from, const char *eventout, SoNode *to, const char *eventin)
Definition: SoDB.cpp:2033
SoBase::ref
void ref(void) const
Definition: SoBase.cpp:574
SoNodeEngine
SoNodeEngine is the base class for Coin node engines.
Definition: SoNodeEngine.h:33
SoDB::readAllVRML
static SoVRMLGroup * readAllVRML(SoInput *in)
Definition: SoDB.cpp:1062
SoDB::finish
static void finish(void)
Definition: SoDB.cpp:851
SoDB::getNumHeaders
static int getNumHeaders(void)
Definition: SoDB.cpp:1216
SoVRMLGroup
The SoVRMLGroup class is used for grouping VRML nodes.
Definition: SoVRMLGroup.h:35
SoDB::setRealTimeInterval
static void setRealTimeInterval(const SbTime &interval)
Definition: SoDB.cpp:1364
SoSensorManager
The SoSensorManager class handles the sensor queues.
Definition: SoSensorManager.h:34
SoType::createInstance
void * createInstance(void) const
Definition: SoType.cpp:803
SoField::getTypeId
virtual SoType getTypeId(void) const =0
SoTimerQueueSensor::isScheduled
virtual SbBool isScheduled(void) const
Definition: SoTimerQueueSensor.cpp:216
SbList::remove
void remove(const int index)
Definition: SbList.h:129
SbRWMutex::writeUnlock
int writeUnlock(void)
Definition: SbRWMutex.h:48
SoInput::getHeader
virtual SbString getHeader(void)
Definition: SoInput.cpp:1072
SoDB::startNotify
static void startNotify(void)
Definition: SoDB.cpp:1517
SoSFTime
The SoSFTime class is a container for an SbTime value.
Definition: SoSFTime.h:31
SoDB::init
static void init(void)
Definition: SoDB.cpp:548
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
SoInput::eof
virtual SbBool eof(void) const
Definition: SoInput.cpp:1796
SoEvent::initClass
static void initClass(void)
Definition: SoEvent.cpp:82
SoAction::initClass
static void initClass(void)
Definition: SoAction.cpp:392
SoInput::read
virtual SbBool read(char &c)
Definition: SoInput.cpp:1180
SoSeparator
The SoSeparator class is a state-preserving group node.
Definition: SoSeparator.h:34
SoDB::ProgressCallbackType
SbBool ProgressCallbackType(const SbName &itemid, float fraction, SbBool interruptible, void *userdata)
Definition: SoDB.h:97
SoInput::skipWhiteSpace
SbBool skipWhiteSpace(void)
Definition: SoInput.cpp:2433
SoDB::readAll
static SoSeparator * readAll(SoInput *in)
Definition: SoDB.cpp:1048
SoDB::writelock
static void writelock(void)
Definition: SoDB.cpp:1864
SbList::find
int find(const Type item) const
Definition: SbList.h:103
SoField::getFieldType
int getFieldType(void) const
Definition: SoField.cpp:2478
SoInput::isBinary
virtual SbBool isBinary(void)
Definition: SoInput.cpp:1096
SoDB::getSensorManager
static SoSensorManager * getSensorManager(void)
Definition: SoDB.cpp:1422
SbTime
The SbTime class instances represents time values.
Definition: SbTime.h:41
SbRWMutex
Definition: SbRWMutex.h:29
SbPList::find
int find(void *item) const
Definition: SbPList.cpp:212
SoInput
The SoInput class is an abstraction of file import functionality.
Definition: SoInput.h:55
SoSensorManager::setDelaySensorTimeout
void setDelaySensorTimeout(const SbTime &t)
Definition: SoSensorManager.cpp:745
SoGroup::getChild
virtual SoNode * getChild(int index) const
Definition: SoGroup.cpp:257
SoField::disconnect
void disconnect(SoEngineOutput *engineoutput)
Definition: SoField.cpp:1022
SoBase::isOfType
SbBool isOfType(SoType type) const
Definition: SoBase.cpp:710
SoField::getForwardConnections
int getForwardConnections(SoFieldList &slavelist) const
Definition: SoField.cpp:1214
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:47
SoDB
The SoDB class keeps track of internal global data.
Definition: SoDB.h:46
SoGroup::getNumChildren
virtual int getNumChildren(void) const
Definition: SoGroup.cpp:271
SoTimerSensor::unschedule
virtual void unschedule(void)
Definition: SoTimerSensor.cpp:214
SoDB::addConverter
static void addConverter(SoType from, SoType to, SoType converter)
Definition: SoDB.cpp:1467
SoType::getName
SbName getName(void) const
Definition: SoType.cpp:628
SbTime::getTimeOfDay
static SbTime getTimeOfDay(void)
Definition: SbTime.cpp:139
SoGroup
The SoGroup class is a node which managed other node instances.
Definition: SoGroup.h:31
SoTimerSensor::schedule
virtual void schedule(void)
Definition: SoTimerSensor.cpp:180
SoBase::initClass
static void initClass(void)
Definition: SoBase.cpp:455
SbTime::zero
static SbTime zero(void)
Definition: SbTime.cpp:164
SoField::connectFrom
SbBool connectFrom(SoEngineOutput *master, SbBool notnotify=0, SbBool append=0)
Definition: SoField.cpp:870
SbString::getLength
int getLength(void) const
Definition: SbString.h:63
SoBase::unrefNoDelete
void unrefNoDelete(void) const
Definition: SoBase.cpp:665
SoDB::getHeaderString
static SbString getHeaderString(const int i)
Definition: SoDB.cpp:1227
SbString::getString
const char * getString(void) const
Definition: SbString.h:71
SoError::initClasses
static void initClasses(void)
Definition: SoError.cpp:110
SoSensorManager::isDelaySensorPending
SbBool isDelaySensorPending(void)
Definition: SoSensorManager.cpp:697
SoSensorManager::processImmediateQueue
void processImmediateQueue(void)
Definition: SoSensorManager.cpp:612
SoDB::createGlobalField
static SoField * createGlobalField(const SbName &name, SoType type)
Definition: SoDB.cpp:1253
SoDB::readunlock
static void readunlock(void)
Definition: SoDB.cpp:1843
SbRWMutex::readLock
int readLock(void)
Definition: SbRWMutex.h:52
SoSensor::initClass
static void initClass(void)
Definition: SoSensor.cpp:212
SoDB::enableRealTimeSensor
static void enableRealTimeSensor(SbBool on)
Definition: SoDB.cpp:1564
SbRWMutex::writeLock
int writeLock(void)
Definition: SbRWMutex.h:42
SoType::canCreateInstance
SbBool canCreateInstance(void) const
Definition: SoType.cpp:786

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Wed Jul 24 2019 for Coin by Doxygen. 1.8.17