OpenSceneGraph  3.0.1
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgViewer::Viewer Class Reference

Viewer holds a single view on to a single scene. More...

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

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)
 Take all the settings, Camera and Slaves from the passed in view(er), leaving it empty. More...
 
virtual void setViewerStats (osg::Stats *stats)
 Set the Stats object used for collect various frame related timing and scene graph stats. More...
 
virtual osg::StatsgetViewerStats ()
 Get the Viewers Stats object. More...
 
virtual const osg::StatsgetViewerStats () const
 Get the Viewers Stats object. More...
 
virtual bool readConfiguration (const std::string &filename)
 read the viewer configuration from a configuration file. More...
 
virtual bool isRealized () const
 Get whether at least of one of this viewers windows are realized. More...
 
virtual void realize ()
 set up windows and associated threads. More...
 
virtual void setStartTick (osg::Timer_t tick)
 
void setReferenceTime (double time=0.0)
 
virtual void setSceneData (osg::Node *node)
 Set the sene graph data that viewer with view. More...
 
virtual GraphicsWindowEmbeddedsetUpViewerAsEmbeddedInWindow (int x, int y, int width, int height)
 Convenience method for setting up the viewer so it can be used embedded in an external managed window. More...
 
virtual double elapsedTime ()
 
virtual osg::FrameStampgetViewerFrameStamp ()
 
virtual int run ()
 Execute a main frame loop. More...
 
virtual bool checkNeedToDoFrame ()
 check to see if the new frame is required, called by run(..) when FrameScheme is set to ON_DEMAND. More...
 
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
 Get the keyboard and mouse usage of this viewer. More...
 
- Public Member Functions inherited from osgViewer::ViewerBase
 ViewerBase ()
 
 ViewerBase (const ViewerBase &vb)
 
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 begin 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 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 relaseContext() 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 relaseContext(). 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 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 void frame (double simulationTime=USE_REFERENCE_TIME)
 Render a complete new frame. More...
 
virtual void renderingTraversals ()
 
virtual void getWindows (Windows &windows, bool onlyValid=true)
 
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...
 
- 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...
 
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...
 
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 ()
 Convinience 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...
 
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
 Convinience 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)
 Convinience 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 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)
 
 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::Mutex * getRefMutex () 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 referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is 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...
 
- 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 ()
 Provide a mechanism for getting the osg::View associated from the GUIActionAdapter. More...
 
ViewerBasegetViewerBase ()
 Provide a mechanism for getting the viewer object from this osgViewer::View. More...
 
osg::Timer_t getStartTick () const
 
ScenegetScene ()
 
const ScenegetScene () const
 
osg::NodegetSceneData ()
 Get the View's scene graph. More...
 
const osg::NodegetSceneData () const
 Get the const View's scene graph. More...
 
void setDatabasePager (osgDB::DatabasePager *dp)
 Set the View's database pager. More...
 
osgDB::DatabasePagergetDatabasePager ()
 Get the View's database pager. More...
 
const osgDB::DatabasePagergetDatabasePager () const
 Get the const View's database pager. More...
 
void setImagePager (osgDB::ImagePager *ip)
 Set the View's image pager. More...
 
osgDB::ImagePagergetImagePager ()
 Get the View's image pager. More...
 
const osgDB::ImagePagergetImagePager () const
 Get the const View's image pager. More...
 
void setEventQueue (osgGA::EventQueue *eventQueue)
 
osgGA::EventQueuegetEventQueue ()
 
const osgGA::EventQueuegetEventQueue () const
 
void setCameraManipulator (osgGA::CameraManipulator *manipulator, bool resetPosition=true)
 Set the CameraManipulator that moves the View's master Camera position in response to events. More...
 
osgGA::CameraManipulatorgetCameraManipulator ()
 Get the View's CameraManipulator. More...
 
const osgGA::CameraManipulatorgetCameraManipulator () const
 Get the const View's CameraManipulator. More...
 
void home ()
 Set the view to the CameraManipulator's home position, if non is attached home() is does nothing. More...
 
void addEventHandler (osgGA::GUIEventHandler *eventHandler)
 Add an EventHandler that adds handling of events to the View. More...
 
void removeEventHandler (osgGA::GUIEventHandler *eventHandler)
 Remove an EventHandler from View. More...
 
EventHandlersgetEventHandlers ()
 Get the View's list of EventHandlers. More...
 
const EventHandlersgetEventHandlers () const
 Get the const View's list of EventHandlers. More...
 
void setCoordinateSystemNodePath (const osg::NodePath &nodePath)
 Set the NodePath to any active CoordinateSystemNode present in the Scene. More...
 
osg::NodePath getCoordinateSystemNodePath () const
 Get the NodePath to any active CoordinateSystemNode present in the Scene. More...
 
void computeActiveCoordinateSystemNodePath ()
 Compute the NodePath to any active CoordinateSystemNode present in the Scene. More...
 
void setDisplaySettings (osg::DisplaySettings *ds)
 Set the DisplaySettings object associated with this view. More...
 
osg::DisplaySettingsgetDisplaySettings ()
 Set the DisplaySettings object associated with this view. More...
 
const osg::DisplaySettingsgetDisplaySettings () const
 Set the DisplaySettings object associated with this view. More...
 
void setFusionDistance (osgUtil::SceneView::FusionDistanceMode mode, float value=1.0f)
 Set the FusionDistanceMode and Value. More...
 
osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode () const
 Get the FusionDistanceMode. More...
 
float getFusionDistanceValue () const
 Get the FusionDistanceValue. More...
 
void setUpViewAcrossAllScreens ()
 Convenience method for creating slave Cameras and associated GraphicsWindows across all screens. More...
 
void setUpViewInWindow (int x, int y, int width, int height, unsigned int screenNum=0)
 Convenience method for a single camera on a single window. More...
 
void setUpViewOnSingleScreen (unsigned int screenNum=0)
 Convenience method for a single camera associated with a single full screen GraphicsWindow. More...
 
void setUpViewFor3DSphericalDisplay (double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image *intensityMap=0, const osg::Matrixd &projectorMatrix=osg::Matrixd())
 Convenience method for spherical display using 6 slave cameras rendering the 6 sides of a cube map, and 7th camera doing distortion correction to present on a spherical display. More...
 
void setUpViewForPanoramicSphericalDisplay (double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image *intensityMap=0, const osg::Matrixd &projectorMatrix=osg::Matrixd())
 Convenience method for spherical display by rendering main scene to as panoramic 2:1 texture and then doing distortion correction to present onto a spherical display. More...
 
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)
 Convenience method for autostereoscopic Philips WoWvx display. More...
 
bool setUpDepthPartitionForCamera (osg::Camera *cameraToPartition, DepthPartitionSettings *dps=0)
 Convenience method for setting up multiple slave cameras that depth partition the specified camera. More...
 
bool setUpDepthPartition (DepthPartitionSettings *dsp=0)
 Convenience method for setting up multiple slave cameras that depth partition each of the view's active cameras. More...
 
bool containsCamera (const osg::Camera *camera) const
 Return true if this view contains a specified camera. More...
 
const osg::CameragetCameraContainingPosition (float x, float y, float &local_x, float &local_y) const
 Get the camera which contains the pointer position x,y specified master cameras window/eye coords. More...
 
bool computeIntersections (float x, float y, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
 Compute intersections between a ray through the specified master cameras window/eye coords and a specified node. More...
 
bool computeIntersections (float x, float y, const osg::NodePath &nodePath, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
 Compute intersections between a ray through the specified master cameras window/eye coords and a specified nodePath's subgraph. More...
 
virtual void requestRedraw ()
 requestRedraw() requests a single redraw. More...
 
virtual void requestContinuousUpdate (bool needed=true)
 requestContinousUpdate(bool) is for en/disabling a throw or idle callback to be requested by a GUIEventHandler (typically a MatrixManipulator, though other GUIEventHandler's may also provide functionality). More...
 
virtual void requestWarpPointer (float x, float y)
 requestWarpPointer(int,int) is requesting a repositioning of the mouse pointer to a specified x,y location on the window. More...
 
void assignSceneDataToCameras ()
 
void init ()
 
- Public Member Functions inherited from osg::View
 View ()
 
 View (const osg::View &view, const osg::CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Object (osg, View)
 
void setStats (osg::Stats *stats)
 Set the Stats object used for collect various frame related timing and scene graph stats. More...
 
osg::StatsgetStats ()
 Get the Viewers Stats object. More...
 
const osg::StatsgetStats () const
 Get the Viewers Stats object. More...
 
void setLightingMode (LightingMode lightingMode)
 Set the global lighting to use for this view. More...
 
LightingMode getLightingMode () const
 Get the global lighting used for this view. More...
 
void setLight (osg::Light *light)
 Get the global light. More...
 
osg::LightgetLight ()
 Get the global lighting if assigned. More...
 
const osg::LightgetLight () const
 Get the const global lighting if assigned. More...
 
void setCamera (osg::Camera *camera)
 Set the master camera of the view. More...
 
osg::CameragetCamera ()
 Get the master camera of the view. More...
 
const osg::CameragetCamera () const
 Get the const master camera of the view. More...
 
void setFrameStamp (osg::FrameStamp *fs)
 Set the frame stamp of the view. More...
 
osg::FrameStampgetFrameStamp ()
 Get the frame stamp of the view. More...
 
const osg::FrameStampgetFrameStamp () const
 Get the frame stamp of the view. More...
 
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 ()
 Object destructor. More...
 
- 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::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. 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...
 
- 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:

osg logo
Generated at Wed Feb 13 2013 17:59:24 for the OpenSceneGraph by doxygen 1.8.3.1.