openscenegraph
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osgViewer::CompositeViewer Class Reference

#include <CompositeViewer>

Inheritance diagram for osgViewer::CompositeViewer:
osgViewer::ViewerBase osg::Object osg::Referenced

Public Member Functions

 CompositeViewer ()
 
 CompositeViewer (const CompositeViewer &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 CompositeViewer (osg::ArgumentParser &arguments)
 
 META_Object (osgViewer, CompositeViewer)
 
virtual ~CompositeViewer ()
 
bool readConfiguration (const std::string &filename)
 
virtual void setViewerStats (osg::Stats *stats)
 
virtual osg::StatsgetViewerStats ()
 
virtual const osg::StatsgetViewerStats () const
 
void addView (osgViewer::View *view)
 
template<class T >
void addView (const osg::ref_ptr< T > &view)
 
void removeView (osgViewer::View *view)
 
template<class T >
void removeView (const osg::ref_ptr< T > &view)
 
osgViewer::ViewgetView (unsigned i)
 
const osgViewer::ViewgetView (unsigned i) const
 
unsigned int getNumViews () const
 
virtual bool isRealized () const
 
virtual void realize ()
 
virtual void setStartTick (osg::Timer_t tick)
 
void setReferenceTime (double time=0.0)
 
osg::FrameStampgetFrameStamp ()
 
const osg::FrameStampgetFrameStamp () const
 
virtual double elapsedTime ()
 
virtual osg::FrameStampgetViewerFrameStamp ()
 
virtual int run ()
 
virtual bool checkNeedToDoFrame ()
 
virtual bool checkEvents ()
 
virtual void advance (double simulationTime=USE_REFERENCE_TIME)
 
virtual void eventTraversal ()
 
virtual void updateTraversal ()
 
void setCameraWithFocus (osg::Camera *camera)
 
osg::CameragetCameraWithFocus ()
 
const osg::CameragetCameraWithFocus () const
 
osgViewer::ViewgetViewWithFocus ()
 
const osgViewer::ViewgetViewWithFocus () const
 
virtual void getCameras (Cameras &cameras, bool onlyActive=true)
 
virtual void getContexts (Contexts &contexts, bool onlyValid=true)
 
virtual void getAllThreads (Threads &threads, bool onlyActive=true)
 
virtual void getOperationThreads (OperationThreads &threads, bool onlyActive=true)
 
virtual void getScenes (Scenes &scenes, bool onlyValid=true)
 
virtual void getViews (Views &views, bool onlyValid=true)
 
virtual void getUsage (osg::ApplicationUsage &usage) const
 
- Public Member Functions inherited from osgViewer::ViewerBase
 ViewerBase ()
 
 ViewerBase (const ViewerBase &vb)
 
void setUseConfigureAffinity (bool flag)
 
bool getUseConfigureAffinity () const
 
virtual void configureAffinity ()
 
virtual void setProcessorAffinity (const OpenThreads::Affinity &affinity)
 
OpenThreads::AffinitygetProcessorAffinity ()
 
const OpenThreads::AffinitygetProcessorAffinity () const
 
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::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 setCleanUpOperation (osg::Operation *op)
 
osg::OperationgetCleanUpOperation ()
 
void setIncrementalCompileOperation (osgUtil::IncrementalCompileOperation *ico)
 
osgUtil::IncrementalCompileOperationgetIncrementalCompileOperation ()
 
void setRunFrameScheme (FrameScheme fs)
 
FrameScheme getRunFrameScheme () const
 
void setRunMaxFrameRate (double frameRate)
 
double getRunMaxFrameRate () const
 
virtual void frame (double simulationTime=USE_REFERENCE_TIME)
 
virtual void renderingTraversals ()
 
virtual void getWindows (Windows &windows, bool onlyValid=true)
 
void checkWindowStatus ()
 
void checkWindowStatus (const Contexts &contexts)
 
bool getRequestRedraw () const
 
bool getRequestContinousUpdate () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (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 NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () 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)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () 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
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Types

typedef std::vector< osg::ref_ptr< osgViewer::View > > RefViews
 

Protected Member Functions

void constructorInit ()
 
virtual void viewerInit ()
 
void generateSlavePointerData (osg::Camera *camera, osgGA::GUIEventAdapter &event)
 
void generatePointerData (osgGA::GUIEventAdapter &event)
 
void reprojectPointerData (osgGA::GUIEventAdapter &source_event, osgGA::GUIEventAdapter &dest_event)
 
- Protected Member Functions inherited from osgViewer::ViewerBase
void viewerBaseInit ()
 
void makeCurrent (osg::GraphicsContext *gc)
 
void releaseContext ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

RefViews _views
 
bool _firstFrame
 
osg::ref_ptr< osg::Stats_stats
 
osg::Timer_t _startTick
 
osg::ref_ptr< osg::FrameStamp_frameStamp
 
osg::observer_ptr< osg::Camera_cameraWithFocus
 
osg::observer_ptr< osgViewer::View_viewWithFocus
 
osg::ref_ptr< osgGA::GUIEventAdapter_previousEvent
 
- Protected Attributes inherited from osgViewer::ViewerBase
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
 

Additional Inherited Members

- Public Types inherited from osgViewer::ViewerBase
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 }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

CompositeViewer holds one or more views to one or more scenes.

Member Typedef Documentation

◆ RefViews

Constructor & Destructor Documentation

◆ CompositeViewer() [1/3]

osgViewer::CompositeViewer::CompositeViewer ( )

◆ CompositeViewer() [2/3]

osgViewer::CompositeViewer::CompositeViewer ( const CompositeViewer ,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

◆ CompositeViewer() [3/3]

osgViewer::CompositeViewer::CompositeViewer ( osg::ArgumentParser arguments)

◆ ~CompositeViewer()

virtual osgViewer::CompositeViewer::~CompositeViewer ( )
virtual

Member Function Documentation

◆ addView() [1/2]

template<class T >
void osgViewer::CompositeViewer::addView ( const osg::ref_ptr< T > &  view)
inline

◆ addView() [2/2]

void osgViewer::CompositeViewer::addView ( osgViewer::View view)

◆ advance()

virtual void osgViewer::CompositeViewer::advance ( double  simulationTime = USE_REFERENCE_TIME)
virtual

Implements osgViewer::ViewerBase.

◆ checkEvents()

virtual bool osgViewer::CompositeViewer::checkEvents ( )
virtual

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

Implements osgViewer::ViewerBase.

◆ checkNeedToDoFrame()

virtual bool osgViewer::CompositeViewer::checkNeedToDoFrame ( )
virtual

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

Implements osgViewer::ViewerBase.

◆ constructorInit()

void osgViewer::CompositeViewer::constructorInit ( )
protected

◆ elapsedTime()

virtual double osgViewer::CompositeViewer::elapsedTime ( )
virtual

Implements osgViewer::ViewerBase.

◆ eventTraversal()

virtual void osgViewer::CompositeViewer::eventTraversal ( )
virtual

Implements osgViewer::ViewerBase.

◆ generatePointerData()

void osgViewer::CompositeViewer::generatePointerData ( osgGA::GUIEventAdapter event)
protected

◆ generateSlavePointerData()

void osgViewer::CompositeViewer::generateSlavePointerData ( osg::Camera camera,
osgGA::GUIEventAdapter event 
)
protected

◆ getAllThreads()

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

Implements osgViewer::ViewerBase.

◆ getCameras()

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

Implements osgViewer::ViewerBase.

◆ getCameraWithFocus() [1/2]

osg::Camera * osgViewer::CompositeViewer::getCameraWithFocus ( )
inline

◆ getCameraWithFocus() [2/2]

const osg::Camera * osgViewer::CompositeViewer::getCameraWithFocus ( ) const
inline

◆ getContexts()

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

Implements osgViewer::ViewerBase.

◆ getFrameStamp() [1/2]

osg::FrameStamp * osgViewer::CompositeViewer::getFrameStamp ( )
inline

◆ getFrameStamp() [2/2]

const osg::FrameStamp * osgViewer::CompositeViewer::getFrameStamp ( ) const
inline

◆ getNumViews()

unsigned int osgViewer::CompositeViewer::getNumViews ( ) const
inline

◆ getOperationThreads()

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

Implements osgViewer::ViewerBase.

◆ getScenes()

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

Implements osgViewer::ViewerBase.

◆ getUsage()

virtual void osgViewer::CompositeViewer::getUsage ( osg::ApplicationUsage usage) const
virtual

Get the keyboard and mouse usage of this viewer.

Implements osgViewer::ViewerBase.

◆ getView() [1/2]

osgViewer::View * osgViewer::CompositeViewer::getView ( unsigned  i)
inline

◆ getView() [2/2]

const osgViewer::View * osgViewer::CompositeViewer::getView ( unsigned  i) const
inline

◆ getViewerFrameStamp()

virtual osg::FrameStamp * osgViewer::CompositeViewer::getViewerFrameStamp ( )
inlinevirtual

Implements osgViewer::ViewerBase.

◆ getViewerStats() [1/2]

virtual osg::Stats * osgViewer::CompositeViewer::getViewerStats ( )
inlinevirtual

Get the Viewers Stats object.

Implements osgViewer::ViewerBase.

◆ getViewerStats() [2/2]

virtual const osg::Stats * osgViewer::CompositeViewer::getViewerStats ( ) const
inlinevirtual

Get the Viewers Stats object.

Implements osgViewer::ViewerBase.

◆ getViews()

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

Implements osgViewer::ViewerBase.

◆ getViewWithFocus() [1/2]

osgViewer::View * osgViewer::CompositeViewer::getViewWithFocus ( )
inline

◆ getViewWithFocus() [2/2]

const osgViewer::View * osgViewer::CompositeViewer::getViewWithFocus ( ) const
inline

◆ isRealized()

virtual bool osgViewer::CompositeViewer::isRealized ( ) const
virtual

Get whether at least of one of this viewer's windows are realized.

Implements osgViewer::ViewerBase.

◆ META_Object()

osgViewer::CompositeViewer::META_Object ( osgViewer  ,
CompositeViewer   
)

◆ readConfiguration()

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

Read the viewer configuration from a configuration file.

Implements osgViewer::ViewerBase.

◆ realize()

virtual void osgViewer::CompositeViewer::realize ( )
virtual

Set up windows and associated threads.

Implements osgViewer::ViewerBase.

◆ removeView() [1/2]

template<class T >
void osgViewer::CompositeViewer::removeView ( const osg::ref_ptr< T > &  view)
inline

◆ removeView() [2/2]

void osgViewer::CompositeViewer::removeView ( osgViewer::View view)

◆ reprojectPointerData()

void osgViewer::CompositeViewer::reprojectPointerData ( osgGA::GUIEventAdapter source_event,
osgGA::GUIEventAdapter dest_event 
)
protected

◆ run()

virtual int osgViewer::CompositeViewer::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 from osgViewer::ViewerBase.

◆ setCameraWithFocus()

void osgViewer::CompositeViewer::setCameraWithFocus ( osg::Camera camera)

◆ setReferenceTime()

void osgViewer::CompositeViewer::setReferenceTime ( double  time = 0.0)

◆ setStartTick()

virtual void osgViewer::CompositeViewer::setStartTick ( osg::Timer_t  tick)
virtual

◆ setViewerStats()

virtual void osgViewer::CompositeViewer::setViewerStats ( osg::Stats stats)
inlinevirtual

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

Implements osgViewer::ViewerBase.

◆ updateTraversal()

virtual void osgViewer::CompositeViewer::updateTraversal ( )
virtual

Implements osgViewer::ViewerBase.

◆ viewerInit()

virtual void osgViewer::CompositeViewer::viewerInit ( )
protectedvirtual

Implements osgViewer::ViewerBase.

Member Data Documentation

◆ _cameraWithFocus

osg::observer_ptr<osg::Camera> osgViewer::CompositeViewer::_cameraWithFocus
protected

◆ _firstFrame

bool osgViewer::CompositeViewer::_firstFrame
protected

◆ _frameStamp

osg::ref_ptr<osg::FrameStamp> osgViewer::CompositeViewer::_frameStamp
protected

◆ _previousEvent

osg::ref_ptr<osgGA::GUIEventAdapter> osgViewer::CompositeViewer::_previousEvent
protected

◆ _startTick

osg::Timer_t osgViewer::CompositeViewer::_startTick
protected

◆ _stats

osg::ref_ptr<osg::Stats> osgViewer::CompositeViewer::_stats
protected

◆ _views

RefViews osgViewer::CompositeViewer::_views
protected

◆ _viewWithFocus

osg::observer_ptr<osgViewer::View> osgViewer::CompositeViewer::_viewWithFocus
protected

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