osg::Camera Class Reference

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

Inheritance diagram for osg::Camera:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::map< BufferComponent,
Attachment
BufferAttachmentMap
 PRE_MULTIPLY
 POST_MULTIPLY
 FIXED
 HORIZONTAL
 Keep the projection matrix fixed, despite window resizes.
 VERTICAL
 Adjust the VERTICAL field of view on window resizes.
 PRE_RENDER
 NESTED_RENDER
 POST_RENDER
 FRAME_BUFFER_OBJECT
 PIXEL_BUFFER_RTT
 PIXEL_BUFFER
 FRAME_BUFFER
 SEPERATE_WINDOW
 DEPTH_BUFFER
 STENCIL_BUFFER
 COLOR_BUFFER
 COLOR_BUFFER0
 COLOR_BUFFER1 = COLOR_BUFFER0+1
 COLOR_BUFFER2 = COLOR_BUFFER0+2
 COLOR_BUFFER3 = COLOR_BUFFER0+3
 COLOR_BUFFER4 = COLOR_BUFFER0+4
 COLOR_BUFFER5 = COLOR_BUFFER0+5
 COLOR_BUFFER6 = COLOR_BUFFER0+6
 COLOR_BUFFER7 = COLOR_BUFFER0+7
 COLOR_BUFFER8 = COLOR_BUFFER0+8
 COLOR_BUFFER9 = COLOR_BUFFER0+9
 COLOR_BUFFER10 = COLOR_BUFFER0+10
 COLOR_BUFFER11 = COLOR_BUFFER0+11
 COLOR_BUFFER12 = COLOR_BUFFER0+12
 COLOR_BUFFER13 = COLOR_BUFFER0+13
 COLOR_BUFFER14 = COLOR_BUFFER0+14
 COLOR_BUFFER15 = COLOR_BUFFER0+15
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_BUFFER1 = COLOR_BUFFER0+1, COLOR_BUFFER2 = COLOR_BUFFER0+2, COLOR_BUFFER3 = COLOR_BUFFER0+3, COLOR_BUFFER4 = COLOR_BUFFER0+4,
  COLOR_BUFFER5 = COLOR_BUFFER0+5, COLOR_BUFFER6 = COLOR_BUFFER0+6, COLOR_BUFFER7 = COLOR_BUFFER0+7, COLOR_BUFFER8 = COLOR_BUFFER0+8,
  COLOR_BUFFER9 = COLOR_BUFFER0+9, COLOR_BUFFER10 = COLOR_BUFFER0+10, COLOR_BUFFER11 = COLOR_BUFFER0+11, COLOR_BUFFER12 = COLOR_BUFFER0+12,
  COLOR_BUFFER13 = COLOR_BUFFER0+13, COLOR_BUFFER14 = COLOR_BUFFER0+14, COLOR_BUFFER15 = COLOR_BUFFER0+15
}

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.
ViewgetView ()
 Get the View that this Camera is part of.
const ViewgetView () 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::StatsgetStats ()
 Get the Stats object.
const osg::StatsgetStats () 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::DisplaySettingsgetDisplaySettings ()
 Set the DsplaySettings object associated with this view.
const osg::DisplaySettingsgetDisplaySettings () const
 Set the DsplaySettings object associated with this view.
void setClearMask (GLbitfield mask)
 Set the clear mask used in glClear(.
GLbitfield getClearMask () const
 Get the clear mask.
void setClearColor (const osg::Vec4 &color)
 Set the clear color used in glClearColor(.
const osg::Vec4getClearColor () const
 Get the clear color.
void setClearAccum (const osg::Vec4 &color)
 Set the clear accum used in glClearAccum(.
const osg::Vec4getClearAccum () const
 Get the clear accum value.
void setClearDepth (double depth)
 Set the clear depth used in glClearDepth(.
double getClearDepth () const
 Get the clear depth value.
void setClearStencil (int stencil)
 Set the clear stencil value used in glClearStencil().
int getClearStencil () const
 Get the clear stencil value.
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 ColorMaskgetColorMask () const
 Get the const ColorMask.
ColorMaskgetColorMask ()
 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 ViewportgetViewport () const
 Get the const viewport.
ViewportgetViewport ()
 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 determine if and how the projection matrix should be adjusted on window resizes.
ProjectionResizePolicy getProjectionResizePolicy () const
 Get the policy used to determine 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::MatrixdgetProjectionMatrix ()
 Get the projection matrix.
const osg::MatrixdgetProjectionMatrix () const
 Get the const projection matrix.
bool getProjectionMatrixAsOrtho (double &left, double &right, double &bottom, double &top, double &zNear, double &zFar)
 Get the orthographic 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.
osg::MatrixdgetViewMatrix ()
 Get the view matrix.
const osg::MatrixdgetViewMatrix () const
 Get the const view matrix.
void setViewMatrixAsLookAt (const osg::Vec3d &eye, const osg::Vec3d &center, const osg::Vec3d &up)
 Set to the position and orientation of view matrix, using the same convention as gluLookAt.
void getViewMatrixAsLookAt (osg::Vec3d &eye, osg::Vec3d &center, osg::Vec3d &up, double lookDistance=1.0)
 Get to the position and orientation of a modelview matrix, using the same convention as gluLookAt.
void getViewMatrixAsLookAt (osg::Vec3f &eye, osg::Vec3f &center, osg::Vec3f &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)
 Attach a buffer with specified OpenGL internal format.
void attach (BufferComponent buffer, osg::Texture *texture, unsigned int level=0, unsigned int face=0, bool mipMapGeneration=false, unsigned int multisampleSamples=0, unsigned int multisampleColorSamples=0)
 Attach a Texture to specified buffer component.
void attach (BufferComponent buffer, osg::Image *image, unsigned int multisampleSamples=0, unsigned int multisampleColorSamples=0)
 Attach a Image to specified buffer component.
void detach (BufferComponent buffer)
 Detach specified buffer component.
BufferAttachmentMapgetBufferAttachmentMap ()
 Get the BufferAttachmentMap, used to configure frame buffer objects, pbuffers and texture reads.
const BufferAttachmentMapgetBufferAttachmentMap () 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.
OperationThreadgetCameraThread ()
 Get the operation thread assigned to this camera.
const OperationThreadgetCameraThread () 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.
GraphicsContextgetGraphicsContext ()
 Get the GraphicsContext.
const GraphicsContextgetGraphicsContext () const
 Get the const GraphicsContext.
void setRenderer (osg::GraphicsOperation *rc)
 Set the Rendering object that is used to implement rendering of the subgraph.
osg::GraphicsOperationgetRenderer ()
 Get the Rendering object that is used to implement rendering of the subgraph.
const osg::GraphicsOperationgetRenderer () 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::ObjectgetRenderingCache ()
 Get the Rendering cache that is used for cached objects associated with rendering of subgraphs.
const osg::ObjectgetRenderingCache () const
 Get the const Rendering cache that is used for cached objects associated with rendering of subgraphs.
void setInitialDrawCallback (DrawCallback *cb)
 Set the initial draw callback for custom operations to be done before the drawing of the camera's subgraph and pre render stages.
DrawCallbackgetInitialDrawCallback ()
 Get the initial draw callback.
const DrawCallbackgetInitialDrawCallback () const
 Get the const initial draw callback.
void setPreDrawCallback (DrawCallback *cb)
 Set the pre draw callback for custom operations to be done before the drawing of the camera's subgraph but after any pre render stages have been completed.
DrawCallbackgetPreDrawCallback ()
 Get the pre draw callback.
const DrawCallbackgetPreDrawCallback () 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 but before the any post render stages have been completed.
DrawCallbackgetPostDrawCallback ()
 Get the post draw callback.
const DrawCallbackgetPostDrawCallback () const
 Get the const post draw callback.
void setFinalDrawCallback (DrawCallback *cb)
 Set the final draw callback for custom operations to be done after the drawing of the camera's subgraph and all of the post render stages has been completed.
DrawCallbackgetFinalDrawCallback ()
 Get the final draw callback.
const DrawCallbackgetFinalDrawCallback () const
 Get the const final 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.
virtual void inheritCullSettings (const CullSettings &settings, unsigned int inheritanceMask)
 Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.

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
GLbitfield _clearMask
osg::Vec4 _clearColor
osg::Vec4 _clearAccum
double _clearDepth
int _clearStencil
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_initialDrawCallback
ref_ptr< DrawCallback_preDrawCallback
ref_ptr< DrawCallback_postDrawCallback
ref_ptr< DrawCallback_finalDrawCallback

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

Enumerator:
DEPTH_BUFFER 
STENCIL_BUFFER 
COLOR_BUFFER 
COLOR_BUFFER0 
COLOR_BUFFER1 
COLOR_BUFFER2 
COLOR_BUFFER3 
COLOR_BUFFER4 
COLOR_BUFFER5 
COLOR_BUFFER6 
COLOR_BUFFER7 
COLOR_BUFFER8 
COLOR_BUFFER9 
COLOR_BUFFER10 
COLOR_BUFFER11 
COLOR_BUFFER12 
COLOR_BUFFER13 
COLOR_BUFFER14 
COLOR_BUFFER15 

enum osg::Camera::ProjectionResizePolicy

Enumerator:
FIXED 
HORIZONTAL  Keep the projection matrix fixed, despite window resizes.
VERTICAL  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::TransformOrder

Enumerator:
PRE_MULTIPLY 
POST_MULTIPLY 


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

void osg::Camera::attach ( BufferComponent  buffer,
osg::Image image,
unsigned int  multisampleSamples = 0,
unsigned int  multisampleColorSamples = 0 
)

Attach a Image to specified buffer component.

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

Attach a Texture to specified buffer component.

The level parameter controls the mip map level of the texture that is attached. The face parameter controls the face of texture cube map or z level of 3d texture. The mipMapGeneration flag controls whether mipmap generation should be done for texture.

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

Attach a buffer with specified OpenGL internal format.

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.

void osg::Camera::createCameraThread (  ) 

Create a operation thread for this camera.

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

Detach specified buffer component.

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.

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

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

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

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

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

Get the const operation thread assigned to this camera.

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

Get the operation thread assigned to this camera.

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

Get the clear accum value.

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

Get the clear color.

double osg::Camera::getClearDepth (  )  const [inline]

Get the clear depth value.

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

Get the clear mask.

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

Get the clear stencil value.

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

Get the ColorMask.

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

Get the const ColorMask.

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

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

Set the DsplaySettings object associated with this view.

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

Set the DsplaySettings object associated with this view.

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

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

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

Get the const final draw callback.

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

Get the final draw callback.

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

Get the const GraphicsContext.

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

Get the GraphicsContext.

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

Get the const initial draw callback.

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

Get the initial draw callback.

Matrixd osg::Camera::getInverseViewMatrix (  )  const

Get the inverse view matrix.

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

Get the const post draw callback.

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

Get the post draw callback.

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

Get the const pre draw callback.

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

Get the pre draw callback.

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

Get the const projection matrix.

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

Get the projection matrix.

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::getProjectionMatrixAsOrtho ( double &  left,
double &  right,
double &  bottom,
double &  top,
double &  zNear,
double &  zFar 
)

Get the orthographic settings of the orthographic projection matrix.

Returns false if matrix is not an orthographic 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.

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

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

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

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

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

Get the const 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::Object* osg::Camera::getRenderingCache (  )  const [inline]

Get the const 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.

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

Get the rendering order of this camera's subgraph relative