osg::Camera

osg::Camera Class Reference

Camera - is a subclass of Transform which represents encapsulates the settings of a Camera. More...

Inheritance diagram for osg::Camera:

List of all members.

Public Types

enum TransformOrder { PRE_MULTIPLY, POST_MULTIPLY }

enum ProjectionResizePolicy { FIXED, HORIZONTAL, VERTICAL }

enum RenderOrder { PRE_RENDER, NESTED_RENDER, POST_RENDER }

enum RenderTargetImplementation {
  FRAME_BUFFER_OBJECT, PIXEL_BUFFER_RTT, PIXEL_BUFFER, FRAME_BUFFER,
  SEPERATE_WINDOW
}

enum BufferComponent {
  DEPTH_BUFFER, STENCIL_BUFFER, COLOR_BUFFER, COLOR_BUFFER0 = COLOR_BUFFER,
  COLOR_BUFFER1 = COLOR_BUFFER+1, COLOR_BUFFER2 = COLOR_BUFFER+2, COLOR_BUFFER3 = COLOR_BUFFER+3, COLOR_BUFFER4 = COLOR_BUFFER+4,
  COLOR_BUFFER5 = COLOR_BUFFER+5, COLOR_BUFFER6 = COLOR_BUFFER+6, COLOR_BUFFER7 = COLOR_BUFFER+7
}

typedef std::map
< BufferComponent,
Attachment > BufferAttachmentMap

Public Member Functions

Camera ()

Camera (const Camera &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

Copy constructor using CopyOp to manage deep vs shallow copy.

META_Node (osg, Camera)

void setView (View *view)

Set the View that this Camera is part of.

View * getView ()

Get the View that this Camera is part of.

const View * getView () const

Get the const View that this Camera is part of.

void setStats (osg::Stats *stats)

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

osg::Stats * getStats ()

Get the Stats object.

const osg::Stats * getStats () const

Get the const Stats object.

void setAllowEventFocus (bool focus)

Set whether this camera allows events to be generated by the associated graphics window to be associated with this camera.

bool getAllowEventFocus () const

Get whether this camera allows events to be generated by the associated graphics window to be associated with this camera.

void setDisplaySettings (osg::DisplaySettings *ds)

Set the DsplaySettings object associated with this view.

osg::DisplaySettings * getDisplaySettings ()

Set the DsplaySettings object associated with this view.

const
osg::DisplaySettings * getDisplaySettings () const

Set the DsplaySettings object associated with this view.

void setClearColor (const Vec4 &color)

Sets the clear color.

const Vec4 & getClearColor () const

Returns the clear color.

void setClearMask (GLbitfield mask)

Set the clear mask used in glClear(.

GLbitfield getClearMask () const

Get the clear mask.

void setColorMask (osg::ColorMask *colorMask)

Set the color mask of the camera to use specified osg::ColorMask.

void setColorMask (bool red, bool green, bool blue, bool alpha)

Set the color mask of the camera to specified values.

const ColorMask * getColorMask () const

Get the const ColorMask.

ColorMask * getColorMask ()

Get the ColorMask.

void setViewport (osg::Viewport *viewport)

Set the viewport of the camera to use specified osg::Viewport.

void setViewport (int x, int y, int width, int height)

Set the viewport of the camera to specified dimensions.

const Viewport * getViewport () const

Get the const viewport.

Viewport * getViewport ()

Get the viewport.

void setTransformOrder (TransformOrder order)

Set the transformation order for world-to-local and local-to-world transformation.

TransformOrder getTransformOrder () const

Get the transformation order.

void setProjectionResizePolicy (ProjectionResizePolicy policy)

Set the policy used to determin if and how the projection matrix should be adjusted on window resizes.

ProjectionResizePolicy getProjectionResizePolicy () const

Get the policy used to determin if and how the projection matrix should be adjusted on window resizes.

void setProjectionMatrix (const osg::Matrixf &matrix)

Set the projection matrix.

void setProjectionMatrix (const osg::Matrixd &matrix)

Set the projection matrix.

void setProjectionMatrixAsOrtho (double left, double right, double bottom, double top, double zNear, double zFar)

Set to an orthographic projection.

void setProjectionMatrixAsOrtho2D (double left, double right, double bottom, double top)

Set to a 2D orthographic projection.

void setProjectionMatrixAsFrustum (double left, double right, double bottom, double top, double zNear, double zFar)

Set to a perspective projection.

void setProjectionMatrixAsPerspective (double fovy, double aspectRatio, double zNear, double zFar)

Create a symmetrical perspective projection, See OpenGL gluPerspective documentation for further details.

osg::Matrixd & getProjectionMatrix ()

Get the projection matrix.

const osg::Matrixd & getProjectionMatrix () const

Get the const projection matrix.

bool getProjectionMatrixAsOrtho (double &left, double &right, double &bottom, double &top, double &zNear, double &zFar)

Get the othographic settings of the orthographic projection matrix.

bool getProjectionMatrixAsFrustum (double &left, double &right, double &bottom, double &top, double &zNear, double &zFar)

Get the frustum setting of a perspective projection matrix.

bool getProjectionMatrixAsPerspective (double &fovy, double &aspectRatio, double &zNear, double &zFar)

Get the frustum setting of a symmetric perspective projection matrix.

void setViewMatrix (const osg::Matrixf &matrix)

Set the view matrix.

void setViewMatrix (const osg::Matrixd &matrix)

Set the view matrix.

void setViewMatrixAsLookAt (const osg::Vec3 &eye, const osg::Vec3 &center, const osg::Vec3 &up)

Set to the position and orientation of view matrix, using the same convention as gluLookAt.

osg::Matrixd & getViewMatrix ()

Get the view matrix.

const osg::Matrixd & getViewMatrix () const

Get the const view matrix.

void getViewMatrixAsLookAt (osg::Vec3 &eye, osg::Vec3 &center, osg::Vec3 &up, float lookDistance=1.0f)

Get to the position and orientation of a modelview matrix, using the same convention as gluLookAt.

Matrixd getInverseViewMatrix () const

Get the inverse view matrix.

void setRenderOrder (RenderOrder order, int orderNum=0)

Set the rendering order of this camera's subgraph relative to any camera that this subgraph is nested within.

RenderOrder getRenderOrder () const

Get the rendering order of this camera's subgraph relative to any camera that this subgraph is nested within.

int getRenderOrderNum () const

Get the rendering order number of this camera relative to any sibling cameras in this subgraph.

bool isRenderToTextureCamera () const

Return true if this Camera is set up as a render to texture camera, i.e.

void setRenderTargetImplementation (RenderTargetImplementation impl)

Set the render target.

void setRenderTargetImplementation (RenderTargetImplementation impl, RenderTargetImplementation fallback)

Set the render target and fall-back that's used if the former isn't available.

RenderTargetImplementation getRenderTargetImplementation () const

Get the render target.

RenderTargetImplementation getRenderTargetFallback () const

Get the render target fallback.

void setDrawBuffer (GLenum buffer)

Set the draw buffer used at the start of each frame draw.

GLenum getDrawBuffer () const

Get the draw buffer used at the start of each frame draw.

void setReadBuffer (GLenum buffer)

Set the read buffer for any required copy operations to use.

GLenum getReadBuffer () const

Get the read buffer for any required copy operations to use.

void attach (BufferComponent buffer, GLenum internalFormat)

void attach (BufferComponent buffer, osg::Texture *texture, unsigned int level=0, unsigned int face=0, bool mipMapGeneration=false)

void attach (BufferComponent buffer, osg::Image *image)

void detach (BufferComponent buffer)

BufferAttachmentMap & getBufferAttachmentMap ()

Get the BufferAttachmentMap, used to configure frame buffer objects, pbuffers and texture reads.

const
BufferAttachmentMap & getBufferAttachmentMap () const

Get the const BufferAttachmentMap, used to configure frame buffer objects, pbuffers and texture reads.

void createCameraThread ()

Create a operation thread for this camera.

void setCameraThread (OperationThread *gt)

Assign a operation thread to the camera.

OperationThread * getCameraThread ()

Get the operation thread assigned to this camera.

const OperationThread * getCameraThread () const

Get the const operation thread assigned to this camera.

void setGraphicsContext (GraphicsContext *context)

Set the GraphicsContext that provides the mechansim for managing the OpenGL graphics context associated with this camera.

GraphicsContext * getGraphicsContext ()

Get the GraphicsContext.

const GraphicsContext * getGraphicsContext () const

Get the const GraphicsContext.

void setRenderer (osg::GraphicsOperation *rc)

Set the Rendering object that is used to implement rendering of the subgraph.

osg::GraphicsOperation * getRenderer ()

Get the Rendering object that is used to implement rendering of the subgraph.

const
osg::GraphicsOperation * getRenderer () const

Get the const Rendering object that is used to implement rendering of the subgraph.

void setRenderingCache (osg::Object *rc)

Set the Rendering cache that is used for cached objects associated with rendering of subgraphs.

osg::Object * getRenderingCache ()

Get the Rendering cache that is used for cached objects associated with rendering of subgraphs.

const osg::Object * getRenderingCache () const

Get the const Rendering cache that is used for cached objects associated with rendering of subgraphs.

void setPreDrawCallback (DrawCallback *cb)

Set the pre draw callback for custom operations to be done before the drawing of the camera's subgraph has been completed.

DrawCallback * getPreDrawCallback ()

Get the pre draw callback.

const DrawCallback * getPreDrawCallback () const

Get the const pre draw callback.

void setPostDrawCallback (DrawCallback *cb)

Set the post draw callback for custom operations to be done after the drawing of the camera's subgraph has been completed.

DrawCallback * getPostDrawCallback ()

Get the post draw callback.

const DrawCallback * getPostDrawCallback () const

Get the const post draw callback.

OpenThreads::Mutex * getDataChangeMutex () const

virtual void resizeGLObjectBuffers (unsigned int maxSize)

Resize any per context GLObject buffers to specified size.

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

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

virtual bool computeLocalToWorldMatrix (Matrix &matrix, NodeVisitor *) const

Transform method that must be defined to provide generic interface for scene graph traversals.

virtual bool computeWorldToLocalMatrix (Matrix &matrix, NodeVisitor *) const

Transform method that must be defined to provide generic interface for scene graph traversals.

Protected Member Functions

virtual ~Camera ()

Protected Attributes

OpenThreads::Mutex _dataChangeMutex

View * _view

osg::ref_ptr
< osg::Stats > _stats

bool _allowEventFocus

osg::ref_ptr
< osg::DisplaySettings > _displaySettings

Vec4 _clearColor

GLbitfield _clearMask

ref_ptr< ColorMask > _colorMask

ref_ptr< Viewport > _viewport

TransformOrder _transformOrder

ProjectionResizePolicy _projectionResizePolicy

Matrixd _projectionMatrix

Matrixd _viewMatrix

RenderOrder _renderOrder

int _renderOrderNum

GLenum _drawBuffer

GLenum _readBuffer

RenderTargetImplementation _renderTargetImplementation

RenderTargetImplementation _renderTargetFallback

BufferAttachmentMap _bufferAttachmentMap

ref_ptr
< OperationThread > _cameraThread

ref_ptr
< GraphicsContext > _graphicsContext

ref_ptr
< GraphicsOperation > _renderer

ref_ptr< Object > _renderingCache

ref_ptr< DrawCallback > _preDrawCallback

ref_ptr< DrawCallback > _postDrawCallback

Classes

struct Attachment

struct DrawCallback

Draw callback for custom operations. More...

Detailed Description

Camera - is a subclass of Transform which represents encapsulates the settings of a Camera.

Member Typedef Documentation

typedef std::map< BufferComponent, Attachment> osg::Camera::BufferAttachmentMap

Member Enumeration Documentation

enum osg::Camera::TransformOrder

Enumerator:

PRE_MULTIPLY
POST_MULTIPLY

enum osg::Camera::ProjectionResizePolicy

Enumerator:

FIXED
HORIZONTAL	Keep the projection matrix fixed, despite window resizes.
VERTICAL	Adjust the HORIZOTNAL field of view on window resizes. Adjust the VERTICAL field of view on window resizes.

enum osg::Camera::RenderOrder

Enumerator:

PRE_RENDER
NESTED_RENDER
POST_RENDER

enum osg::Camera::RenderTargetImplementation

Enumerator:

FRAME_BUFFER_OBJECT
PIXEL_BUFFER_RTT
PIXEL_BUFFER
FRAME_BUFFER
SEPERATE_WINDOW

enum osg::Camera::BufferComponent

Enumerator:

DEPTH_BUFFER
STENCIL_BUFFER
COLOR_BUFFER
COLOR_BUFFER0
COLOR_BUFFER1
COLOR_BUFFER2
COLOR_BUFFER3
COLOR_BUFFER4
COLOR_BUFFER5
COLOR_BUFFER6
COLOR_BUFFER7

Constructor & Destructor Documentation

osg::Camera::Camera ( )

osg::Camera::Camera	(	const Camera &	,
		const CopyOp &	copyop = `CopyOp::SHALLOW_COPY`
	)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Camera::~Camera ( ) [protected, virtual]

Member Function Documentation

osg::Camera::META_Node	(	osg	,
		Camera
	)

void osg::Camera::setView ( View * view ) [inline]

Set the View that this Camera is part of.

View* osg::Camera::getView ( ) [inline]

Get the View that this Camera is part of.

const View* osg::Camera::getView ( ) const [inline]

Get the const View that this Camera is part of.

void osg::Camera::setStats ( osg::Stats * stats ) [inline]

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

osg::Stats* osg::Camera::getStats ( ) [inline]

Get the Stats object.

const osg::Stats* osg::Camera::getStats ( ) const [inline]

Get the const Stats object.

void osg::Camera::setAllowEventFocus ( bool focus ) [inline]

Set whether this camera allows events to be generated by the associated graphics window to be associated with this camera.

bool osg::Camera::getAllowEventFocus ( ) const [inline]

Get whether this camera allows events to be generated by the associated graphics window to be associated with this camera.

void osg::Camera::setDisplaySettings ( osg::DisplaySettings * ds ) [inline]

Set the DsplaySettings object associated with this view.

osg::DisplaySettings* osg::Camera::getDisplaySettings ( ) [inline]

Set the DsplaySettings object associated with this view.

const osg::DisplaySettings* osg::Camera::getDisplaySettings ( ) const [inline]

Set the DsplaySettings object associated with this view.

void osg::Camera::setClearColor ( const Vec4 & color ) [inline]

Sets the clear color.

const Vec4& osg::Camera::getClearColor ( ) const [inline]

Returns the clear color.

void osg::Camera::setClearMask ( GLbitfield mask ) [inline]

Set the clear mask used in glClear(.

.). Defaults to GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT.

GLbitfield osg::Camera::getClearMask ( ) const [inline]

Get the clear mask.

void osg::Camera::setColorMask ( osg::ColorMask * colorMask )

Set the color mask of the camera to use specified osg::ColorMask.

void osg::Camera::setColorMask	(	bool	red,
		bool	green,
		bool	blue,
		bool	alpha
	)

Set the color mask of the camera to specified values.

const ColorMask* osg::Camera::getColorMask ( ) const [inline]

Get the const ColorMask.

ColorMask* osg::Camera::getColorMask ( ) [inline]

Get the ColorMask.

void osg::Camera::setViewport ( osg::Viewport * viewport )

Set the viewport of the camera to use specified osg::Viewport.

void osg::Camera::setViewport	(	int	x,
		int	y,
		int	width,
		int	height
	)

Set the viewport of the camera to specified dimensions.

const Viewport* osg::Camera::getViewport ( ) const [inline]

Get the const viewport.

Viewport* osg::Camera::getViewport ( ) [inline]

Get the viewport.

void osg::Camera::setTransformOrder ( TransformOrder order ) [inline]

Set the transformation order for world-to-local and local-to-world transformation.

TransformOrder osg::Camera::getTransformOrder ( ) const [inline]

Get the transformation order.

void osg::Camera::setProjectionResizePolicy ( ProjectionResizePolicy policy ) [inline]

Set the policy used to determin if and how the projection matrix should be adjusted on window resizes.

ProjectionResizePolicy osg::Camera::getProjectionResizePolicy ( ) const [inline]

Get the policy used to determin if and how the projection matrix should be adjusted on window resizes.

void osg::Camera::setProjectionMatrix ( const osg::Matrixf & matrix ) [inline]

Set the projection matrix.

Can be thought of as setting the lens of a camera.

void osg::Camera::setProjectionMatrix ( const osg::Matrixd & matrix ) [inline]

Set the projection matrix.

Can be thought of as setting the lens of a camera.

void osg::Camera::setProjectionMatrixAsOrtho	(	double	left,
		double	right,
		double	bottom,
		double	top,
		double	zNear,
		double	zFar
	)

Set to an orthographic projection.

See OpenGL glOrtho for documentation further details.

void osg::Camera::setProjectionMatrixAsOrtho2D	(	double	left,
		double	right,
		double	bottom,
		double	top
	)

Set to a 2D orthographic projection.

See OpenGL glOrtho2D documentation for further details.

void osg::Camera::setProjectionMatrixAsFrustum	(	double	left,
		double	right,
		double	bottom,
		double	top,
		double	zNear,
		double	zFar
	)

Set to a perspective projection.

See OpenGL glFrustum documentation for further details.

void osg::Camera::setProjectionMatrixAsPerspective	(	double	fovy,
		double	aspectRatio,
		double	zNear,
		double	zFar
	)

Create a symmetrical perspective projection, See OpenGL gluPerspective documentation for further details.

Aspect ratio is defined as width/height.

osg::Matrixd& osg::Camera::getProjectionMatrix ( ) [inline]

Get the projection matrix.

const osg::Matrixd& osg::Camera::getProjectionMatrix ( ) const [inline]

Get the const projection matrix.

bool osg::Camera::getProjectionMatrixAsOrtho	(	double &	left,
		double &	right,
		double &	bottom,
		double &	top,
		double &	zNear,
		double &	zFar
	)

Get the othographic settings of the orthographic projection matrix.

Returns false if matrix is not an orthographic matrix, where parameter values are undefined.

bool osg::Camera::getProjectionMatrixAsFrustum	(	double &	left,
		double &	right,
		double &	bottom,
		double &	top,
		double &	zNear,
		double &	zFar
	)

Get the frustum setting of a perspective projection matrix.

Returns false if matrix is not a perspective matrix, where parameter values are undefined.

bool osg::Camera::getProjectionMatrixAsPerspective	(	double &	fovy,
		double &	aspectRatio,
		double &	zNear,
		double &	zFar
	)

Get the frustum setting of a symmetric perspective projection matrix.

Returns false if matrix is not a perspective matrix, where parameter values are undefined. Note, if matrix is not a symmetric perspective matrix then the shear will be lost. Asymmetric matrices occur when stereo, power walls, caves and reality center display are used. In these configurations one should use the 'getProjectionMatrixAsFrustum' method instead.

void osg::Camera::setViewMatrix ( const osg::Matrixf & matrix ) [inline]

Set the view matrix.

Can be thought of as setting the position of the world relative to the camera in camera coordinates.

void osg::Camera::setViewMatrix ( const osg::Matrixd & matrix ) [inline]

Set the view matrix.

Can be thought of as setting the position of the world relative to the camera in camera coordinates.

void osg::Camera::setViewMatrixAsLookAt	(	const osg::Vec3 &	eye,
		const osg::Vec3 &	center,
		const osg::Vec3 &	up
	)

Set to the position and orientation of view matrix, using the same convention as gluLookAt.

osg::Matrixd& osg::Camera::getViewMatrix ( ) [inline]

Get the view matrix.

const osg::Matrixd& osg::Camera::getViewMatrix ( ) const [inline]

Get the const view matrix.

void osg::Camera::getViewMatrixAsLookAt	(	osg::Vec3 &	eye,
		osg::Vec3 &	center,
		osg::Vec3 &	up,
		float	lookDistance = `1.0f`
	)

Get to the position and orientation of a modelview matrix, using the same convention as gluLookAt.

Matrixd osg::Camera::getInverseViewMatrix ( ) const

Get the inverse view matrix.

void osg::Camera::setRenderOrder	(	RenderOrder	order,
		int	orderNum = `0`
	)			`[inline]`

Set the rendering order of this camera's subgraph relative to any camera that this subgraph is nested within.

For rendering to a texture, one typically uses PRE_RENDER. For Head Up Displays, one would typically use POST_RENDER.

RenderOrder osg::Camera::getRenderOrder ( ) const [inline]

Get the rendering order of this camera's subgraph relative to any camera that this subgraph is nested within.

int osg::Camera::getRenderOrderNum ( ) const [inline]

Get the rendering order number of this camera relative to any sibling cameras in this subgraph.

bool osg::Camera::isRenderToTextureCamera ( ) const

Return true if this Camera is set up as a render to texture camera, i.e.

it has textures assigned to it.

void osg::Camera::setRenderTargetImplementation ( RenderTargetImplementation impl )

Set the render target.

void osg::Camera::setRenderTargetImplementation	(	RenderTargetImplementation	impl,
		RenderTargetImplementation	fallback
	)

Set the render target and fall-back that's used if the former isn't available.

RenderTargetImplementation osg::Camera::getRenderTargetImplementation ( ) const [inline]

Get the render target.

RenderTargetImplementation osg::Camera::getRenderTargetFallback ( ) const [inline]

Get the render target fallback.

void osg::Camera::setDrawBuffer ( GLenum buffer ) [inline]

Set the draw buffer used at the start of each frame draw.

Note, a buffer value of GL_NONE is used to sepecify that the rendering back-end should choose the most appropriate buffer.

GLenum osg::Camera::getDrawBuffer ( ) const [inline]

Get the draw buffer used at the start of each frame draw.

void osg::Camera::setReadBuffer ( GLenum buffer ) [inline]

Set the read buffer for any required copy operations to use.

Note, a buffer value of GL_NONE is used to sepecify that the rendering back-end should choose the most appropriate buffer.

GLenum osg::Camera::getReadBuffer ( ) const [inline]

Get the read buffer for any required copy operations to use.

void osg::Camera::attach	(	BufferComponent	buffer,
		GLenum	internalFormat
	)

void osg::Camera::attach	(	BufferComponent	buffer,
		osg::Texture *	texture,
		unsigned int	level = `0`,
		unsigned int	face = `0`,
		bool	mipMapGeneration = `false`
	)

void osg::Camera::attach	(	BufferComponent	buffer,
		osg::Image *	image
	)

void osg::Camera::detach ( BufferComponent buffer )

BufferAttachmentMap& osg::Camera::getBufferAttachmentMap ( ) [inline]

Get the BufferAttachmentMap, used to configure frame buffer objects, pbuffers and texture reads.

const BufferAttachmentMap& osg::Camera::getBufferAttachmentMap ( ) const [inline]

Get the const BufferAttachmentMap, used to configure frame buffer objects, pbuffers and texture reads.

void osg::Camera::createCameraThread ( )

Create a operation thread for this camera.

void osg::Camera::setCameraThread ( OperationThread * gt )

Assign a operation thread to the camera.

OperationThread* osg::Camera::getCameraThread ( ) [inline]

Get the operation thread assigned to this camera.

const OperationThread* osg::Camera::getCameraThread ( ) const [inline]

Get the const operation thread assigned to this camera.

void osg::Camera::setGraphicsContext ( GraphicsContext * context )

Set the GraphicsContext that provides the mechansim for managing the OpenGL graphics context associated with this camera.

GraphicsContext* osg::Camera::getGraphicsContext ( ) [inline]

Get the GraphicsContext.

const GraphicsContext* osg::Camera::getGraphicsContext ( ) const [inline]

Get the const GraphicsContext.

void osg::Camera::setRenderer ( osg::GraphicsOperation * rc ) [inline]

Set the Rendering object that is used to implement rendering of the subgraph.

osg::GraphicsOperation* osg::Camera::getRenderer ( ) [inline]

Get the Rendering object that is used to implement rendering of the subgraph.

const osg::GraphicsOperation* osg::Camera::getRenderer ( ) const [inline]

Get the const Rendering object that is used to implement rendering of the subgraph.

void osg::Camera::setRenderingCache ( osg::Object * rc ) [inline]

Set the Rendering cache that is used for cached objects associated with rendering of subgraphs.

osg::Object* osg::Camera::getRenderingCache ( ) [inline]

Get the Rendering cache that is used for cached objects associated with rendering of subgraphs.

const osg::Object* osg::Camera::getRenderingCache ( ) const [inline]

Get the const Rendering cache that is used for cached objects associated with rendering of subgraphs.

void osg::Camera::setPreDrawCallback ( DrawCallback * cb ) [inline]

Set the pre draw callback for custom operations to be done before the drawing of the camera's subgraph has been completed.

DrawCallback* osg::Camera::getPreDrawCallback ( ) [inline]

Get the pre draw callback.

const DrawCallback* osg::Camera::getPreDrawCallback ( ) const [inline]

Get the const pre draw callback.

void osg::Camera::setPostDrawCallback ( DrawCallback * cb ) [inline]

Set the post draw callback for custom operations to be done after the drawing of the camera's subgraph has been completed.

DrawCallback* osg::Camera::getPostDrawCallback ( ) [inline]

Get the post draw callback.

const DrawCallback* osg::Camera::getPostDrawCallback ( ) const [inline]

Get the const post draw callback.

OpenThreads::Mutex* osg::Camera::getDataChangeMutex ( ) const [inline]

virtual void osg::Camera::resizeGLObjectBuffers ( unsigned int maxSize ) [virtual]

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Group.

virtual void osg::Camera::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 objexts for all graphics contexts.

Reimplemented from osg::Group.

virtual bool osg::Camera::computeLocalToWorldMatrix	(	Matrix &	matrix,
		NodeVisitor *
	)			const `[virtual]`

Transform method that must be defined to provide generic interface for scene graph traversals.

Reimplemented from osg::Transform.

virtual bool osg::Camera::computeWorldToLocalMatrix	(	Matrix &	matrix,
		NodeVisitor *
	)			const `[virtual]`

Transform method that must be defined to provide generic interface for scene graph traversals.

Reimplemented from osg::Transform.

Member Data Documentation

OpenThreads::Mutex osg::Camera::_dataChangeMutex [mutable, protected]

View* osg::Camera::_view [protected]

osg::ref_ptr<osg::Stats> osg::Camera::_stats [protected]

bool osg::Camera::_allowEventFocus [protected]

osg::ref_ptr<osg::DisplaySettings> osg::Camera::_displaySettings [protected]

Vec4 osg::Camera::_clearColor [protected]

GLbitfield osg::Camera::_clearMask [protected]

ref_ptr<ColorMask> osg::Camera::_colorMask [protected]

ref_ptr<Viewport> osg::Camera::_viewport [protected]

TransformOrder osg::Camera::_transformOrder [protected]

ProjectionResizePolicy osg::Camera::_projectionResizePolicy [protected]

Matrixd osg::Camera::_projectionMatrix [protected]

Matrixd osg::Camera::_viewMatrix [protected]

RenderOrder osg::Camera::_renderOrder [protected]

int osg::Camera::_renderOrderNum [protected]

GLenum osg::Camera::_drawBuffer [protected]

GLenum osg::Camera::_readBuffer [protected]

RenderTargetImplementation osg::Camera::_renderTargetImplementation [protected]

RenderTargetImplementation osg::Camera::_renderTargetFallback [protected]

BufferAttachmentMap osg::Camera::_bufferAttachmentMap [protected]

ref_ptr<OperationThread> osg::Camera::_cameraThread [protected]

ref_ptr<GraphicsContext> osg::Camera::_graphicsContext [protected]

ref_ptr<GraphicsOperation> osg::Camera::_renderer [protected]

ref_ptr<Object> osg::Camera::_renderingCache [protected]

ref_ptr<DrawCallback> osg::Camera::_preDrawCallback [protected]

ref_ptr<DrawCallback> osg::Camera::_postDrawCallback [protected]

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

Camera

Generated at Sun Oct 14 02:12:06 2007 for the OpenSceneGraph by doxygen 1.5.3.


Public Types
enum	TransformOrder { PRE_MULTIPLY, POST_MULTIPLY }
enum	ProjectionResizePolicy { FIXED, HORIZONTAL, VERTICAL }
enum	RenderOrder { PRE_RENDER, NESTED_RENDER, POST_RENDER }
enum	RenderTargetImplementation { FRAME_BUFFER_OBJECT, PIXEL_BUFFER_RTT, PIXEL_BUFFER, FRAME_BUFFER, SEPERATE_WINDOW }
enum	BufferComponent { DEPTH_BUFFER, STENCIL_BUFFER, COLOR_BUFFER, COLOR_BUFFER0 = COLOR_BUFFER, COLOR_BUFFER1 = COLOR_BUFFER+1, COLOR_BUFFER2 = COLOR_BUFFER+2, COLOR_BUFFER3 = COLOR_BUFFER+3, COLOR_BUFFER4 = COLOR_BUFFER+4, COLOR_BUFFER5 = COLOR_BUFFER+5, COLOR_BUFFER6 = COLOR_BUFFER+6, COLOR_BUFFER7 = COLOR_BUFFER+7 }
typedef std::map < BufferComponent, Attachment >	BufferAttachmentMap
Public Member Functions
	Camera ()
	Camera (const Camera &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
	META_Node (osg, Camera)
void	setView (View *view)
	Set the View that this Camera is part of.
View *	getView ()
	Get the View that this Camera is part of.
const View *	getView () const
	Get the const View that this Camera is part of.
void	setStats (osg::Stats *stats)
	Set the Stats object used for collect various frame related timing and scene graph stats.
osg::Stats *	getStats ()
	Get the Stats object.
const osg::Stats *	getStats () const
	Get the const Stats object.
void	setAllowEventFocus (bool focus)
	Set whether this camera allows events to be generated by the associated graphics window to be associated with this camera.
bool	getAllowEventFocus () const
	Get whether this camera allows events to be generated by the associated graphics window to be associated with this camera.
void	setDisplaySettings (osg::DisplaySettings *ds)
	Set the DsplaySettings object associated with this view.
osg::DisplaySettings *	getDisplaySettings ()
	Set the DsplaySettings object associated with this view.
const osg::DisplaySettings *	getDisplaySettings () const
	Set the DsplaySettings object associated with this view.
void	setClearColor (const Vec4 &color)
	Sets the clear color.
const Vec4 &	getClearColor () const
	Returns the clear color.
void	setClearMask (GLbitfield mask)
	Set the clear mask used in glClear(.
GLbitfield	getClearMask () const
	Get the clear mask.
void	setColorMask (osg::ColorMask *colorMask)
	Set the color mask of the camera to use specified osg::ColorMask.
void	setColorMask (bool red, bool green, bool blue, bool alpha)
	Set the color mask of the camera to specified values.
const ColorMask *	getColorMask () const
	Get the const ColorMask.
ColorMask *	getColorMask ()
	Get the ColorMask.
void	setViewport (osg::Viewport *viewport)
	Set the viewport of the camera to use specified osg::Viewport.
void	setViewport (int x, int y, int width, int height)
	Set the viewport of the camera to specified dimensions.
const Viewport *	getViewport () const
	Get the const viewport.
Viewport *	getViewport ()
	Get the viewport.
void	setTransformOrder (TransformOrder order)
	Set the transformation order for world-to-local and local-to-world transformation.
TransformOrder	getTransformOrder () const
	Get the transformation order.
void	setProjectionResizePolicy (ProjectionResizePolicy policy)
	Set the policy used to determin if and how the projection matrix should be adjusted on window resizes.
ProjectionResizePolicy	getProjectionResizePolicy () const
	Get the policy used to determin if and how the projection matrix should be adjusted on window resizes.
void	setProjectionMatrix (const osg::Matrixf &matrix)
	Set the projection matrix.
void	setProjectionMatrix (const osg::Matrixd &matrix)
	Set the projection matrix.
void	setProjectionMatrixAsOrtho (double left, double right, double bottom, double top, double zNear, double zFar)
	Set to an orthographic projection.
void	setProjectionMatrixAsOrtho2D (double left, double right, double bottom, double top)
	Set to a 2D orthographic projection.
void	setProjectionMatrixAsFrustum (double left, double right, double bottom, double top, double zNear, double zFar)
	Set to a perspective projection.
void	setProjectionMatrixAsPerspective (double fovy, double aspectRatio, double zNear, double zFar)
	Create a symmetrical perspective projection, See OpenGL gluPerspective documentation for further details.
osg::Matrixd &	getProjectionMatrix ()
	Get the projection matrix.
const osg::Matrixd &	getProjectionMatrix () const
	Get the const projection matrix.
bool	getProjectionMatrixAsOrtho (double &left, double &right, double &bottom, double &top, double &zNear, double &zFar)
	Get the othographic settings of the orthographic projection matrix.
bool	getProjectionMatrixAsFrustum (double &left, double &right, double &bottom, double &top, double &zNear, double &zFar)
	Get the frustum setting of a perspective projection matrix.
bool	getProjectionMatrixAsPerspective (double &fovy, double &aspectRatio, double &zNear, double &zFar)
	Get the frustum setting of a symmetric perspective projection matrix.
void	setViewMatrix (const osg::Matrixf &matrix)
	Set the view matrix.
void	setViewMatrix (const osg::Matrixd &matrix)
	Set the view matrix.
void	setViewMatrixAsLookAt (const osg::Vec3 &eye, const osg::Vec3 &center, const osg::Vec3 &up)
	Set to the position and orientation of view matrix, using the same convention as gluLookAt.
osg::Matrixd &	getViewMatrix ()
	Get the view matrix.
const osg::Matrixd &	getViewMatrix () const
	Get the const view matrix.
void	getViewMatrixAsLookAt (osg::Vec3 &eye, osg::Vec3 &center, osg::Vec3 &up, float lookDistance=1.0f)
	Get to the position and orientation of a modelview matrix, using the same convention as gluLookAt.
Matrixd	getInverseViewMatrix () const
	Get the inverse view matrix.
void	setRenderOrder (RenderOrder order, int orderNum=0)
	Set the rendering order of this camera's subgraph relative to any camera that this subgraph is nested within.
RenderOrder	getRenderOrder () const
	Get the rendering order of this camera's subgraph relative to any camera that this subgraph is nested within.
int	getRenderOrderNum () const
	Get the rendering order number of this camera relative to any sibling cameras in this subgraph.
bool	isRenderToTextureCamera () const
	Return true if this Camera is set up as a render to texture camera, i.e.
void	setRenderTargetImplementation (RenderTargetImplementation impl)
	Set the render target.
void	setRenderTargetImplementation (RenderTargetImplementation impl, RenderTargetImplementation fallback)
	Set the render target and fall-back that's used if the former isn't available.
RenderTargetImplementation	getRenderTargetImplementation () const
	Get the render target.
RenderTargetImplementation	getRenderTargetFallback () const
	Get the render target fallback.
void	setDrawBuffer (GLenum buffer)
	Set the draw buffer used at the start of each frame draw.
GLenum	getDrawBuffer () const
	Get the draw buffer used at the start of each frame draw.
void	setReadBuffer (GLenum buffer)
	Set the read buffer for any required copy operations to use.
GLenum	getReadBuffer () const
	Get the read buffer for any required copy operations to use.
void	attach (BufferComponent buffer, GLenum internalFormat)
void	attach (BufferComponent buffer, osg::Texture *texture, unsigned int level=0, unsigned int face=0, bool mipMapGeneration=false)
void	attach (BufferComponent buffer, osg::Image *image)
void	detach (BufferComponent buffer)
BufferAttachmentMap &	getBufferAttachmentMap ()
	Get the BufferAttachmentMap, used to configure frame buffer objects, pbuffers and texture reads.
const BufferAttachmentMap &	getBufferAttachmentMap () const
	Get the const BufferAttachmentMap, used to configure frame buffer objects, pbuffers and texture reads.
void	createCameraThread ()
	Create a operation thread for this camera.
void	setCameraThread (OperationThread *gt)
	Assign a operation thread to the camera.
OperationThread *	getCameraThread ()
	Get the operation thread assigned to this camera.
const OperationThread *	getCameraThread () const
	Get the const operation thread assigned to this camera.
void	setGraphicsContext (GraphicsContext *context)
	Set the GraphicsContext that provides the mechansim for managing the OpenGL graphics context associated with this camera.
GraphicsContext *	getGraphicsContext ()
	Get the GraphicsContext.
const GraphicsContext *	getGraphicsContext () const
	Get the const GraphicsContext.
void	setRenderer (osg::GraphicsOperation *rc)
	Set the Rendering object that is used to implement rendering of the subgraph.
osg::GraphicsOperation *	getRenderer ()
	Get the Rendering object that is used to implement rendering of the subgraph.
const osg::GraphicsOperation *	getRenderer () const
	Get the const Rendering object that is used to implement rendering of the subgraph.
void	setRenderingCache (osg::Object *rc)
	Set the Rendering cache that is used for cached objects associated with rendering of subgraphs.
osg::Object *	getRenderingCache ()
	Get the Rendering cache that is used for cached objects associated with rendering of subgraphs.
const osg::Object *	getRenderingCache () const
	Get the const Rendering cache that is used for cached objects associated with rendering of subgraphs.
void	setPreDrawCallback (DrawCallback *cb)
	Set the pre draw callback for custom operations to be done before the drawing of the camera's subgraph has been completed.
DrawCallback *	getPreDrawCallback ()
	Get the pre draw callback.
const DrawCallback *	getPreDrawCallback () const
	Get the const pre draw callback.
void	setPostDrawCallback (DrawCallback *cb)
	Set the post draw callback for custom operations to be done after the drawing of the camera's subgraph has been completed.
DrawCallback *	getPostDrawCallback ()
	Get the post draw callback.
const DrawCallback *	getPostDrawCallback () const
	Get the const post draw callback.
OpenThreads::Mutex *	getDataChangeMutex () const
virtual void	resizeGLObjectBuffers (unsigned int maxSize)
	Resize any per context GLObject buffers to specified size.
virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
virtual bool	computeLocalToWorldMatrix (Matrix &matrix, NodeVisitor *) const
	Transform method that must be defined to provide generic interface for scene graph traversals.
virtual bool	computeWorldToLocalMatrix (Matrix &matrix, NodeVisitor *) const
	Transform method that must be defined to provide generic interface for scene graph traversals.
Protected Member Functions
virtual	~Camera ()
Protected Attributes
OpenThreads::Mutex	_dataChangeMutex
View *	_view
osg::ref_ptr < osg::Stats >	_stats
bool	_allowEventFocus
osg::ref_ptr < osg::DisplaySettings >	_displaySettings
Vec4	_clearColor
GLbitfield	_clearMask
ref_ptr< ColorMask >	_colorMask
ref_ptr< Viewport >	_viewport
TransformOrder	_transformOrder
ProjectionResizePolicy	_projectionResizePolicy
Matrixd	_projectionMatrix
Matrixd	_viewMatrix
RenderOrder	_renderOrder
int	_renderOrderNum
GLenum	_drawBuffer
GLenum	_readBuffer
RenderTargetImplementation	_renderTargetImplementation
RenderTargetImplementation	_renderTargetFallback
BufferAttachmentMap	_bufferAttachmentMap
ref_ptr < OperationThread >	_cameraThread
ref_ptr < GraphicsContext >	_graphicsContext
ref_ptr < GraphicsOperation >	_renderer
ref_ptr< Object >	_renderingCache
ref_ptr< DrawCallback >	_preDrawCallback
ref_ptr< DrawCallback >	_postDrawCallback
Classes
struct	Attachment
struct	DrawCallback
	Draw callback for custom operations. More...