Inheritance diagram for osgDB::DatabasePager:
typedef OpenThreads::Thread::ThreadPriority osgDB::DatabasePager::ThreadPriority |
typedef std::list< osg::ref_ptr<osg::PagedLOD> > osgDB::DatabasePager::PagedLODList |
typedef std::set< osg::ref_ptr<osg::StateSet> > osgDB::DatabasePager::StateSetList |
typedef std::vector< osg::ref_ptr<osg::Drawable> > osgDB::DatabasePager::DrawableList |
typedef std::pair<StateSetList,DrawableList> osgDB::DatabasePager::DataToCompile |
typedef std::map< unsigned int, DataToCompile > osgDB::DatabasePager::DataToCompileMap |
typedef std::set<unsigned int> osgDB::DatabasePager::ActiveGraphicsContexts |
typedef std::vector< osg::ref_ptr<DatabaseRequest> > osgDB::DatabasePager::DatabaseRequestList [protected] |
typedef std::vector< osg::ref_ptr<osg::Object> > osgDB::DatabasePager::ObjectList [protected] |
osgDB::DatabasePager::DatabasePager | ( | ) |
virtual osgDB::DatabasePager::~DatabasePager | ( | ) | [protected, virtual] |
virtual void osgDB::DatabasePager::requestNodeFile | ( | const std::string & | fileName, | |
osg::Group * | group, | |||
float | priority, | |||
const osg::FrameStamp * | framestamp | |||
) | [virtual] |
Add a request to load a node file to end the the database request list.
Implements osg::NodeVisitor::DatabaseRequestHandler.
virtual void osgDB::DatabasePager::run | ( | ) | [virtual] |
Run does the database paging.
virtual int osgDB::DatabasePager::cancel | ( | ) | [virtual] |
Cancel the database pager thread.
virtual void osgDB::DatabasePager::clear | ( | ) | [virtual] |
Clear all internally cached structures.
void osgDB::DatabasePager::setDatabasePagerThreadPause | ( | bool | pause | ) |
Set whether the database pager thread should be paused or not.
bool osgDB::DatabasePager::getDatabasePagerThreadPause | ( | ) | const [inline] |
Get whether the database pager thread should is paused or not.
void osgDB::DatabasePager::setAcceptNewDatabaseRequests | ( | bool | acceptNewRequests | ) | [inline] |
Set whether new database request calls are accepted or ignored.
bool osgDB::DatabasePager::getAcceptNewDatabaseRequests | ( | ) | const [inline] |
Get whether new database request calls are accepted or ignored.
void osgDB::DatabasePager::setUseFrameBlock | ( | bool | useFrameBlock | ) | [inline] |
Set the use of the frame block which, if enabled, blocks the DatabasePager from executing which the current frame is being drawn. When a single processor machine is being used it can be useful to block on frame to help prevent the database paging thread from slowing the cull and draw traversals which in turn can cause frame drops.
bool osgDB::DatabasePager::getUseFrameBlock | ( | ) | const [inline] |
Get the whether UseFrameBlock is on or off.
osg::Block* osgDB::DatabasePager::getFrameBlock | ( | ) | [inline] |
void osgDB::DatabasePager::setThreadPriorityDuringFrame | ( | ThreadPriority | duringFrame | ) | [inline] |
Set the priority of the database pager thread during the frame (i.e. while cull and draw are running.)
ThreadPriority osgDB::DatabasePager::getThreadPriorityDuringFrame | ( | ) | const [inline] |
Get the priority of the database pager thread during the frame
void osgDB::DatabasePager::setThreadPriorityOutwithFrame | ( | ThreadPriority | outwithFrame | ) | [inline] |
Set the priority of the database pager thread when the frame is not being exectuted (i.e. before or after cull and draw have run.)
ThreadPriority osgDB::DatabasePager::getThreadPriorityOutwithFrame | ( | ) | const [inline] |
Get the priority of the database pager thread when the frame is not being exectuted.
int osgDB::DatabasePager::getNumFramesActive | ( | ) | const [inline] |
Get the number of frames that are currently active.
virtual void osgDB::DatabasePager::signalBeginFrame | ( | const osg::FrameStamp * | framestamp | ) | [virtual] |
Signal the database thread that the update, cull and draw has begun for a new frame. Note, this is called by the application so that the database pager can go to sleep while the CPU is busy on the main rendering threads.
virtual void osgDB::DatabasePager::signalEndFrame | ( | ) | [virtual] |
Signal the database thread that the update, cull and draw dispatch has completed. Note, this is called by the application so that the database pager can go to wake back up now the main rendering threads are iddle waiting for the next frame.
virtual void osgDB::DatabasePager::registerPagedLODs | ( | osg::Node * | subgraph | ) | [virtual] |
Find all PagedLOD nodes in a subgraph and register them with the DatabasePager so it can keep track of expired nodes. note, should be only be called from the update thread.
void osgDB::DatabasePager::setDoPreCompile | ( | bool | flag | ) | [inline] |
Set whether the database pager should pre compile OpenGL objects before allowing them to be merged into the scene graph. Pre compilation helps reduce the chances of frame drops, but also slows the speed at which tiles are merged as they have to be compiled first.
bool osgDB::DatabasePager::getDoPreCompile | ( | ) | const [inline] |
Get whether the database pager should pre compile OpenGL objects before allowing them to be merged into the scene graph.
void osgDB::DatabasePager::setTargetFrameRate | ( | double | tfr | ) | [inline] |
Set the target frame rate that the DatabasePager should assume. Typically one would set this to the value refresh rate of your display system i.e. 60Hz. Default value is 100. Usage notes. The TargetFrameRate and the MinimumTimeAvailableForGLCompileAndDeletePerFrame parameters are not directly used by DatabasePager, but are should be used as a guide for how long to set aside per frame for compiling and deleting OpenGL objects - ie. the value to use when calling DatabasePager::compileGLObjectgs(state,availableTime,). The longer amount of time to set aside cthe faster databases will be paged in but with increased chance of frame drops, the lower the amount of time the set aside the slower databases will paged it but with better chance of avoid any frame drops. The default values are chosen to achieve the later when running on a modern mid to high end PC. The way to compute the amount of available time use a scheme such as : availableTime = maximum(1.0/targetFrameRate - timeTakenDuringUpdateCullAndDraw, minimumTimeAvailableForGLCompileAndDeletePerFrame).
double osgDB::DatabasePager::getTargetFrameRate | ( | ) | const [inline] |
Get the target frame rate that the DatabasePager should assume.
void osgDB::DatabasePager::setMinimumTimeAvailableForGLCompileAndDeletePerFrame | ( | double | ta | ) | [inline] |
Set the minimum amount of time (in seconds) that should be made available for compiling and delete OpenGL objects per frame. Default value is 0.001 (1 millisecond). For usage see notes in setTargetFrameRate.
double osgDB::DatabasePager::getMinimumTimeAvailableForGLCompileAndDeletePerFrame | ( | ) | const [inline] |
Get the minimum amount of time that should be made available for compiling and delete OpenGL objects per frame. For usage see notes in setTargetFrameRate.
void osgDB::DatabasePager::setMaximumNumOfObjectsToCompilePerFrame | ( | unsigned int | num | ) | [inline] |
Set the maximum number of OpenGL objects that the page should attempt to compile per frame. Note, Lower values reduces chances of a frame drop but lower the rate that database will be paged in at. Default value is 8.
unsigned int osgDB::DatabasePager::getMaximumNumOfObjectsToCompilePerFrame | ( | ) | const [inline] |
Get the maximum number of OpenGL objects that the page should attempt to compile per frame.
void osgDB::DatabasePager::setExpiryDelay | ( | double | expiryDelay | ) | [inline] |
Set the amount of time that a subgraph will be kept without being visited in the cull traversal before being removed.
double osgDB::DatabasePager::getExpiryDelay | ( | ) | const [inline] |
Get the amount of time that a subgraph will be kept without being visited in the cull traversal before being removed.
void osgDB::DatabasePager::setDeleteRemovedSubgraphsInDatabaseThread | ( | bool | flag | ) | [inline] |
Set whether the removed subgraphs should be deleted in the database thread or not.
bool osgDB::DatabasePager::getDeleteRemovedSubgraphsInDatabaseThread | ( | ) | const [inline] |
Get whether the removed subgraphs should be deleted in the database thread or not.
void osgDB::DatabasePager::setDrawablePolicy | ( | DrawablePolicy | policy | ) | [inline] |
Set how loaded drawables should be handled w.r.t their display list/vertex buffer object/vertex array settings.
DrawablePolicy osgDB::DatabasePager::getDrawablePolicy | ( | ) | const [inline] |
Get how loaded drawables should be handled w.r.t their display list/vertex buffer object/vertex array settings.
void osgDB::DatabasePager::setUnrefImageDataAfterApplyPolicy | ( | bool | changeAutoUnRef, | |
bool | valueAutoUnRef | |||
) | [inline] |
Set whether newly loaded textures should have their UnrefImageDataAfterApply set to a specified value.
void osgDB::DatabasePager::getUnrefImageDataAfterApplyPolicy | ( | bool & | changeAutoUnRef, | |
bool & | valueAutoUnRef | |||
) | const [inline] |
Get whether newly loaded textures should have their UnrefImageDataAfterApply set to a specified value.
void osgDB::DatabasePager::setMaxAnisotropyPolicy | ( | bool | changeAnisotropy, | |
float | valueAnisotropy | |||
) | [inline] |
Set whether newly loaded textures should have their MaxAnisotopy set to a specified value.
void osgDB::DatabasePager::getMaxAnisotropyPolicy | ( | bool & | changeAnisotropy, | |
float & | valueAnisotropy | |||
) | const [inline] |
Set whether newly loaded textures should have their MaxAnisotopy set to a specified value.
bool osgDB::DatabasePager::requiresUpdateSceneGraph | ( | ) | const |
Return true if there are pending updates to the scene graph that require a call to updateSceneGraph(double).
virtual void osgDB::DatabasePager::updateSceneGraph | ( | double | currentFrameTime | ) | [inline, virtual] |
Merge the changes to the scene graph by calling calling removeExpiredSubgraphs then addLoadedDataToSceneGraph. Note, must only be called from single thread update phase.
void osgDB::DatabasePager::setCompileGLObjectsForContextID | ( | unsigned int | contextID, | |
bool | on | |||
) |
Turn the compilation of rendering objects for specfied graphics context on (true) or off(false).
bool osgDB::DatabasePager::getCompileGLObjectsForContextID | ( | unsigned int | contextID | ) |
Get whether the compilation of rendering objects for specfied graphics context on (true) or off(false).
bool osgDB::DatabasePager::requiresCompileGLObjects | ( | ) | const |
Return true if there are pending compile operations that are required. If requiresCompileGLObjects() return true the application should call compileGLObjects() .
virtual void osgDB::DatabasePager::compileGLObjects | ( | osg::State & | state, | |
double & | availableTime | |||
) | [virtual] |
Compile the rendering objects (display lists,texture objects, VBO's) on loaded subgraph. note, should only be called from the draw thread. Note, must only be called from a valid graphics context.
unsigned int osgDB::DatabasePager::getFileRequestListSize | ( | ) | const [inline] |
Report how many items are in the _fileRequestList queue
unsigned int osgDB::DatabasePager::getDataToCompileListSize | ( | ) | const [inline] |
Report how many items are in the _dataToCompileList queue
void osgDB::DatabasePager::updateDatabasePagerThreadBlock | ( | ) | [inline, protected] |
void osgDB::DatabasePager::updateFrameBlock | ( | int | delta | ) | [inline, protected] |
virtual void osgDB::DatabasePager::removeExpiredSubgraphs | ( | double | currentFrameTime | ) | [protected, virtual] |
Iterate through the active PagedLOD nodes children removing children which havn't been visited since specified expiryTime. note, should be only be called from the update thread.
void osgDB::DatabasePager::addLoadedDataToSceneGraph | ( | double | currentFrameTime | ) | [protected] |
Add the loaded data to the scene graph.
friend struct DatabaseRequest [friend] |
friend class FindCompileableGLObjectsVisitor [friend] |
friend class FindPagedLODsVisitor [friend] |
friend struct SortFileRequestFunctor [friend] |
OpenThreads::Mutex osgDB::DatabasePager::_run_mutex [protected] |
bool osgDB::DatabasePager::_startThreadCalled [protected] |
bool osgDB::DatabasePager::_done [protected] |
bool osgDB::DatabasePager::_acceptNewRequests [protected] |
bool osgDB::DatabasePager::_databasePagerThreadPaused [protected] |
bool osgDB::DatabasePager::_useFrameBlock [protected] |
int osgDB::DatabasePager::_numFramesActive [protected] |
OpenThreads::Mutex osgDB::DatabasePager::_numFramesActiveMutex [mutable, protected] |
osg::ref_ptr<osg::Block> osgDB::DatabasePager::_frameBlock [protected] |
int osgDB::DatabasePager::_frameNumber [protected] |
OpenThreads::Mutex osgDB::DatabasePager::_fileRequestListMutex [mutable, protected] |
OpenThreads::Mutex osgDB::DatabasePager::_dataToCompileListMutex [mutable, protected] |
DrawablePolicy osgDB::DatabasePager::_drawablePolicy [protected] |
bool osgDB::DatabasePager::_changeAutoUnRef [protected] |
bool osgDB::DatabasePager::_valueAutoUnRef [protected] |
bool osgDB::DatabasePager::_changeAnisotropy [protected] |
float osgDB::DatabasePager::_valueAnisotropy [protected] |
bool osgDB::DatabasePager::_deleteRemovedSubgraphsInDatabaseThread [protected] |
OpenThreads::Mutex osgDB::DatabasePager::_childrenToDeleteListMutex [mutable, protected] |
OpenThreads::Mutex osgDB::DatabasePager::_dataToMergeListMutex [mutable, protected] |
double osgDB::DatabasePager::_expiryDelay [protected] |
bool osgDB::DatabasePager::_doPreCompile [protected] |
double osgDB::DatabasePager::_targetFrameRate [protected] |
double osgDB::DatabasePager::_minimumTimeAvailableForGLCompileAndDeletePerFrame [protected] |
unsigned int osgDB::DatabasePager::_maximumNumOfObjectsToCompilePerFrame [protected] |