OpenSceneGraph
Classes | Public Member Functions | Protected Types | Protected Attributes | Friends | List of all members
osgDB::ImagePager Class Reference
Inheritance diagram for osgDB::ImagePager:
Inheritance graph
[legend]
Collaboration diagram for osgDB::ImagePager:
Collaboration graph
[legend]

Classes

struct  ImageRequest
 
class  ImageThread
 
struct  ReadQueue
 
struct  RequestQueue
 

Public Member Functions

ImageThreadgetImageThread (unsigned int i)
 
const ImageThreadgetImageThread (unsigned int i) const
 
unsigned int getNumImageThreads () const
 
void setPreLoadTime (double preLoadTime)
 
virtual double getPreLoadTime () const
 
virtual osg::ImagereadImageFile (const std::string &fileName, const osg::Referenced *options=0)
 
virtual void requestImageFile (const std::string &fileName, osg::Object *attachmentPoint, int attachmentIndex, double timeToMergeBy, const osg::FrameStamp *framestamp, osg::ref_ptr< osg::Referenced > &imageRequest, const osg::Referenced *options)
 
virtual bool requiresUpdateSceneGraph () const
 Return true if there are pending updates to the scene graph that require a call to updateSceneGraph(double). More...
 
virtual void updateSceneGraph (const osg::FrameStamp &frameStamp)
 Merge the changes to the scene graph. More...
 
virtual void signalBeginFrame (const osg::FrameStamp *framestamp)
 Signal the image thread that the update, cull and draw has begun for a new frame. More...
 
virtual void signalEndFrame ()
 Signal the image thread that the update, cull and draw dispatch has completed. More...
 
int cancel ()
 
- Public Member Functions inherited from osg::Referenced
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Types

typedef std::vector< osg::ref_ptr< ImageThread > > ImageThreads
 

Protected Attributes

OpenThreads::Mutex _run_mutex
 
bool _startThreadCalled
 
bool _done
 
bool _databasePagerThreadPaused
 
OpenThreads::Atomic _frameNumber
 
OpenThreads::Mutex _ir_mutex
 
osg::ref_ptr< ReadQueue_readQueue
 
ImageThreads _imageThreads
 
osg::ref_ptr< RequestQueue_completedQueue
 
double _preLoadTime
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 
OpenThreads::Mutex_refMutex
 
int _refCount
 
void * _observerSet
 

Friends

struct SortFileRequestFunctor
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- Protected Member Functions inherited from osg::Referenced
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Member Function Documentation

◆ requiresUpdateSceneGraph()

virtual bool osgDB::ImagePager::requiresUpdateSceneGraph ( ) const
virtual

Return true if there are pending updates to the scene graph that require a call to updateSceneGraph(double).

◆ signalBeginFrame()

virtual void osgDB::ImagePager::signalBeginFrame ( const osg::FrameStamp framestamp)
virtual

Signal the image thread that the update, cull and draw has begun for a new frame.

Note, this is called by the application so that the image pager can go to sleep while the CPU is busy on the main rendering threads.

◆ signalEndFrame()

virtual void osgDB::ImagePager::signalEndFrame ( )
virtual

Signal the image thread that the update, cull and draw dispatch has completed.

Note, this is called by the application so that the image pager can go to wake back up now the main rendering threads are iddle waiting for the next frame.

◆ updateSceneGraph()

virtual void osgDB::ImagePager::updateSceneGraph ( const osg::FrameStamp frameStamp)
virtual

Merge the changes to the scene graph.


The documentation for this class was generated from the following file: