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

#include <View>

Inheritance diagram for osg::View:
osg::Object osg::Referenced osgViewer::View osgViewer::Viewer

Classes

struct  Slave
 

Public Types

enum  LightingMode { NO_LIGHT , HEADLIGHT , SKY_LIGHT }
 
- 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)
 
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 ()
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *=0) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 
virtual const char * className () const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Types

typedef std::vector< SlaveSlaves
 

Protected Member Functions

virtual ~View ()
 
virtual osg::GraphicsOperationcreateRenderer (osg::Camera *)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

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::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

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

◆ Slaves

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

Member Enumeration Documentation

◆ LightingMode

Options for controlling the global lighting used for the view.

Enumerator
NO_LIGHT 
HEADLIGHT 
SKY_LIGHT 

Constructor & Destructor Documentation

◆ View() [1/2]

osg::View::View ( )

◆ View() [2/2]

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

◆ ~View()

virtual osg::View::~View ( )
protectedvirtual

Reimplemented in osgViewer::View.

Member Function Documentation

◆ addSlave() [1/2]

bool osg::View::addSlave ( osg::Camera camera,
bool  useMastersSceneData = true 
)
inline

◆ addSlave() [2/2]

bool osg::View::addSlave ( osg::Camera camera,
const osg::Matrix projectionOffset,
const osg::Matrix viewOffset,
bool  useMastersSceneData = true 
)

◆ createRenderer()

virtual osg::GraphicsOperation * osg::View::createRenderer ( osg::Camera )
inlineprotectedvirtual

Reimplemented in osgViewer::View.

◆ findSlaveForCamera()

Slave * osg::View::findSlaveForCamera ( osg::Camera camera)

◆ findSlaveIndexForCamera()

unsigned int osg::View::findSlaveIndexForCamera ( osg::Camera camera) const

◆ getCamera() [1/2]

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

Get the master camera of the view.

◆ getCamera() [2/2]

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

Get the const master camera of the view.

◆ getFrameStamp() [1/2]

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

Get the frame stamp of the view.

◆ getFrameStamp() [2/2]

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

Get the frame stamp of the view.

◆ getLight() [1/2]

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

Get the global lighting if assigned.

◆ getLight() [2/2]

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

Get the const global lighting if assigned.

◆ getLightingMode()

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

Get the global lighting used for this view.

◆ getNumSlaves()

unsigned int osg::View::getNumSlaves ( ) const
inline

◆ getSlave() [1/2]

Slave & osg::View::getSlave ( unsigned int  pos)
inline

◆ getSlave() [2/2]

const Slave & osg::View::getSlave ( unsigned int  pos) const
inline

◆ getStats() [1/2]

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

Get the Viewers Stats object.

◆ getStats() [2/2]

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

Get the Viewers Stats object.

◆ META_Object()

osg::View::META_Object ( osg  ,
View   
)

◆ releaseGLObjects()

virtual void osg::View::releaseGLObjects ( osg::State = 0) const
virtual

If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. Otherwise, releases OpenGL objects for all graphics contexts.

Reimplemented from osg::Object.

Reimplemented in osgViewer::Viewer.

◆ removeSlave()

bool osg::View::removeSlave ( unsigned int  pos)

◆ resizeGLObjectBuffers()

virtual void osg::View::resizeGLObjectBuffers ( unsigned int  )
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

Reimplemented in osgViewer::Viewer.

◆ setCamera()

void osg::View::setCamera ( osg::Camera camera)

Set the master camera of the view.

◆ setFrameStamp()

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

Set the frame stamp of the view.

◆ setLight()

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

Get the global light.

◆ setLightingMode()

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

Set the global lighting to use for this view. Defaults to headlight.

◆ setStats()

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

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

◆ take()

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.

◆ updateSlaves()

void osg::View::updateSlaves ( )

Member Data Documentation

◆ _camera

osg::ref_ptr<osg::Camera> osg::View::_camera
protected

◆ _frameStamp

osg::ref_ptr<osg::FrameStamp> osg::View::_frameStamp
protected

◆ _light

osg::ref_ptr<osg::Light> osg::View::_light
protected

◆ _lightingMode

LightingMode osg::View::_lightingMode
protected

◆ _slaves

Slaves osg::View::_slaves
protected

◆ _stats

osg::ref_ptr<osg::Stats> osg::View::_stats
protected

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