OpenSceneGraph  3.5.1
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
osgViewer::View Class Reference

View holds a single view on a scene, this view may be composed of one or more slave cameras. More...

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

Classes

struct  StereoSlaveCallback
 

Public Types

typedef std::list< osg::ref_ptr< osgGA::EventHandler > > EventHandlers
 
- Public Types inherited from osg::View
enum  LightingMode { NO_LIGHT, HEADLIGHT, SKY_LIGHT }
 Options for controlling the global lighting used for the view. More...
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 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...
 
virtual void take (osg::View &rhs)
 Take all the settings, Camera and Slaves from the passed in view, leaving it empty. More...
 
virtual void setStartTick (osg::Timer_t tick)
 
osg::Timer_t getStartTick () const
 
ScenegetScene ()
 
const ScenegetScene () const
 
virtual void setSceneData (osg::Node *node)
 Set the scene graph that the View will use. More...
 
template<class T >
void setSceneData (const osg::ref_ptr< T > &node)
 
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...
 
template<class T >
void setDatabasePager (const osg::ref_ptr< T > &dp)
 
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...
 
template<class T >
void setImagePager (const osg::ref_ptr< T > *ip)
 
osgDB::ImagePagergetImagePager ()
 Get the View's image pager. More...
 
const osgDB::ImagePagergetImagePager () const
 Get the const View's image pager. More...
 
void addDevice (osgGA::Device *eventSource)
 Add a Device. More...
 
template<class T >
void addDevice (const osg::ref_ptr< T > &eventSource)
 
void setEventQueue (osgGA::EventQueue *eventQueue)
 Remove a Device. More...
 
template<class T >
void setEventQueue (const osg::ref_ptr< T > &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...
 
template<class T >
void setCameraManipulator (const osg::ref_ptr< T > &manipulator, bool resetPosition=true)
 
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 none is attached home() it does nothing. More...
 
void addEventHandler (osgGA::EventHandler *eventHandler)
 Add an EventHandler that adds handling of events to the View. More...
 
template<class T >
void addEventHandler (const osg::ref_ptr< T > &eventHandler)
 
void removeEventHandler (osgGA::EventHandler *eventHandler)
 Remove an EventHandler from View. More...
 
template<class T >
void removeEventHandler (const osg::ref_ptr< T > &eventHandler)
 
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...
 
template<class T >
void setDisplaySettings (const osg::ref_ptr< T > &ds)
 
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 apply (ViewConfig *config)
 Apply a viewer configuration to set up Cameras and Windowing. More...
 
template<class T >
void apply (const osg::ref_ptr< T > &config)
 
ViewConfiggetLastAppliedViewConfig ()
 
const ViewConfiggetLastAppliedViewConfig () const
 
void setUpViewAcrossAllScreens ()
 deprecated, use view.apply(new osgViewer::AcrossAllWindows()). More...
 
void setUpViewInWindow (int x, int y, int width, int height, unsigned int screenNum=0)
 deprecated, use view.apply(new osgViewer::SingleWindow(x,y,width,screenNum)). More...
 
void setUpViewOnSingleScreen (unsigned int screenNum=0)
 deprecated, use view.apply(new osgViewer::SingleScreen(screenNum)). 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())
 deprecated, use view.apply(new osgViewer::SphericalDisplay(radius, collar, screenNum, intensityMap, projectorMatrix)). 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())
 deprecated, use view.apply(new osgViewer::PanoramicSphericalDisplay(radius, collar, screenNum, intensityMap, projectorMatrix)). 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)
 deprecated. More...
 
bool setUpDepthPartitionForCamera (osg::Camera *cameraToPartition, DepthPartitionSettings *dps=0)
 Convenience method for setting up depth partitioning on the specified camera. More...
 
bool setUpDepthPartition (DepthPartitionSettings *dsp=0)
 Convenience method for setting up multiple slave cameras with depth partitioning on 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...
 
template<class T >
bool containsCamera (const osg::ref_ptr< T > &camera) const
 
const osg::CameragetCameraContainingPosition (float x, float y, float &local_x, float &local_y) const
 deprecated. More...
 
bool computeIntersections (float x, float y, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
 deprecated. More...
 
bool computeIntersections (float x, float y, const osg::NodePath &nodePath, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
 deprecated. More...
 
bool computeIntersections (const osgGA::GUIEventAdapter &ea, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
 Compute intersections of a ray, starting the current mouse position, through the specified camera. More...
 
bool computeIntersections (const osgGA::GUIEventAdapter &ea, const osg::NodePath &nodePath, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
 Compute intersections of a ray, starting the current mouse position, through the specified master camera's window/eye coordinates and a specified nodePath's subgraph. More...
 
bool computeIntersections (const osg::Camera *camera, osgUtil::Intersector::CoordinateFrame cf, float x, float y, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
 Compute intersections of a ray through the specified camera. More...
 
bool computeIntersections (const osg::Camera *camera, osgUtil::Intersector::CoordinateFrame cf, float x, float y, const osg::NodePath &nodePath, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
 Compute intersections of a ray through the specified camera and a specified nodePath's subgraph. More...
 
virtual void requestRedraw ()
 requestRedraw() requests a single redraw. More...
 
virtual void requestContinuousUpdate (bool needed=true)
 requestContinuousUpdate(bool) is for en/disabling a throw or idle callback to be requested by a GUIEventHandler (typically a CameraManipulator, 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...
 
osg::TexturecreateDistortionTexture (int width, int height)
 
osg::CameraassignRenderToTextureCamera (osg::GraphicsContext *gc, int width, int height, osg::Texture *texture)
 
osg::CameraassignKeystoneDistortionCamera (osg::DisplaySettings *ds, osg::GraphicsContext *gc, int x, int y, int width, int height, GLenum buffer, osg::Texture *texture, Keystone *keystone)
 
osg::CameraassignStereoCamera (osg::DisplaySettings *ds, osg::GraphicsContext *gc, int x, int y, int width, int height, GLenum buffer, double eyeScale)
 
void assignStereoOrKeystoneToCamera (osg::Camera *camera, osg::DisplaySettings *ds)
 
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 to 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 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 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 UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, 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)
 
 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 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...
 
- Public Member Functions inherited from osgGA::GUIActionAdapter
virtual ~GUIActionAdapter ()
 

Protected Member Functions

virtual ~View ()
 
virtual osg::GraphicsOperationcreateRenderer (osg::Camera *camera)
 
- 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

osg::observer_ptr< ViewerBase_viewerBase
 
osg::Timer_t _startTick
 
Devices _eventSources
 
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
 
osg::ref_ptr< ViewConfig_lastAppliedViewConfig
 
- 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
 
- 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 CompositeViewer
 

Additional Inherited Members

- 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

View holds a single view on a scene, this view may be composed of one or more slave cameras.

Member Typedef Documentation

Constructor & Destructor Documentation

osgViewer::View::View ( )
osgViewer::View::View ( const osgViewer::View view,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgViewer::View::~View ( )
protectedvirtual

Reimplemented from osg::View.

Member Function Documentation

void osgViewer::View::addDevice ( osgGA::Device eventSource)

Add a Device.

The Device is polled on each new frame via it's Device::checkEvents() method and any events generated then collected via Device::getEventQueue()

template<class T >
void osgViewer::View::addDevice ( const osg::ref_ptr< T > &  eventSource)
inline
void osgViewer::View::addEventHandler ( osgGA::EventHandler eventHandler)

Add an EventHandler that adds handling of events to the View.

template<class T >
void osgViewer::View::addEventHandler ( const osg::ref_ptr< T > &  eventHandler)
inline
void osgViewer::View::apply ( ViewConfig config)

Apply a viewer configuration to set up Cameras and Windowing.

template<class T >
void osgViewer::View::apply ( const osg::ref_ptr< T > &  config)
inline
osg::Camera* osgViewer::View::assignKeystoneDistortionCamera ( osg::DisplaySettings ds,
osg::GraphicsContext gc,
int  x,
int  y,
int  width,
int  height,
GLenum  buffer,
osg::Texture texture,
Keystone keystone 
)
osg::Camera* osgViewer::View::assignRenderToTextureCamera ( osg::GraphicsContext gc,
int  width,
int  height,
osg::Texture texture 
)
void osgViewer::View::assignSceneDataToCameras ( )
osg::Camera* osgViewer::View::assignStereoCamera ( osg::DisplaySettings ds,
osg::GraphicsContext gc,
int  x,
int  y,
int  width,
int  height,
GLenum  buffer,
double  eyeScale 
)
void osgViewer::View::assignStereoOrKeystoneToCamera ( osg::Camera camera,
osg::DisplaySettings ds 
)
virtual osg::View* osgViewer::View::asView ( )
inlinevirtual

Provide a mechanism for getting the osg::View associated from the GUIActionAdapter.

One would use this to case view to osgViewer::View(er) if supported by the subclass.

Reimplemented from osgGA::GUIActionAdapter.

void osgViewer::View::computeActiveCoordinateSystemNodePath ( )

Compute the NodePath to any active CoordinateSystemNode present in the Scene.

bool osgViewer::View::computeIntersections ( float  x,
float  y,
osgUtil::LineSegmentIntersector::Intersections intersections,
osg::Node::NodeMask  traversalMask = 0xffffffff 
)

deprecated.

bool osgViewer::View::computeIntersections ( float  x,
float  y,
const osg::NodePath nodePath,
osgUtil::LineSegmentIntersector::Intersections intersections,
osg::Node::NodeMask  traversalMask = 0xffffffff 
)

deprecated.

bool osgViewer::View::computeIntersections ( const osgGA::GUIEventAdapter ea,
osgUtil::LineSegmentIntersector::Intersections intersections,
osg::Node::NodeMask  traversalMask = 0xffffffff 
)
virtual

Compute intersections of a ray, starting the current mouse position, through the specified camera.

Reimplemented from osgGA::GUIActionAdapter.

bool osgViewer::View::computeIntersections ( const osgGA::GUIEventAdapter ea,
const osg::NodePath nodePath,
osgUtil::LineSegmentIntersector::Intersections intersections,
osg::Node::NodeMask  traversalMask = 0xffffffff 
)
virtual

Compute intersections of a ray, starting the current mouse position, through the specified master camera's window/eye coordinates and a specified nodePath's subgraph.

Reimplemented from osgGA::GUIActionAdapter.

bool osgViewer::View::computeIntersections ( const osg::Camera camera,
osgUtil::Intersector::CoordinateFrame  cf,
float  x,
float  y,
osgUtil::LineSegmentIntersector::Intersections intersections,
osg::Node::NodeMask  traversalMask = 0xffffffff 
)

Compute intersections of a ray through the specified camera.

bool osgViewer::View::computeIntersections ( const osg::Camera camera,
osgUtil::Intersector::CoordinateFrame  cf,
float  x,
float  y,
const osg::NodePath nodePath,
osgUtil::LineSegmentIntersector::Intersections intersections,
osg::Node::NodeMask  traversalMask = 0xffffffff 
)

Compute intersections of a ray through the specified camera and a specified nodePath's subgraph.

bool osgViewer::View::containsCamera ( const osg::Camera camera) const

Return true if this view contains a specified camera.

template<class T >
bool osgViewer::View::containsCamera ( const osg::ref_ptr< T > &  camera) const
inline
osg::Texture* osgViewer::View::createDistortionTexture ( int  width,
int  height 
)
virtual osg::GraphicsOperation* osgViewer::View::createRenderer ( osg::Camera camera)
protectedvirtual

Reimplemented from osg::View.

const osg::Camera* osgViewer::View::getCameraContainingPosition ( float  x,
float  y,
float &  local_x,
float &  local_y 
) const

deprecated.

osgGA::CameraManipulator* osgViewer::View::getCameraManipulator ( )
inline

Get the View's CameraManipulator.

const osgGA::CameraManipulator* osgViewer::View::getCameraManipulator ( ) const
inline

Get the const View's CameraManipulator.

osg::NodePath osgViewer::View::getCoordinateSystemNodePath ( ) const

Get the NodePath to any active CoordinateSystemNode present in the Scene.

osgDB::DatabasePager* osgViewer::View::getDatabasePager ( )

Get the View's database pager.

const osgDB::DatabasePager* osgViewer::View::getDatabasePager ( ) const

Get the const View's database pager.

osg::DisplaySettings* osgViewer::View::getDisplaySettings ( )
inline

Set the DisplaySettings object associated with this view.

const osg::DisplaySettings* osgViewer::View::getDisplaySettings ( ) const
inline

Set the DisplaySettings object associated with this view.

EventHandlers& osgViewer::View::getEventHandlers ( )
inline

Get the View's list of EventHandlers.

const EventHandlers& osgViewer::View::getEventHandlers ( ) const
inline

Get the const View's list of EventHandlers.

osgGA::EventQueue* osgViewer::View::getEventQueue ( )
inline
const osgGA::EventQueue* osgViewer::View::getEventQueue ( ) const
inline
osgUtil::SceneView::FusionDistanceMode osgViewer::View::getFusionDistanceMode ( ) const
inline

Get the FusionDistanceMode.

float osgViewer::View::getFusionDistanceValue ( ) const
inline

Get the FusionDistanceValue.

Note, only used for USE_FUSION_DISTANCE_VALUE & PROPORTIONAL_TO_SCREEN_DISTANCE modes.

osgDB::ImagePager* osgViewer::View::getImagePager ( )

Get the View's image pager.

const osgDB::ImagePager* osgViewer::View::getImagePager ( ) const

Get the const View's image pager.

ViewConfig* osgViewer::View::getLastAppliedViewConfig ( )
inline
const ViewConfig* osgViewer::View::getLastAppliedViewConfig ( ) const
inline
Scene* osgViewer::View::getScene ( )
inline
const Scene* osgViewer::View::getScene ( ) const
inline
osg::Node* osgViewer::View::getSceneData ( )
inline

Get the View's scene graph.

const osg::Node* osgViewer::View::getSceneData ( ) const
inline

Get the const View's scene graph.

osg::Timer_t osgViewer::View::getStartTick ( ) const
inline
ViewerBase* osgViewer::View::getViewerBase ( )
inline

Provide a mechanism for getting the viewer object from this osgViewer::View.

In the case of a osgViewer::Viewer the ViewerBase will effectively point to this object as Viewer subclasses from View. In the case of a osgViewer::CompsoiteViewer the ViewerBase will point to the CompositeViewer that owns this View.

void osgViewer::View::home ( )

Set the view to the CameraManipulator's home position, if none is attached home() it does nothing.

Note, to set the home position use getCamaraManipulator()->setHomePosition(...).

void osgViewer::View::init ( )
osgViewer::View::META_Object ( osgViewer  ,
View   
)
void osgViewer::View::removeEventHandler ( osgGA::EventHandler eventHandler)

Remove an EventHandler from View.

template<class T >
void osgViewer::View::removeEventHandler ( const osg::ref_ptr< T > &  eventHandler)
inline
virtual void osgViewer::View::requestContinuousUpdate ( bool  needed = true)
virtual

requestContinuousUpdate(bool) is for en/disabling a throw or idle callback to be requested by a GUIEventHandler (typically a CameraManipulator, though other GUIEventHandler's may also provide functionality).

GUI toolkits can respond to this immediately by registering an idle/timed callback, or can delay setting the callback and update at their own leisure.

Implements osgGA::GUIActionAdapter.

virtual void osgViewer::View::requestRedraw ( )
virtual

requestRedraw() requests a single redraw.

Implements osgGA::GUIActionAdapter.

virtual void osgViewer::View::requestWarpPointer ( float  x,
float  y 
)
virtual

requestWarpPointer(int,int) is requesting a repositioning of the mouse pointer to a specified x,y location on the window.

This is used by some camera manipulators to initialise the mouse pointer when mouse position relative to a controls neutral mouse position is required, i.e when mimicking an aircraft joystick.

Implements osgGA::GUIActionAdapter.

void osgViewer::View::setCameraManipulator ( osgGA::CameraManipulator manipulator,
bool  resetPosition = true 
)

Set the CameraManipulator that moves the View's master Camera position in response to events.

The parameter resetPosition determines whether manipulator is set to its home position.

template<class T >
void osgViewer::View::setCameraManipulator ( const osg::ref_ptr< T > &  manipulator,
bool  resetPosition = true 
)
inline
void osgViewer::View::setCoordinateSystemNodePath ( const osg::NodePath nodePath)

Set the NodePath to any active CoordinateSystemNode present in the Scene.

The CoordinateSystemNode path is used to help applications and CamaraManipulators handle geocentric coordinates systems, so that the local up direction is known at any position on the whole earth.

void osgViewer::View::setDatabasePager ( osgDB::DatabasePager dp)

Set the View's database pager.

template<class T >
void osgViewer::View::setDatabasePager ( const osg::ref_ptr< T > &  dp)
inline
void osgViewer::View::setDisplaySettings ( osg::DisplaySettings ds)
inline

Set the DisplaySettings object associated with this view.

template<class T >
void osgViewer::View::setDisplaySettings ( const osg::ref_ptr< T > &  ds)
inline
void osgViewer::View::setEventQueue ( osgGA::EventQueue eventQueue)
inline

Remove a Device.

/*/ void removeDevice(osgGA::Device* eventSource);

template<class T> void removeDevice(const osg::ref_ptr<T>& eventSource) { removeDevice(eventSource.get()); }

typedef std::vector< osg::ref_ptr<osgGA::Device> > Devices;

Devices& getDevices() { return _eventSources; } const Devices& getDevices() const { return _eventSources; }

/* Set the EventQueue that the View uses to integrate external non window related events.

template<class T >
void osgViewer::View::setEventQueue ( const osg::ref_ptr< T > &  eventQueue)
inline
void osgViewer::View::setFusionDistance ( osgUtil::SceneView::FusionDistanceMode  mode,
float  value = 1.0f 
)
inline

Set the FusionDistanceMode and Value.

Note, only used when working in stereo.

void osgViewer::View::setImagePager ( osgDB::ImagePager ip)

Set the View's image pager.

template<class T >
void osgViewer::View::setImagePager ( const osg::ref_ptr< T > *  ip)
inline
virtual void osgViewer::View::setSceneData ( osg::Node node)
virtual

Set the scene graph that the View will use.

Reimplemented in osgViewer::Viewer.

template<class T >
void osgViewer::View::setSceneData ( const osg::ref_ptr< T > &  node)
inline
virtual void osgViewer::View::setStartTick ( osg::Timer_t  tick)
virtual

Reimplemented in osgViewer::Viewer.

bool osgViewer::View::setUpDepthPartition ( DepthPartitionSettings dsp = 0)

Convenience method for setting up multiple slave cameras with depth partitioning on each of the view's active cameras.

bool osgViewer::View::setUpDepthPartitionForCamera ( osg::Camera cameraToPartition,
DepthPartitionSettings dps = 0 
)

Convenience method for setting up depth partitioning on the specified camera.

void osgViewer::View::setUpViewAcrossAllScreens ( )

deprecated, use view.apply(new osgViewer::AcrossAllWindows()).

void osgViewer::View::setUpViewFor3DSphericalDisplay ( double  radius = 1.0,
double  collar = 0.45,
unsigned int  screenNum = 0,
osg::Image intensityMap = 0,
const osg::Matrixd projectorMatrix = osg::Matrixd() 
)

deprecated, use view.apply(new osgViewer::SphericalDisplay(radius, collar, screenNum, intensityMap, projectorMatrix)).

void osgViewer::View::setUpViewForPanoramicSphericalDisplay ( double  radius = 1.0,
double  collar = 0.45,
unsigned int  screenNum = 0,
osg::Image intensityMap = 0,
const osg::Matrixd projectorMatrix = osg::Matrixd() 
)

deprecated, use view.apply(new osgViewer::PanoramicSphericalDisplay(radius, collar, screenNum, intensityMap, projectorMatrix)).

void osgViewer::View::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 
)

deprecated.

use view.apply(new osgViewer::WoWVxDisplay(type (20 to 42), screenNum).

void osgViewer::View::setUpViewInWindow ( int  x,
int  y,
int  width,
int  height,
unsigned int  screenNum = 0 
)

deprecated, use view.apply(new osgViewer::SingleWindow(x,y,width,screenNum)).

void osgViewer::View::setUpViewOnSingleScreen ( unsigned int  screenNum = 0)

deprecated, use view.apply(new osgViewer::SingleScreen(screenNum)).

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

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

Reimplemented from osg::View.

Reimplemented in osgViewer::Viewer.

Friends And Related Function Documentation

friend class CompositeViewer
friend

Member Data Documentation

osg::ref_ptr<osgGA::CameraManipulator> osgViewer::View::_cameraManipulator
protected
osg::ObserverNodePath osgViewer::View::_coordinateSystemNodePath
protected
osg::ref_ptr<osg::DisplaySettings> osgViewer::View::_displaySettings
protected
EventHandlers osgViewer::View::_eventHandlers
protected
osg::ref_ptr<osgGA::EventQueue> osgViewer::View::_eventQueue
protected
Devices osgViewer::View::_eventSources
protected
osgUtil::SceneView::FusionDistanceMode osgViewer::View::_fusionDistanceMode
protected
float osgViewer::View::_fusionDistanceValue
protected
osg::ref_ptr<ViewConfig> osgViewer::View::_lastAppliedViewConfig
protected
osg::ref_ptr<osgViewer::Scene> osgViewer::View::_scene
protected
osg::Timer_t osgViewer::View::_startTick
protected
osg::observer_ptr<ViewerBase> osgViewer::View::_viewerBase
protected

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

osg logo
Generated at Wed Nov 11 2015 22:15:22 for the OpenSceneGraph by doxygen 1.8.10.