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:

[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::Stats *	getStats ()
	Get the Viewers Stats object. More...

const osg::Stats *	getStats () 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::Light *	getLight ()
	Get the global lighting if assigned. More...

const osg::Light *	getLight () const
	Get the const global lighting if assigned. More...

void	setCamera (osg::Camera *camera)
	Set the master camera of the view. More...

osg::Camera *	getCamera ()
	Get the master camera of the view. More...

const osg::Camera *	getCamera () const
	Get the const master camera of the view. More...

void	setFrameStamp (osg::FrameStamp *fs)
	Set the frame stamp of the view. More...

osg::FrameStamp *	getFrameStamp ()
	Get the frame stamp of the view. More...

const osg::FrameStamp *	getFrameStamp () 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

Slave &	getSlave (unsigned int pos)

const Slave &	getSlave (unsigned int pos) const

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

Slave *	findSlaveForCamera (osg::Camera *camera)

void	updateSlaves ()

virtual void	resizeGLObjectBuffers (unsigned int maxSize)
	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...

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 Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (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 Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...

virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...

virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...

virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...

virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...

virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...

virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...

virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...

virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...

virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...

virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...

virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...

virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...

virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...

virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, 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::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	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 Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () 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...

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)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...

	Referenced (const Referenced &)

Referenced &	operator= (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...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () 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< Slave >	Slaves

Protected Member Functions
virtual	~View ()

virtual osg::GraphicsOperation *	createRenderer (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	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	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

◆ Slaves

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

protected

Member Enumeration Documentation

◆ LightingMode

enum osg::View::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::Viewer, and osgViewer::View.

◆ 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:

osg/View

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Slaves

Member Enumeration Documentation

◆ LightingMode

Constructor & Destructor Documentation

◆ View() [1/2]

◆ View() [2/2]

◆ ~View()

Member Function Documentation

◆ addSlave() [1/2]

◆ addSlave() [2/2]

◆ createRenderer()

◆ findSlaveForCamera()

◆ findSlaveIndexForCamera()

◆ getCamera() [1/2]

◆ getCamera() [2/2]

◆ getFrameStamp() [1/2]

◆ getFrameStamp() [2/2]

◆ getLight() [1/2]

◆ getLight() [2/2]

◆ getLightingMode()

◆ getNumSlaves()

◆ getSlave() [1/2]

◆ getSlave() [2/2]

◆ getStats() [1/2]

◆ getStats() [2/2]

◆ META_Object()

◆ releaseGLObjects()

◆ removeSlave()

◆ resizeGLObjectBuffers()

◆ setCamera()

◆ setFrameStamp()

◆ setLight()

◆ setLightingMode()

◆ setStats()

◆ take()

◆ updateSlaves()

Member Data Documentation

◆ _camera

◆ _frameStamp

◆ _light

◆ _lightingMode

◆ _slaves

◆ _stats