openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgViewer::Viewer Class Reference
Inheritance diagram for osgViewer::Viewer:
osgViewer::ViewerBase osgViewer::View osg::Object osg::View osgGA::GUIActionAdapter osg::Referenced osg::Object osg::Referenced

Public Member Functions

 Viewer ()
 Viewer (osg::ArgumentParser &arguments)
 Viewer (const osgViewer::Viewer &viewer, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual ~Viewer ()
 META_Object (osgViewer, Viewer)
virtual void take (osg::View &rhs)
virtual void setViewerStats (osg::Stats *stats)
virtual osg::StatsgetViewerStats ()
virtual const osg::StatsgetViewerStats () const
virtual bool readConfiguration (const std::string &filename)
virtual bool isRealized () const
virtual void realize ()
virtual void setStartTick (osg::Timer_t tick)
void setReferenceTime (double time=0.0)
virtual void setSceneData (osg::Node *node)
virtual GraphicsWindowEmbeddedsetUpViewerAsEmbeddedInWindow (int x, int y, int width, int height)
virtual double elapsedTime ()
virtual osg::FrameStampgetViewerFrameStamp ()
virtual int run ()
virtual bool checkNeedToDoFrame ()
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
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)
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 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)
- 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
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::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
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
- 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
- Public Member Functions inherited from osgViewer::View
 View ()
 View (const osgViewer::View &view, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Object (osgViewer, View)
virtual osg::ViewasView ()
ViewerBasegetViewerBase ()
osg::Timer_t getStartTick () const
ScenegetScene ()
const ScenegetScene () const
osg::NodegetSceneData ()
const osg::NodegetSceneData () const
void setDatabasePager (osgDB::DatabasePager *dp)
osgDB::DatabasePagergetDatabasePager ()
const osgDB::DatabasePagergetDatabasePager () const
void setImagePager (osgDB::ImagePager *ip)
osgDB::ImagePagergetImagePager ()
const osgDB::ImagePagergetImagePager () const
void setEventQueue (osgGA::EventQueue *eventQueue)
osgGA::EventQueuegetEventQueue ()
const osgGA::EventQueuegetEventQueue () const
void setCameraManipulator (osgGA::CameraManipulator *manipulator, bool resetPosition=true)
osgGA::CameraManipulatorgetCameraManipulator ()
const osgGA::CameraManipulatorgetCameraManipulator () const
void home ()
void addEventHandler (osgGA::GUIEventHandler *eventHandler)
void removeEventHandler (osgGA::GUIEventHandler *eventHandler)
EventHandlersgetEventHandlers ()
const EventHandlersgetEventHandlers () const
void setCoordinateSystemNodePath (const osg::NodePath &nodePath)
osg::NodePath getCoordinateSystemNodePath () const
void computeActiveCoordinateSystemNodePath ()
void setDisplaySettings (osg::DisplaySettings *ds)
osg::DisplaySettingsgetDisplaySettings ()
const osg::DisplaySettingsgetDisplaySettings () const
void setFusionDistance (osgUtil::SceneView::FusionDistanceMode mode, float value=1.0f)
osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode () const
float getFusionDistanceValue () const
void setUpViewAcrossAllScreens ()
void setUpViewInWindow (int x, int y, int width, int height, unsigned int screenNum=0)
void setUpViewOnSingleScreen (unsigned int screenNum=0)
void setUpViewFor3DSphericalDisplay (double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image *intensityMap=0, const osg::Matrixd &projectorMatrix=osg::Matrixd())
void setUpViewForPanoramicSphericalDisplay (double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image *intensityMap=0, const osg::Matrixd &projectorMatrix=osg::Matrixd())
void setUpViewForWoWVxDisplay (unsigned int screenNum, unsigned char wow_content, unsigned char wow_factor, unsigned char wow_offset, float wow_disparity_Zd, float wow_disparity_vz, float wow_disparity_M, float wow_disparity_C)
bool setUpDepthPartitionForCamera (osg::Camera *cameraToPartition, DepthPartitionSettings *dps=0)
bool setUpDepthPartition (DepthPartitionSettings *dsp=0)
bool containsCamera (const osg::Camera *camera) const
const osg::CameragetCameraContainingPosition (float x, float y, float &local_x, float &local_y) const
bool computeIntersections (float x, float y, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
bool computeIntersections (float x, float y, const osg::NodePath &nodePath, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
virtual void requestRedraw ()
virtual void requestContinuousUpdate (bool needed=true)
virtual void requestWarpPointer (float x, float y)
void assignSceneDataToCameras ()
void init ()
- Public Member Functions inherited from osg::View
 View (const osg::View &view, const osg::CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Object (osg, View)
void setStats (osg::Stats *stats)
osg::StatsgetStats ()
const osg::StatsgetStats () const
void setLightingMode (LightingMode lightingMode)
LightingMode getLightingMode () const
void setLight (osg::Light *light)
osg::LightgetLight ()
const osg::LightgetLight () const
void setCamera (osg::Camera *camera)
osg::CameragetCamera ()
const osg::CameragetCamera () const
void setFrameStamp (osg::FrameStamp *fs)
osg::FrameStampgetFrameStamp ()
const osg::FrameStampgetFrameStamp () const
bool addSlave (osg::Camera *camera, bool useMastersSceneData=true)
bool addSlave (osg::Camera *camera, const osg::Matrix &projectionOffset, const osg::Matrix &viewOffset, bool useMastersSceneData=true)
bool removeSlave (unsigned int pos)
unsigned int getNumSlaves () const
SlavegetSlave (unsigned int pos)
const SlavegetSlave (unsigned int pos) const
unsigned int findSlaveIndexForCamera (osg::Camera *camera) const
SlavefindSlaveForCamera (osg::Camera *camera)
void updateSlaves ()
- Public Member Functions inherited from osgGA::GUIActionAdapter
virtual ~GUIActionAdapter ()

Protected Member Functions

void constructorInit ()
virtual void viewerInit ()
- 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 Member Functions inherited from osgViewer::View
virtual ~View ()
virtual osg::GraphicsOperationcreateRenderer (osg::Camera *camera)

Protected Attributes

osg::observer_ptr< osg::Camera_cameraWithFocus
- Protected Attributes inherited from osgViewer::ViewerBase
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
- 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
- Protected Attributes inherited from osgViewer::View
osg::observer_ptr< ViewerBase_viewerBase
osg::Timer_t _startTick
osg::ref_ptr< osgViewer::Scene_scene
osg::ref_ptr< osgGA::EventQueue_eventQueue
osg::ref_ptr
< osgGA::CameraManipulator
_cameraManipulator
EventHandlers _eventHandlers
osg::ObserverNodePath _coordinateSystemNodePath
osg::ref_ptr
< osg::DisplaySettings
_displaySettings
osgUtil::SceneView::FusionDistanceMode _fusionDistanceMode
float _fusionDistanceValue
- Protected Attributes inherited from osg::View
osg::ref_ptr< osg::Stats_stats
LightingMode _lightingMode
osg::ref_ptr< osg::Light_light
osg::ref_ptr< osg::Camera_camera
Slaves _slaves
osg::ref_ptr< osg::FrameStamp_frameStamp

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 osgViewer::View
typedef std::list
< osg::ref_ptr
< osgGA::GUIEventHandler > > 
EventHandlers
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
- Protected Types inherited from osg::View
typedef std::vector< SlaveSlaves

Detailed Description

Viewer holds a single view on to a single scene.

Constructor & Destructor Documentation

osgViewer::Viewer::Viewer ( )
osgViewer::Viewer::Viewer ( osg::ArgumentParser arguments)
osgViewer::Viewer::Viewer ( const osgViewer::Viewer viewer,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgViewer::Viewer::~Viewer ( )
virtual

Member Function Documentation

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

Implements osgViewer::ViewerBase.

virtual bool osgViewer::Viewer::checkNeedToDoFrame ( )
virtual

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

Implements osgViewer::ViewerBase.

void osgViewer::Viewer::constructorInit ( )
protected
virtual double osgViewer::Viewer::elapsedTime ( )
virtual

Implements osgViewer::ViewerBase.

virtual void osgViewer::Viewer::eventTraversal ( )
virtual

Implements osgViewer::ViewerBase.

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

Implements osgViewer::ViewerBase.

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

Implements osgViewer::ViewerBase.

osg::Camera* osgViewer::Viewer::getCameraWithFocus ( )
inline
const osg::Camera* osgViewer::Viewer::getCameraWithFocus ( ) const
inline
virtual void osgViewer::Viewer::getContexts ( Contexts contexts,
bool  onlyValid = true 
)
virtual

Implements osgViewer::ViewerBase.

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

Implements osgViewer::ViewerBase.

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

Implements osgViewer::ViewerBase.

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

Get the keyboard and mouse usage of this viewer.

Implements osgViewer::ViewerBase.

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

Implements osgViewer::ViewerBase.

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

Get the Viewers Stats object.

Implements osgViewer::ViewerBase.

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

Get the Viewers Stats object.

Implements osgViewer::ViewerBase.

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

Implements osgViewer::ViewerBase.

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

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

Implements osgViewer::ViewerBase.

osgViewer::Viewer::META_Object ( osgViewer  ,
Viewer   
)
virtual bool osgViewer::Viewer::readConfiguration ( const std::string &  filename)
virtual

read the viewer configuration from a configuration file.

Implements osgViewer::ViewerBase.

virtual void osgViewer::Viewer::realize ( )
virtual

set up windows and associated threads.

Implements osgViewer::ViewerBase.

virtual int osgViewer::Viewer::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.

void osgViewer::Viewer::setCameraWithFocus ( osg::Camera camera)
inline
void osgViewer::Viewer::setReferenceTime ( double  time = 0.0)
virtual void osgViewer::Viewer::setSceneData ( osg::Node node)
virtual

Set the sene graph data that viewer with view.

Reimplemented from osgViewer::View.

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

Reimplemented from osgViewer::View.

virtual GraphicsWindowEmbedded* osgViewer::Viewer::setUpViewerAsEmbeddedInWindow ( int  x,
int  y,
int  width,
int  height 
)
virtual

Convenience method for setting up the viewer so it can be used embedded in an external managed window. Returns the GraphicsWindowEmbedded that can be used by applications to pass in events to the viewer.

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

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

Implements osgViewer::ViewerBase.

virtual void osgViewer::Viewer::take ( osg::View rhs)
virtual

Take all the settings, Camera and Slaves from the passed in view(er), leaving it empty.

Reimplemented from osgViewer::View.

virtual void osgViewer::Viewer::updateTraversal ( )
virtual

Implements osgViewer::ViewerBase.

virtual void osgViewer::Viewer::viewerInit ( )
inlineprotectedvirtual

Implements osgViewer::ViewerBase.

Member Data Documentation

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

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