osgViewer::ViewerBase Class Reference

Inheritance diagram for osgViewer::ViewerBase:

osg::Object osg::Referenced osgViewer::CompositeViewer osgViewer::Viewer

List of all members.

Public Types

enum  ThreadingModel {
  SingleThreaded, CullDrawThreadPerContext, ThreadPerContext = CullDrawThreadPerContext, DrawThreadPerContext,
  CullThreadPerCameraDrawThreadPerContext, ThreadPerCamera = CullThreadPerCameraDrawThreadPerContext, AutomaticSelection
}
enum  BarrierPosition { BeforeSwapBuffers, AfterSwapBuffers }
enum  FrameScheme { ON_DEMAND, CONTINUOUS }
typedef std::vector
< osg::Camera * > 
Cameras
typedef std::vector
< osg::GraphicsContext * > 
Contexts
typedef std::vector
< osgViewer::GraphicsWindow * > 
Windows
typedef std::vector
< OpenThreads::Thread * > 
Threads
typedef std::vector
< osg::OperationThread * > 
OperationThreads
typedef std::vector
< osgViewer::Scene * > 
Scenes
typedef std::vector
< osgViewer::View * > 
Views

Public Member Functions

 ViewerBase ()
 ViewerBase (const ViewerBase &vb)
virtual void setViewerStats (osg::Stats *stats)=0
virtual osg::StatsgetViewerStats ()=0
virtual const osg::StatsgetViewerStats () const =0
virtual bool readConfiguration (const std::string &filename)=0
virtual bool isRealized () const =0
virtual void realize ()=0
virtual void setThreadingModel (ThreadingModel threadingModel)
ThreadingModel getThreadingModel () const
virtual ThreadingModel suggestBestThreadingModel ()
virtual void setUpThreading ()
bool areThreadsRunning () const
virtual void stopThreading ()
virtual void startThreading ()
void setEndBarrierPosition (BarrierPosition bp)
BarrierPosition getEndBarrierPosition () const
void setDone (bool done)
bool done () const
void setEventVisitor (osgGA::EventVisitor *eventVisitor)
osgGA::EventVisitorgetEventVisitor ()
const osgGA::EventVisitorgetEventVisitor () const
void setKeyEventSetsDone (int key)
int getKeyEventSetsDone () const
void setQuitEventSetsDone (bool flag)
bool getQuitEventSetsDone () const
void setReleaseContextAtEndOfFrameHint (bool hint)
bool getReleaseContextAtEndOfFrameHint () const
void setUpdateVisitor (osgUtil::UpdateVisitor *updateVisitor)
osgUtil::UpdateVisitorgetUpdateVisitor ()
const osgUtil::UpdateVisitorgetUpdateVisitor () const
void setUpdateOperations (osg::OperationQueue *operations)
osg::OperationQueuegetUpdateOperations ()
const osg::OperationQueuegetUpdateOperations () const
void addUpdateOperation (osg::Operation *operation)
void removeUpdateOperation (osg::Operation *operation)
void setRealizeOperation (osg::Operation *op)
osg::OperationgetRealizeOperation ()
void setIncrementalCompileOperation (osgUtil::IncrementalCompileOperation *ico)
osgUtil::IncrementalCompileOperationgetIncrementalCompileOperation ()
void checkWindowStatus ()
void setRunFrameScheme (FrameScheme fs)
FrameScheme getRunFrameScheme () const
void setRunMaxFrameRate (double frameRate)
double getRunMaxFrameRate () const
virtual int run ()
virtual bool checkNeedToDoFrame ()=0
virtual void frame (double simulationTime=USE_REFERENCE_TIME)
virtual void advance (double simulationTime=USE_REFERENCE_TIME)=0
virtual void eventTraversal ()=0
virtual void updateTraversal ()=0
virtual void renderingTraversals ()
virtual void getCameras (Cameras &cameras, bool onlyActive=true)=0
virtual void getContexts (Contexts &contexts, bool onlyValid=true)=0
virtual void getWindows (Windows &windows, bool onlyValid=true)
virtual void getAllThreads (Threads &threads, bool onlyActive=true)=0
virtual void getOperationThreads (OperationThreads &threads, bool onlyActive=true)=0
virtual void getScenes (Scenes &scenes, bool onlyValid=true)=0
virtual void getViews (Views &views, bool onlyValid=true)=0
virtual double elapsedTime ()=0
virtual osg::FrameStampgetViewerFrameStamp ()=0
virtual void getUsage (osg::ApplicationUsage &usage) const =0

Protected Member Functions

void viewerBaseInit ()
void makeCurrent (osg::GraphicsContext *gc)
void releaseContext ()
virtual void viewerInit ()=0

Protected Attributes

bool _firstFrame
bool _done
int _keyEventSetsDone
bool _quitEventSetsDone
bool _releaseContextAtEndOfFrameHint
ThreadingModel _threadingModel
bool _threadsRunning
bool _requestRedraw
bool _requestContinousUpdate
FrameScheme _runFrameScheme
double _runMaxFrameRate
BarrierPosition _endBarrierPosition
osg::ref_ptr
< osg::BarrierOperation
_startRenderingBarrier
osg::ref_ptr
< osg::BarrierOperation
_endRenderingDispatchBarrier
osg::ref_ptr
< osg::EndOfDynamicDrawBlock
_endDynamicDrawBlock
osg::ref_ptr< osgGA::EventVisitor_eventVisitor
osg::ref_ptr< osg::OperationQueue_updateOperations
osg::ref_ptr
< osgUtil::UpdateVisitor
_updateVisitor
osg::ref_ptr< osg::Operation_realizeOperation
osg::ref_ptr
< osgUtil::IncrementalCompileOperation
_incrementalCompileOperation
osg::observer_ptr
< osg::GraphicsContext
_currentContext

Friends

class osgViewer::View


Detailed Description

ViewerBase is the view base class that is inherited by both Viewer and CompositeViewer.

Member Typedef Documentation


Member Enumeration Documentation

Enumerator:
SingleThreaded 
CullDrawThreadPerContext 
ThreadPerContext 
DrawThreadPerContext 
CullThreadPerCameraDrawThreadPerContext 
ThreadPerCamera 
AutomaticSelection 

Enumerator:
BeforeSwapBuffers 
AfterSwapBuffers 

Enumerator:
ON_DEMAND 
CONTINUOUS 


Constructor & Destructor Documentation

osgViewer::ViewerBase::ViewerBase (  ) 

osgViewer::ViewerBase::ViewerBase ( const ViewerBase vb  ) 


Member Function Documentation

virtual void osgViewer::ViewerBase::setViewerStats ( osg::Stats stats  )  [pure virtual]

Set the Stats object used for collect various frame related timing and scene graph stats.

Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

virtual osg::Stats* osgViewer::ViewerBase::getViewerStats (  )  [pure virtual]

Get the Viewers Stats object.

Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

virtual const osg::Stats* osgViewer::ViewerBase::getViewerStats (  )  const [pure virtual]

Get the Viewers Stats object.

Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

virtual bool osgViewer::ViewerBase::readConfiguration ( const std::string &  filename  )  [pure virtual]

read the viewer configuration from a configuration file.

Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

virtual bool osgViewer::ViewerBase::isRealized (  )  const [pure virtual]

Get whether at least of one of this viewers windows are realized.

Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

virtual void osgViewer::ViewerBase::realize (  )  [pure virtual]

set up windows and associated threads.

Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

virtual void osgViewer::ViewerBase::setThreadingModel ( ThreadingModel  threadingModel  )  [virtual]

Set the threading model the rendering traversals will use.

ThreadingModel osgViewer::ViewerBase::getThreadingModel (  )  const [inline]

Get the threading model the rendering traversals will use.

virtual ThreadingModel osgViewer::ViewerBase::suggestBestThreadingModel (  )  [virtual]

Let the viewer suggest the best threading model for the viewers camera/window setup and the hardware available.

virtual void osgViewer::ViewerBase::setUpThreading (  )  [virtual]

Set up the threading and processor affinity as per the viewers threading model.

bool osgViewer::ViewerBase::areThreadsRunning (  )  const [inline]

Return true if viewer threads are running.

virtual void osgViewer::ViewerBase::stopThreading (  )  [virtual]

Stop any threads begin run by viewer.

virtual void osgViewer::ViewerBase::startThreading (  )  [virtual]

Start any threads required by the viewer.

void osgViewer::ViewerBase::setEndBarrierPosition ( BarrierPosition  bp  ) 

Set the position of the end barrier. AfterSwapBuffers may result in slightly higher framerates, but may lead to inconsistent swapping between different windows. BeforeSwapBuffers may lead to slightly lower framerate, but improve consistency in timing of swap buffers, especially important if you are likely to consistently break frame.

BarrierPosition osgViewer::ViewerBase::getEndBarrierPosition (  )  const [inline]

Get the end barrier position.

void osgViewer::ViewerBase::setDone ( bool  done  )  [inline]

Set the done flag to signal the viewer's work is done and should exit the frame loop.

bool osgViewer::ViewerBase::done (  )  const [inline]

Return true if viewer's work is done and should exit the frame loop.

void osgViewer::ViewerBase::setEventVisitor ( osgGA::EventVisitor eventVisitor  )  [inline]

Set the EventVisitor.

osgGA::EventVisitor* osgViewer::ViewerBase::getEventVisitor (  )  [inline]

Get the EventVisitor.

const osgGA::EventVisitor* osgViewer::ViewerBase::getEventVisitor (  )  const [inline]

Get the const EventVisitor.

void osgViewer::ViewerBase::setKeyEventSetsDone ( int  key  )  [inline]

Set the key event that the viewer checks on each frame to see if the viewer's done flag should be set to signal end of viewers main loop. Default value is Escape (osgGA::GUIEVentAdapter::KEY_Escape). Setting to 0 switches off the feature.

int osgViewer::ViewerBase::getKeyEventSetsDone (  )  const [inline]

get the key event that the viewer checks on each frame to see if the viewer's done flag.

void osgViewer::ViewerBase::setQuitEventSetsDone ( bool  flag  )  [inline]

if the flag is true, the viewer set its done flag when a QUIT_APPLICATION is received, false disables this feature

bool osgViewer::ViewerBase::getQuitEventSetsDone (  )  const [inline]

Returns:
true if the viewer respond to the QUIT_APPLICATION-event

void osgViewer::ViewerBase::setReleaseContextAtEndOfFrameHint ( bool  hint  )  [inline]

Hint to tell the renderingTraversals() method whether to call relaseContext() on the last context that was made current by the thread calling renderingTraverals(). Note, when running multi-threaded viewer no threads will be made current or release current. Setting this hint to false can enable the frame loop to be lazy about calling makeCurrent and releaseContext on each new frame, helping performance. However, if you frame loop is managing multiple graphics context all from the main frame thread then this hint must be left on, otherwise the wrong context could be left active, introducing errors in rendering.

bool osgViewer::ViewerBase::getReleaseContextAtEndOfFrameHint (  )  const [inline]

Hint to tell the renderingTraversals() method whether to call relaseContext().

void osgViewer::ViewerBase::setUpdateVisitor ( osgUtil::UpdateVisitor updateVisitor  )  [inline]

Set the UpdateVisitor.

osgUtil::UpdateVisitor* osgViewer::ViewerBase::getUpdateVisitor (  )  [inline]

Get the UpdateVisitor.

const osgUtil::UpdateVisitor* osgViewer::ViewerBase::getUpdateVisitor (  )  const [inline]

Get the const UpdateVisitor.

void osgViewer::ViewerBase::setUpdateOperations ( osg::OperationQueue operations  )  [inline]

Set the Update OperationQueue.

osg::OperationQueue* osgViewer::ViewerBase::getUpdateOperations (  )  [inline]

Get the Update OperationQueue.

const osg::OperationQueue* osgViewer::ViewerBase::getUpdateOperations (  )  const [inline]

Get the const Update OperationQueue.

void osgViewer::ViewerBase::addUpdateOperation ( osg::Operation operation  ) 

Add an update operation.

void osgViewer::ViewerBase::removeUpdateOperation ( osg::Operation operation  ) 

Remove an update operation.

void osgViewer::ViewerBase::setRealizeOperation ( osg::Operation op  )  [inline]

Set the graphics operation to call on realization of the viewers graphics windows.

osg::Operation* osgViewer::ViewerBase::getRealizeOperation (  )  [inline]

Get the graphics operation to call on realization of the viewers graphics windows.

void osgViewer::ViewerBase::setIncrementalCompileOperation ( osgUtil::IncrementalCompileOperation ico  ) 

Set the incremental compile operation. Used to manage the OpenGL object compilation and merging of subgraphs in a way that avoids overloading the rendering of frame with too many new objects in one frame.

osgUtil::IncrementalCompileOperation* osgViewer::ViewerBase::getIncrementalCompileOperation (  )  [inline]

Get the incremental compile operation.

void osgViewer::ViewerBase::checkWindowStatus (  ) 

Check to see if windows are still open, if not set viewer done to true.

void osgViewer::ViewerBase::setRunFrameScheme ( FrameScheme  fs  )  [inline]

FrameScheme osgViewer::ViewerBase::getRunFrameScheme (  )  const [inline]

void osgViewer::ViewerBase::setRunMaxFrameRate ( double  frameRate  )  [inline]

double osgViewer::ViewerBase::getRunMaxFrameRate (  )  const [inline]

virtual int osgViewer::ViewerBase::run (  )  [virtual]

Execute a main frame loop. Equivalent to while (!viewer.done()) viewer.frame(); Also calls realize() if the viewer is not already realized, and installs trackball manipulator if one is not already assigned.

Reimplemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

virtual bool osgViewer::ViewerBase::checkNeedToDoFrame (  )  [pure virtual]

check to see if the new frame is required, called by run(..) when FrameScheme is set to ON_DEMAND.

Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

virtual void osgViewer::ViewerBase::frame ( double  simulationTime = USE_REFERENCE_TIME  )  [virtual]

Render a complete new frame. Calls advance(), eventTraversal(), updateTraversal(), renderingTraversals().

virtual void osgViewer::ViewerBase::advance ( double  simulationTime = USE_REFERENCE_TIME  )  [pure virtual]

virtual void osgViewer::ViewerBase::eventTraversal (  )  [pure virtual]

virtual void osgViewer::ViewerBase::updateTraversal (  )  [pure virtual]

virtual void osgViewer::ViewerBase::renderingTraversals (  )  [virtual]

virtual void osgViewer::ViewerBase::getCameras ( Cameras cameras,
bool  onlyActive = true 
) [pure virtual]

virtual void osgViewer::ViewerBase::getContexts ( Contexts contexts,
bool  onlyValid = true 
) [pure virtual]

virtual void osgViewer::ViewerBase::getWindows ( Windows windows,
bool  onlyValid = true 
) [virtual]

virtual void osgViewer::ViewerBase::getAllThreads ( Threads threads,
bool  onlyActive = true 
) [pure virtual]

virtual void osgViewer::ViewerBase::getOperationThreads ( OperationThreads threads,
bool  onlyActive = true 
) [pure virtual]

virtual void osgViewer::ViewerBase::getScenes ( Scenes scenes,
bool  onlyValid = true 
) [pure virtual]

virtual void osgViewer::ViewerBase::getViews ( Views views,
bool  onlyValid = true 
) [pure virtual]

virtual double osgViewer::ViewerBase::elapsedTime (  )  [pure virtual]

virtual osg::FrameStamp* osgViewer::ViewerBase::getViewerFrameStamp (  )  [pure virtual]

virtual void osgViewer::ViewerBase::getUsage ( osg::ApplicationUsage usage  )  const [pure virtual]

Get the keyboard and mouse usage of this viewer.

Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.

void osgViewer::ViewerBase::viewerBaseInit (  )  [protected]

void osgViewer::ViewerBase::makeCurrent ( osg::GraphicsContext gc  )  [inline, protected]

void osgViewer::ViewerBase::releaseContext (  )  [inline, protected]

virtual void osgViewer::ViewerBase::viewerInit (  )  [protected, pure virtual]


Friends And Related Function Documentation

friend class osgViewer::View [friend]


Member Data Documentation

Reimplemented in osgViewer::CompositeViewer.

bool osgViewer::ViewerBase::_done [protected]


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

Generated on Sat Mar 20 12:34:08 2010 for openscenegraph by  doxygen 1.5.6