OSG
3.4.0
|
#include <ViewerBase.h>
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 |
![]() | |
enum | DataVariance { DYNAMIC, STATIC, UNSPECIFIED } |
Public Member Functions | |
ViewerBase () | |
ViewerBase (const ViewerBase &vb) | |
virtual void | setViewerStats (osg::Stats *stats)=0 |
virtual osg::Stats * | getViewerStats ()=0 |
virtual const osg::Stats * | getViewerStats () 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 | setEndBarrierOperation (osg::BarrierOperation::PreBlockOp op) |
osg::BarrierOperation::PreBlockOp | getEndBarrierOperation () const |
void | setDone (bool done) |
bool | done () const |
void | setEventVisitor (osgGA::EventVisitor *eventVisitor) |
osgGA::EventVisitor * | getEventVisitor () |
const osgGA::EventVisitor * | getEventVisitor () 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::UpdateVisitor * | getUpdateVisitor () |
const osgUtil::UpdateVisitor * | getUpdateVisitor () const |
void | setUpdateOperations (osg::OperationQueue *operations) |
osg::OperationQueue * | getUpdateOperations () |
const osg::OperationQueue * | getUpdateOperations () const |
void | addUpdateOperation (osg::Operation *operation) |
void | removeUpdateOperation (osg::Operation *operation) |
void | setRealizeOperation (osg::Operation *op) |
osg::Operation * | getRealizeOperation () |
void | setIncrementalCompileOperation (osgUtil::IncrementalCompileOperation *ico) |
osgUtil::IncrementalCompileOperation * | getIncrementalCompileOperation () |
void | setRunFrameScheme (FrameScheme fs) |
FrameScheme | getRunFrameScheme () const |
void | setRunMaxFrameRate (double frameRate) |
double | getRunMaxFrameRate () const |
virtual int | run () |
virtual bool | checkNeedToDoFrame ()=0 |
virtual bool | checkEvents ()=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 |
void | checkWindowStatus () |
void | checkWindowStatus (const Contexts &contexts) |
virtual double | elapsedTime ()=0 |
virtual osg::FrameStamp * | getViewerFrameStamp ()=0 |
virtual void | getUsage (osg::ApplicationUsage &usage) const =0 |
![]() | |
Object () | |
Object (bool threadSafeRefUnref) | |
Object (const Object &, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
virtual Object * | cloneType () const =0 |
virtual Object * | clone (const CopyOp &) const =0 |
virtual bool | isSameKindAs (const Object *) const |
virtual const char * | libraryName () const =0 |
virtual const char * | className () const =0 |
std::string | getCompoundClassName () const |
virtual Node * | asNode () |
virtual const Node * | asNode () const |
virtual NodeVisitor * | asNodeVisitor () |
virtual const NodeVisitor * | asNodeVisitor () const |
virtual StateAttribute * | asStateAttribute () |
virtual const StateAttribute * | asStateAttribute () const |
virtual Uniform * | asUniform () |
virtual const Uniform * | asUniform () const |
virtual void | setThreadSafeRefUnref (bool threadSafe) |
virtual void | setName (const std::string &name) |
void | setName (const char *name) |
const std::string & | getName () const |
void | setDataVariance (DataVariance dv) |
DataVariance | getDataVariance () const |
virtual void | computeDataVariance () |
void | setUserDataContainer (osg::UserDataContainer *udc) |
osg::UserDataContainer * | getUserDataContainer () |
const osg::UserDataContainer * | getUserDataContainer () const |
osg::UserDataContainer * | getOrCreateUserDataContainer () |
virtual void | setUserData (Referenced *obj) |
virtual Referenced * | getUserData () |
virtual const Referenced * | getUserData () const |
template<typename T > | |
bool | getUserValue (const std::string &name, T &value) const |
template<typename T > | |
void | setUserValue (const std::string &name, const T &value) |
virtual void | resizeGLObjectBuffers (unsigned int) |
virtual void | releaseGLObjects (osg::State *=0) const |
template<typename T > | |
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool | getUserValue (const std::string &name, T &value) const |
![]() | |
Referenced () | |
Referenced (bool threadSafeRefUnref) | |
Referenced (const Referenced &) | |
Referenced & | operator= (const Referenced &) |
bool | getThreadSafeRefUnref () const |
OpenThreads::Mutex * | getRefMutex () const |
int | ref () const |
int | unref () const |
int | unref_nodelete () const |
int | referenceCount () const |
ObserverSet * | getObserverSet () const |
ObserverSet * | getOrCreateObserverSet () const |
void | addObserver (Observer *observer) const |
void | removeObserver (Observer *observer) const |
Protected Member Functions | |
void | viewerBaseInit () |
void | makeCurrent (osg::GraphicsContext *gc) |
void | releaseContext () |
virtual void | viewerInit ()=0 |
![]() | |
virtual | ~Object () |
![]() | |
virtual | ~Referenced () |
void | signalObserversAndDelete (bool signalDelete, bool doDelete) const |
void | deleteUsingDeleteHandler () const |
Friends | |
class | osgViewer::View |
Additional Inherited Members | |
![]() | |
static OpenThreads::Mutex * | getGlobalReferencedMutex () |
static void | setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting) |
static bool | getThreadSafeReferenceCounting () |
static void | setDeleteHandler (DeleteHandler *handler) |
static DeleteHandler * | getDeleteHandler () |
ViewerBase is the view base class that is inherited by both Viewer and CompositeViewer.
Definition at line 35 of file ViewerBase.h.
typedef std::vector<osg::Camera*> osgViewer::ViewerBase::Cameras |
Definition at line 243 of file ViewerBase.h.
typedef std::vector<osg::GraphicsContext*> osgViewer::ViewerBase::Contexts |
Definition at line 246 of file ViewerBase.h.
typedef std::vector<osg::OperationThread*> osgViewer::ViewerBase::OperationThreads |
Definition at line 255 of file ViewerBase.h.
typedef std::vector<osgViewer::Scene*> osgViewer::ViewerBase::Scenes |
Definition at line 258 of file ViewerBase.h.
typedef std::vector<OpenThreads::Thread*> osgViewer::ViewerBase::Threads |
Definition at line 252 of file ViewerBase.h.
typedef std::vector<osgViewer::View*> osgViewer::ViewerBase::Views |
Definition at line 261 of file ViewerBase.h.
typedef std::vector<osgViewer::GraphicsWindow*> osgViewer::ViewerBase::Windows |
Definition at line 249 of file ViewerBase.h.
Enumerator | |
---|---|
BeforeSwapBuffers | |
AfterSwapBuffers |
Definition at line 94 of file ViewerBase.h.
Enumerator | |
---|---|
ON_DEMAND | |
CONTINUOUS |
Definition at line 206 of file ViewerBase.h.
Enumerator | |
---|---|
SingleThreaded | |
CullDrawThreadPerContext | |
ThreadPerContext | |
DrawThreadPerContext | |
CullThreadPerCameraDrawThreadPerContext | |
ThreadPerCamera | |
AutomaticSelection |
Definition at line 62 of file ViewerBase.h.
osgViewer::ViewerBase::ViewerBase | ( | ) |
osgViewer::ViewerBase::ViewerBase | ( | const ViewerBase & | vb | ) |
void osgViewer::ViewerBase::addUpdateOperation | ( | osg::Operation * | operation | ) |
Add an update operation.
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
inline |
Return true if viewer threads are running.
Definition at line 86 of file ViewerBase.h.
|
pure virtual |
check to see if events have been received, return true if events are now available.
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
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.
void osgViewer::ViewerBase::checkWindowStatus | ( | ) |
Check to see if any windows are still open. If not, set viewer done to true.
void osgViewer::ViewerBase::checkWindowStatus | ( | const Contexts & | contexts | ) |
Check to see if windows are still open using the list of contexts given as a parameter. If no windows are open, stop rendering threads and set viewer done to true. This function is more effective than checkWindowStatus() as it does not query the context list and should be used whenever context list is already available in your code.
|
inline |
Return true if viewer's work is done and should exit the frame loop.
Definition at line 124 of file ViewerBase.h.
|
pure virtual |
Implemented in osgViewer::Viewer, and osgViewer::CompositeViewer.
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
virtual |
Render a complete new frame. Calls advance(), eventTraversal(), updateTraversal(), renderingTraversals().
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
inline |
Get the end barrier operation.
Definition at line 117 of file ViewerBase.h.
|
inline |
Get the end barrier position.
Definition at line 108 of file ViewerBase.h.
|
inline |
Get the EventVisitor.
Definition at line 130 of file ViewerBase.h.
|
inline |
Get the const EventVisitor.
Definition at line 133 of file ViewerBase.h.
|
inline |
Get the incremental compile operation.
Definition at line 203 of file ViewerBase.h.
|
inline |
get the key event that the viewer checks on each frame to see if the viewer's done flag.
Definition at line 142 of file ViewerBase.h.
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
inline |
Definition at line 148 of file ViewerBase.h.
|
inline |
Get the graphics operation to call on realization of the viewers graphics windows.
Definition at line 194 of file ViewerBase.h.
|
inline |
Hint to tell the renderingTraversals() method whether to call releaseContext().
Definition at line 161 of file ViewerBase.h.
|
inline |
Definition at line 213 of file ViewerBase.h.
|
inline |
Definition at line 216 of file ViewerBase.h.
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
inline |
Get the threading model the rendering traversals will use.
Definition at line 77 of file ViewerBase.h.
|
inline |
Get the Update OperationQueue.
Definition at line 178 of file ViewerBase.h.
|
inline |
Get the const Update OperationQueue.
Definition at line 181 of file ViewerBase.h.
|
inline |
Get the UpdateVisitor.
Definition at line 168 of file ViewerBase.h.
|
inline |
Get the const UpdateVisitor.
Definition at line 171 of file ViewerBase.h.
|
pure virtual |
Get the keyboard and mouse usage of this viewer.
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
pure virtual |
Implemented in osgViewer::Viewer, and osgViewer::CompositeViewer.
|
pure virtual |
Get the Viewers Stats object.
Implemented in osgViewer::Viewer, and osgViewer::CompositeViewer.
|
pure virtual |
Get the Viewers Stats object.
Implemented in osgViewer::Viewer, and osgViewer::CompositeViewer.
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
virtual |
|
pure virtual |
Get whether at least of one of this viewers windows are realized.
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
inlineprotected |
|
pure virtual |
read the viewer configuration from a configuration file.
Implemented in osgViewer::Viewer, and osgViewer::CompositeViewer.
|
pure virtual |
set up windows and associated threads.
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
inlineprotected |
Definition at line 295 of file ViewerBase.h.
void osgViewer::ViewerBase::removeUpdateOperation | ( | osg::Operation * | operation | ) |
Remove an update operation.
|
virtual |
|
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.
|
inline |
Set the done flag to signal the viewer's work is done and should exit the frame loop.
Definition at line 121 of file ViewerBase.h.
void osgViewer::ViewerBase::setEndBarrierOperation | ( | osg::BarrierOperation::PreBlockOp | op | ) |
Set the end barrier operation. op
may be one of GL_FLUSH, GL_FINISH, or NO_OPERATION. NO_OPERATION is the default. Per BarrierOperation::operator()(), a glFlush() command, glFinish() command, or no additional OpenGL command will be issued before entering the end barrier.
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.
|
inline |
Set the EventVisitor.
Definition at line 127 of file ViewerBase.h.
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.
|
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.
Definition at line 139 of file ViewerBase.h.
|
inline |
if the flag is true, the viewer set its done flag when a QUIT_APPLICATION is received, false disables this feature
Definition at line 145 of file ViewerBase.h.
|
inline |
Set the graphics operation to call on realization of the viewers graphics windows.
Definition at line 191 of file ViewerBase.h.
|
inline |
Hint to tell the renderingTraversals() method whether to call releaseContext() 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.
Definition at line 158 of file ViewerBase.h.
|
inline |
Definition at line 212 of file ViewerBase.h.
|
inline |
Definition at line 215 of file ViewerBase.h.
|
virtual |
Set the threading model the rendering traversals will use.
|
inline |
Set the Update OperationQueue.
Definition at line 175 of file ViewerBase.h.
|
inline |
Set the UpdateVisitor.
Definition at line 165 of file ViewerBase.h.
|
virtual |
Set up the threading and processor affinity as per the viewers threading model.
|
pure virtual |
Set the Stats object used to collect various frame related timing and scene graph stats.
Implemented in osgViewer::Viewer, and osgViewer::CompositeViewer.
|
virtual |
Start any threads required by the viewer.
|
virtual |
Stop any threads being run by viewer.
|
virtual |
Let the viewer suggest the best threading model for the viewers camera/window setup and the hardware available.
|
pure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
protected |
|
protectedpure virtual |
Implemented in osgViewer::CompositeViewer, and osgViewer::Viewer.
|
friend |
Definition at line 284 of file ViewerBase.h.
|
protected |
Definition at line 337 of file ViewerBase.h.
|
protected |
Definition at line 307 of file ViewerBase.h.
|
protected |
Definition at line 323 of file ViewerBase.h.
|
protected |
Definition at line 322 of file ViewerBase.h.
|
protected |
Definition at line 327 of file ViewerBase.h.
|
protected |
Definition at line 326 of file ViewerBase.h.
|
protected |
Definition at line 329 of file ViewerBase.h.
|
protected |
Definition at line 306 of file ViewerBase.h.
|
protected |
Definition at line 335 of file ViewerBase.h.
|
protected |
Definition at line 308 of file ViewerBase.h.
|
protected |
Definition at line 309 of file ViewerBase.h.
|
protected |
Definition at line 334 of file ViewerBase.h.
|
protected |
Definition at line 310 of file ViewerBase.h.
|
protected |
Definition at line 316 of file ViewerBase.h.
|
protected |
Definition at line 315 of file ViewerBase.h.
|
protected |
Definition at line 318 of file ViewerBase.h.
|
protected |
Definition at line 319 of file ViewerBase.h.
|
protected |
Definition at line 325 of file ViewerBase.h.
|
protected |
Definition at line 312 of file ViewerBase.h.
|
protected |
Definition at line 313 of file ViewerBase.h.
|
protected |
Definition at line 331 of file ViewerBase.h.
|
protected |
Definition at line 332 of file ViewerBase.h.