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:

[legend]

List of all members.

Public Types
enum	LightingMode { NO_LIGHT, HEADLIGHT, SKY_LIGHT }
	Options for controlling the global lighting used for the view. More...
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.
void	setLightingMode (LightingMode lightingMode)
	Set the global lighting to use for this view.
LightingMode	getLightingMode () const
	Get the global lighting used for this view.
void	setLight (osg::Light *light)
	Get the global light.
osg::Light *	getLight ()
	Get the global lighting if assigned.
const osg::Light *	getLight () const
	Get the const global lighting if assigned.
void	setCamera (osg::Camera *camera)
	Set the master camera of the view.
osg::Camera *	getCamera ()
	Get the master camera of the view.
const osg::Camera *	getCamera () const
	Get the const master camera of the view.
bool	addSlave (osg::Camera *camera, bool useMastersSceneData=true)
bool	addSlave (osg::Camera *camera, const osg::Matrix &projectionOffset, const osg::Matrix &viewOffse, 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)
Slave *	findSlaveForCamera (osg::Camera *camera)
void	updateSlaves ()
void	updateSlave (unsigned int i)
Protected Types
typedef std::vector < Slave >	Slaves
Protected Member Functions
virtual	~View ()
virtual osg::GraphicsOperation *	createRenderer (osg::Camera *)
Protected Attributes
LightingMode	_lightingMode
osg::ref_ptr < osg::Light >	_light
osg::ref_ptr < osg::Camera >	_camera
Slaves	_slaves
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...

---

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

enum osg::View::LightingMode

Options for controlling the global lighting used for the view.

Enumerator:

NO_LIGHT
HEADLIGHT
SKY_LIGHT

---

Constructor & Destructor Documentation

osg::View::View

(

)

Reimplemented in osgViewer::View.

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

virtual osg::View::~View

(

)

[protected, virtual]

Reimplemented in osgViewer::View.

---

Member Function Documentation

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

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.

void osg::View::setLightingMode

(

LightingMode

lightingMode

)

Set the global lighting to use for this view.

Defaults to headlight.

LightingMode osg::View::getLightingMode

(

)

const [inline]

Get the global lighting used for this view.

void osg::View::setLight

(

osg::Light *

light

)

[inline]

Get the global light.

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.

void osg::View::setCamera

(

osg::Camera *

camera

)

Set the master camera of the view.

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.

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 &	viewOffse,
		bool	useMastersSceneData = true
	)

bool osg::View::removeSlave

(

unsigned int

pos

)

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]

unsigned int osg::View::findSlaveIndexForCamera

(

osg::Camera *

camera

)

Slave* osg::View::findSlaveForCamera

(

osg::Camera *

camera

)

void osg::View::updateSlaves

(

)

void osg::View::updateSlave

(

unsigned int

i

)

virtual osg::GraphicsOperation* osg::View::createRenderer

(

osg::Camera *

)

[inline, protected, virtual]

Reimplemented in osgViewer::View.

---

Member Data Documentation

LightingMode osg::View::_lightingMode [protected]

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

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

Slaves osg::View::_slaves [protected]

---

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

• View

---