OpenSceneGraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
osgViewer::ViewerBase Class Referenceabstract

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

Inheritance diagram for osgViewer::ViewerBase:
Inheritance graph
[legend]

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 Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 ViewerBase ()
 
 ViewerBase (const ViewerBase &vb)
 
virtual void setViewerStats (osg::Stats *stats)=0
 Set the Stats object used to collect various frame related timing and scene graph stats. More...
 
virtual osg::StatsgetViewerStats ()=0
 Get the Viewers Stats object. More...
 
virtual const osg::StatsgetViewerStats () const =0
 Get the Viewers Stats object. More...
 
virtual bool readConfiguration (const std::string &filename)=0
 read the viewer configuration from a configuration file. More...
 
virtual bool isRealized () const =0
 Get whether at least of one of this viewers windows are realized. More...
 
virtual void realize ()=0
 set up windows and associated threads. More...
 
void setUseConfigureAffinity (bool flag)
 Set whether the setUpThreading() method should call configureAffinity() to set up up the processor affinity of viewer threads. More...
 
bool getUseConfigureAffinity () const
 get whether the setUpThreading() method should call configureAffinity() to set up up the processor affinity of viewer threads. More...
 
virtual void configureAffinity ()
 analyse the viewer configuration and select an appropriate Affinity for main thread, and any graphics, camera threads and database pagers that are required. More...
 
virtual void setProcessorAffinity (const OpenThreads::Affinity &affinity)
 Set the processor affinity of main thread. More...
 
OpenThreads::AffinitygetProcessorAffinity ()
 
const OpenThreads::AffinitygetProcessorAffinity () const
 
virtual void setThreadingModel (ThreadingModel threadingModel)
 Set the threading model the rendering traversals will use. More...
 
ThreadingModel getThreadingModel () const
 Get the threading model the rendering traversals will use. More...
 
virtual ThreadingModel suggestBestThreadingModel ()
 Let the viewer suggest the best threading model for the viewers camera/window setup and the hardware available. More...
 
virtual void setUpThreading ()
 Set up the threading and processor affinity as per the viewers threading model. More...
 
bool areThreadsRunning () const
 Return true if viewer threads are running. More...
 
virtual void stopThreading ()
 Stop any threads being run by viewer. More...
 
virtual void startThreading ()
 Start any threads required by the viewer. More...
 
void setEndBarrierPosition (BarrierPosition bp)
 Set the position of the end barrier. More...
 
BarrierPosition getEndBarrierPosition () const
 Get the end barrier position. More...
 
void setEndBarrierOperation (osg::BarrierOperation::PreBlockOp op)
 Set the end barrier operation. More...
 
osg::BarrierOperation::PreBlockOp getEndBarrierOperation () const
 Get the end barrier operation. More...
 
void setDone (bool done)
 Set the done flag to signal the viewer's work is done and should exit the frame loop. More...
 
bool done () const
 Return true if viewer's work is done and should exit the frame loop. More...
 
void setEventVisitor (osgGA::EventVisitor *eventVisitor)
 Set the EventVisitor. More...
 
osgGA::EventVisitorgetEventVisitor ()
 Get the EventVisitor. More...
 
const osgGA::EventVisitorgetEventVisitor () const
 Get the const EventVisitor. More...
 
void setKeyEventSetsDone (int key)
 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. More...
 
int getKeyEventSetsDone () const
 get the key event that the viewer checks on each frame to see if the viewer's done flag. More...
 
void setQuitEventSetsDone (bool flag)
 if the flag is true, the viewer set its done flag when a QUIT_APPLICATION is received, false disables this feature More...
 
bool getQuitEventSetsDone () const
 
void setReleaseContextAtEndOfFrameHint (bool hint)
 Hint to tell the renderingTraversals() method whether to call releaseContext() on the last context that was made current by the thread calling renderingTraverals(). More...
 
bool getReleaseContextAtEndOfFrameHint () const
 Hint to tell the renderingTraversals() method whether to call releaseContext(). More...
 
void setUpdateVisitor (osgUtil::UpdateVisitor *updateVisitor)
 Set the UpdateVisitor. More...
 
osgUtil::UpdateVisitorgetUpdateVisitor ()
 Get the UpdateVisitor. More...
 
const osgUtil::UpdateVisitorgetUpdateVisitor () const
 Get the const UpdateVisitor. More...
 
void setUpdateOperations (osg::OperationQueue *operations)
 Set the Update OperationQueue. More...
 
osg::OperationQueuegetUpdateOperations ()
 Get the Update OperationQueue. More...
 
const osg::OperationQueuegetUpdateOperations () const
 Get the const Update OperationQueue. More...
 
void addUpdateOperation (osg::Operation *operation)
 Add an update operation. More...
 
void removeUpdateOperation (osg::Operation *operation)
 Remove an update operation. More...
 
void setRealizeOperation (osg::Operation *op)
 Set the graphics operation to call on realization of the viewers graphics windows. More...
 
osg::OperationgetRealizeOperation ()
 Get the graphics operation to call on realization of the viewers graphics windows. More...
 
void setCleanUpOperation (osg::Operation *op)
 Set the graphics operation to call before the viewers graphics contexts close. More...
 
osg::OperationgetCleanUpOperation ()
 Get the graphics operation to call before the viewers graphics contexts close. More...
 
void setIncrementalCompileOperation (osgUtil::IncrementalCompileOperation *ico)
 Set the incremental compile operation. More...
 
osgUtil::IncrementalCompileOperationgetIncrementalCompileOperation ()
 Get the incremental compile operation. More...
 
void setRunFrameScheme (FrameScheme fs)
 
FrameScheme getRunFrameScheme () const
 
void setRunMaxFrameRate (double frameRate)
 
double getRunMaxFrameRate () const
 
virtual int run ()
 Execute a main frame loop. More...
 
virtual bool checkNeedToDoFrame ()=0
 check to see if the new frame is required, called by run(..) when FrameScheme is set to ON_DEMAND. More...
 
virtual bool checkEvents ()=0
 check to see if events have been received, return true if events are now available. More...
 
virtual void frame (double simulationTime=USE_REFERENCE_TIME)
 Render a complete new frame. More...
 
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 ()
 Check to see if any windows are still open. More...
 
void checkWindowStatus (const Contexts &contexts)
 Check to see if windows are still open using the list of contexts given as a parameter. More...
 
virtual double elapsedTime ()=0
 
virtual osg::FrameStampgetViewerFrameStamp ()=0
 
virtual void getUsage (osg::ApplicationUsage &usage) const =0
 Get the keyboard and mouse usage of this viewer. More...
 
bool getRequestRedraw () const
 
bool getRequestContinousUpdate () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 return the name of the object's library. More...
 
virtual const char * className () const =0
 return the name of the object's class type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
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 Member Functions

void viewerBaseInit ()
 
void makeCurrent (osg::GraphicsContext *gc)
 
void releaseContext ()
 
virtual void viewerInit ()=0
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

bool _firstFrame
 
bool _done
 
int _keyEventSetsDone
 
bool _quitEventSetsDone
 
bool _releaseContextAtEndOfFrameHint
 
bool _useConfigureAffinity
 
OpenThreads::Affinity _affinity
 
ThreadingModel _threadingModel
 
bool _threadsRunning
 
bool _requestRedraw
 
bool _requestContinousUpdate
 
FrameScheme _runFrameScheme
 
double _runMaxFrameRate
 
BarrierPosition _endBarrierPosition
 
osg::BarrierOperation::PreBlockOp _endBarrierOperation
 
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< osg::Operation_cleanUpOperation
 
osg::ref_ptr< osgUtil::IncrementalCompileOperation_incrementalCompileOperation
 
osg::observer_ptr< osg::GraphicsContext_currentContext
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Friends

class osgViewer::View
 

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 setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

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

Member Typedef Documentation

◆ Cameras

◆ Contexts

◆ OperationThreads

◆ Scenes

◆ Threads

◆ Views

◆ Windows

Member Enumeration Documentation

◆ BarrierPosition

Enumerator
BeforeSwapBuffers 
AfterSwapBuffers 

◆ FrameScheme

Enumerator
ON_DEMAND 
CONTINUOUS 

◆ ThreadingModel

Enumerator
SingleThreaded 
CullDrawThreadPerContext 
ThreadPerContext 
DrawThreadPerContext 
CullThreadPerCameraDrawThreadPerContext 
ThreadPerCamera 
AutomaticSelection 

Constructor & Destructor Documentation

◆ ViewerBase() [1/2]

osgViewer::ViewerBase::ViewerBase ( )

◆ ViewerBase() [2/2]

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

Member Function Documentation

◆ addUpdateOperation()

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

Add an update operation.

◆ advance()

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

◆ areThreadsRunning()

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

Return true if viewer threads are running.

◆ checkEvents()

virtual bool osgViewer::ViewerBase::checkEvents ( )
pure virtual

check to see if events have been received, return true if events are now available.

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

◆ checkNeedToDoFrame()

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.

◆ checkWindowStatus() [1/2]

void osgViewer::ViewerBase::checkWindowStatus ( )

Check to see if any windows are still open.

If not, set viewer done to true.

◆ checkWindowStatus() [2/2]

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.

◆ configureAffinity()

virtual void osgViewer::ViewerBase::configureAffinity ( )
virtual

analyse the viewer configuration and select an appropriate Affinity for main thread, and any graphics, camera threads and database pagers that are required.

◆ done()

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

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

◆ elapsedTime()

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

◆ eventTraversal()

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

◆ frame()

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

Render a complete new frame.

Calls advance(), eventTraversal(), updateTraversal(), renderingTraversals().

◆ getAllThreads()

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

◆ getCameras()

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

◆ getCleanUpOperation()

osg::Operation* osgViewer::ViewerBase::getCleanUpOperation ( )
inline

Get the graphics operation to call before the viewers graphics contexts close.

◆ getContexts()

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

◆ getEndBarrierOperation()

osg::BarrierOperation::PreBlockOp osgViewer::ViewerBase::getEndBarrierOperation ( ) const
inline

Get the end barrier operation.

◆ getEndBarrierPosition()

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

Get the end barrier position.

◆ getEventVisitor() [1/2]

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

Get the EventVisitor.

◆ getEventVisitor() [2/2]

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

Get the const EventVisitor.

◆ getIncrementalCompileOperation()

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

Get the incremental compile operation.

◆ getKeyEventSetsDone()

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.

◆ getOperationThreads()

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

◆ getProcessorAffinity() [1/2]

OpenThreads::Affinity& osgViewer::ViewerBase::getProcessorAffinity ( )
inline

◆ getProcessorAffinity() [2/2]

const OpenThreads::Affinity& osgViewer::ViewerBase::getProcessorAffinity ( ) const
inline

◆ getQuitEventSetsDone()

bool osgViewer::ViewerBase::getQuitEventSetsDone ( ) const
inline
Returns
true if the viewer respond to the QUIT_APPLICATION-event

◆ getRealizeOperation()

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

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

◆ getReleaseContextAtEndOfFrameHint()

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

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

◆ getRequestContinousUpdate()

bool osgViewer::ViewerBase::getRequestContinousUpdate ( ) const
inline

◆ getRequestRedraw()

bool osgViewer::ViewerBase::getRequestRedraw ( ) const
inline

◆ getRunFrameScheme()

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

◆ getRunMaxFrameRate()

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

References USE_REFERENCE_TIME.

◆ getScenes()

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

◆ getThreadingModel()

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

Get the threading model the rendering traversals will use.

◆ getUpdateOperations() [1/2]

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

Get the Update OperationQueue.

◆ getUpdateOperations() [2/2]

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

Get the const Update OperationQueue.

◆ getUpdateVisitor() [1/2]

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

Get the UpdateVisitor.

◆ getUpdateVisitor() [2/2]

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

Get the const UpdateVisitor.

◆ getUsage()

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.

◆ getUseConfigureAffinity()

bool osgViewer::ViewerBase::getUseConfigureAffinity ( ) const
inline

get whether the setUpThreading() method should call configureAffinity() to set up up the processor affinity of viewer threads.

◆ getViewerFrameStamp()

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

◆ getViewerStats() [1/2]

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

Get the Viewers Stats object.

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

◆ getViewerStats() [2/2]

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

Get the Viewers Stats object.

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

◆ getViews()

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

◆ getWindows()

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

◆ isRealized()

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.

◆ makeCurrent()

void osgViewer::ViewerBase::makeCurrent ( osg::GraphicsContext gc)
inlineprotected

◆ readConfiguration()

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

read the viewer configuration from a configuration file.

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

◆ realize()

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

set up windows and associated threads.

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

◆ releaseContext()

void osgViewer::ViewerBase::releaseContext ( )
inlineprotected

◆ removeUpdateOperation()

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

Remove an update operation.

◆ renderingTraversals()

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

◆ run()

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.

◆ setCleanUpOperation()

void osgViewer::ViewerBase::setCleanUpOperation ( osg::Operation op)
inline

Set the graphics operation to call before the viewers graphics contexts close.

◆ setDone()

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.

◆ setEndBarrierOperation()

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.

◆ setEndBarrierPosition()

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.

◆ setEventVisitor()

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

Set the EventVisitor.

◆ setIncrementalCompileOperation()

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.

◆ setKeyEventSetsDone()

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.

◆ setProcessorAffinity()

virtual void osgViewer::ViewerBase::setProcessorAffinity ( const OpenThreads::Affinity affinity)
inlinevirtual

Set the processor affinity of main thread.

◆ setQuitEventSetsDone()

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

◆ setRealizeOperation()

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

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

◆ setReleaseContextAtEndOfFrameHint()

void osgViewer::ViewerBase::setReleaseContextAtEndOfFrameHint ( bool  hint)
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.

◆ setRunFrameScheme()

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

◆ setRunMaxFrameRate()

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

◆ setThreadingModel()

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

Set the threading model the rendering traversals will use.

◆ setUpdateOperations()

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

Set the Update OperationQueue.

◆ setUpdateVisitor()

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

Set the UpdateVisitor.

◆ setUpThreading()

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

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

◆ setUseConfigureAffinity()

void osgViewer::ViewerBase::setUseConfigureAffinity ( bool  flag)
inline

Set whether the setUpThreading() method should call configureAffinity() to set up up the processor affinity of viewer threads.

◆ setViewerStats()

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

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

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

◆ startThreading()

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

Start any threads required by the viewer.

◆ stopThreading()

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

Stop any threads being run by viewer.

◆ suggestBestThreadingModel()

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

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

◆ updateTraversal()

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

◆ viewerBaseInit()

void osgViewer::ViewerBase::viewerBaseInit ( )
protected

◆ viewerInit()

virtual void osgViewer::ViewerBase::viewerInit ( )
protectedpure virtual

Friends And Related Function Documentation

◆ osgViewer::View

friend class osgViewer::View
friend

Member Data Documentation

◆ _affinity

OpenThreads::Affinity osgViewer::ViewerBase::_affinity
protected

◆ _cleanUpOperation

osg::ref_ptr<osg::Operation> osgViewer::ViewerBase::_cleanUpOperation
protected

◆ _currentContext

osg::observer_ptr<osg::GraphicsContext> osgViewer::ViewerBase::_currentContext
protected

◆ _done

bool osgViewer::ViewerBase::_done
protected

◆ _endBarrierOperation

osg::BarrierOperation::PreBlockOp osgViewer::ViewerBase::_endBarrierOperation
protected

◆ _endBarrierPosition

BarrierPosition osgViewer::ViewerBase::_endBarrierPosition
protected

◆ _endDynamicDrawBlock

osg::ref_ptr<osg::EndOfDynamicDrawBlock> osgViewer::ViewerBase::_endDynamicDrawBlock
protected

◆ _endRenderingDispatchBarrier

osg::ref_ptr<osg::BarrierOperation> osgViewer::ViewerBase::_endRenderingDispatchBarrier
protected

◆ _eventVisitor

osg::ref_ptr<osgGA::EventVisitor> osgViewer::ViewerBase::_eventVisitor
protected

◆ _firstFrame

bool osgViewer::ViewerBase::_firstFrame
protected

◆ _incrementalCompileOperation

osg::ref_ptr<osgUtil::IncrementalCompileOperation> osgViewer::ViewerBase::_incrementalCompileOperation
protected

◆ _keyEventSetsDone

int osgViewer::ViewerBase::_keyEventSetsDone
protected

◆ _quitEventSetsDone

bool osgViewer::ViewerBase::_quitEventSetsDone
protected

◆ _realizeOperation

osg::ref_ptr<osg::Operation> osgViewer::ViewerBase::_realizeOperation
protected

◆ _releaseContextAtEndOfFrameHint

bool osgViewer::ViewerBase::_releaseContextAtEndOfFrameHint
protected

◆ _requestContinousUpdate

bool osgViewer::ViewerBase::_requestContinousUpdate
protected

◆ _requestRedraw

bool osgViewer::ViewerBase::_requestRedraw
protected

◆ _runFrameScheme

FrameScheme osgViewer::ViewerBase::_runFrameScheme
protected

◆ _runMaxFrameRate

double osgViewer::ViewerBase::_runMaxFrameRate
protected

◆ _startRenderingBarrier

osg::ref_ptr<osg::BarrierOperation> osgViewer::ViewerBase::_startRenderingBarrier
protected

◆ _threadingModel

ThreadingModel osgViewer::ViewerBase::_threadingModel
protected

◆ _threadsRunning

bool osgViewer::ViewerBase::_threadsRunning
protected

◆ _updateOperations

osg::ref_ptr<osg::OperationQueue> osgViewer::ViewerBase::_updateOperations
protected

◆ _updateVisitor

osg::ref_ptr<osgUtil::UpdateVisitor> osgViewer::ViewerBase::_updateVisitor
protected

◆ _useConfigureAffinity

bool osgViewer::ViewerBase::_useConfigureAffinity
protected

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