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

View - maintains a master camera view and a list of slave cameras that are relative to this master camera. More...

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

Classes

struct  Slave
 Slave allows one to up a camera that follows the master with a local offset to the project and view matrices. More...
 

Public Types

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 osg::View &view, const osg::CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Object (osg, View)
 
virtual void take (View &rhs)
 Take all the settings, Camera and Slaves from the passed in view, leaving it empty. More...
 
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...
 

Protected Types

typedef std::vector< SlaveSlaves
 

Protected Member Functions

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

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...
 

Detailed Description

View - maintains a master camera view and a list of slave cameras that are relative to this master camera.

Note, if no slave cameras are attached to the view then the master camera does both the control and implementation of the rendering of the scene, but if slave cameras are present then the master controls the view onto the scene, while the slaves implement the rendering of the scene.

Member Typedef Documentation

typedef std::vector<Slave> osg::View::Slaves
protected

Member Enumeration Documentation

Options for controlling the global lighting used for the view.

Enumerator
NO_LIGHT 
HEADLIGHT 
SKY_LIGHT 

Constructor & Destructor Documentation

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

Reimplemented in osgViewer::View.

Member Function Documentation

bool osg::View::addSlave ( osg::Camera camera,
bool  useMastersSceneData = true 
)
inline
bool osg::View::addSlave ( osg::Camera camera,
const osg::Matrix projectionOffset,
const osg::Matrix viewOffset,
bool  useMastersSceneData = true 
)
virtual osg::GraphicsOperation* osg::View::createRenderer ( osg::Camera )
inlineprotectedvirtual

Reimplemented in osgViewer::View.

Slave* osg::View::findSlaveForCamera ( osg::Camera camera)
unsigned int osg::View::findSlaveIndexForCamera ( osg::Camera camera) const
osg::Camera* osg::View::getCamera ( )
inline

Get the master camera of the view.

const osg::Camera* osg::View::getCamera ( ) const
inline

Get the const master camera of the view.

osg::FrameStamp* osg::View::getFrameStamp ( )
inline

Get the frame stamp of the view.

const osg::FrameStamp* osg::View::getFrameStamp ( ) const
inline

Get the frame stamp of the view.

osg::Light* osg::View::getLight ( )
inline

Get the global lighting if assigned.

const osg::Light* osg::View::getLight ( ) const
inline

Get the const global lighting if assigned.

LightingMode osg::View::getLightingMode ( ) const
inline

Get the global lighting used for this view.

unsigned int osg::View::getNumSlaves ( ) const
inline
Slave& osg::View::getSlave ( unsigned int  pos)
inline
const Slave& osg::View::getSlave ( unsigned int  pos) const
inline
osg::Stats* osg::View::getStats ( )
inline

Get the Viewers Stats object.

const osg::Stats* osg::View::getStats ( ) const
inline

Get the Viewers Stats object.

osg::View::META_Object ( osg  ,
View   
)
bool osg::View::removeSlave ( unsigned int  pos)
void osg::View::setCamera ( osg::Camera camera)

Set the master camera of the view.

void osg::View::setFrameStamp ( osg::FrameStamp fs)
inline

Set the frame stamp of the view.

void osg::View::setLight ( osg::Light light)
inline

Get the global light.

void osg::View::setLightingMode ( LightingMode  lightingMode)

Set the global lighting to use for this view.

Defaults to headlight.

void osg::View::setStats ( osg::Stats stats)
inline

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

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

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

Reimplemented in osgViewer::View, and osgViewer::Viewer.

void osg::View::updateSlaves ( )

Member Data Documentation

osg::ref_ptr<osg::Camera> osg::View::_camera
protected
osg::ref_ptr<osg::FrameStamp> osg::View::_frameStamp
protected
osg::ref_ptr<osg::Light> osg::View::_light
protected
LightingMode osg::View::_lightingMode
protected
Slaves osg::View::_slaves
protected
osg::ref_ptr<osg::Stats> osg::View::_stats
protected

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

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