Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

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
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
}

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 setClearColor (const Vec4 &color)
 Sets the clear color.
const Vec4getClearColor () 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 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 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::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 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::MatrixdgetViewMatrix ()
 Get the view matrix.
const osg::MatrixdgetViewMatrix () 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)
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 (OperationsThread *gt)
 Assign a operation thread to the camera.
OperationsThreadgetCameraThread ()
 Get the operation thread assigned to this camera.
const OperationsThreadgetCameraThread () 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 setRenderingCache (unsigned int contextID, osg::Object *rc)
 Set the Rendering object that is used to implement rendering of the subgraph.
osg::ObjectgetRenderingCache (unsigned int contextID)
 Get the Rendering object that is used to implement rendering of the subgraph.
const osg::ObjectgetRenderingCache (unsigned int contextID) const
 Get the const Rendering object that is used to implement rendering of the subgraph.
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.
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 has been completed.
DrawCallbackgetPostDrawCallback ()
 Get the post draw callback.
const DrawCallbackgetPostDrawCallback () 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< OperationsThread_cameraThread
ref_ptr< GraphicsContext_graphicsContext
buffered_object< 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::BufferComponent
 

Enumerator:
DEPTH_BUFFER 
STENCIL_BUFFER 
COLOR_BUFFER 
COLOR_BUFFER0 
COLOR_BUFFER1 
COLOR_BUFFER2 
COLOR_BUFFER3 
COLOR_BUFFER4 
COLOR_BUFFER5 
COLOR_BUFFER6 
COLOR_BUFFER7 

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
 

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,
GLenum  internalFormat
 

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  ) 
 

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 OperationsThread* osg::Camera::getCameraThread  )  const [inline]
 

Get the const operation thread assigned to this camera.

OperationsThread* osg::Camera::getCameraThread  )  [inline]
 

Get the operation thread assigned to this camera.

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

Returns the clear color.

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

Get the clear mask.

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 GraphicsContext* osg::Camera::getGraphicsContext  )  const [inline]
 

Get the const GraphicsContext.

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

Get the GraphicsContext.

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 othographic 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 determin 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::Object* osg::Camera::getRenderingCache unsigned int  contextID  )  const [inline]
 

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

osg::Object* osg::Camera::getRenderingCache unsigned int  contextID  )  [inline]
 

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

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.

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

Get the render target fallback.

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

Get the render target.

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

Get the const Stats object.

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

Get the Stats object.

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

Get the transformation order.

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

Get the const View that this Camera is part of.

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

Get the View that this Camera is part of.

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

Get the const view matrix.

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

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

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

Get the viewport.

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

Get the const viewport.

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.

osg::Camera::META_Node osg  ,
Camera 
 

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 void osg::Camera::resizeGLObjectBuffers unsigned int  maxSize  )  [virtual]
 

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Group.

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.

void osg::Camera::setCameraThread OperationsThread gt  ) 
 

Assign a operation thread to the camera.

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

Sets 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.

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

Set the color mask of the camera to specified values.

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

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

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

Set the DsplaySettings object associated with this view.

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.

void osg::Camera::setGraphicsContext GraphicsContext context  ) 
 

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

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.

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.

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::setProjectionMatrix const osg::Matrixf matrix  )  [inline]
 

Set the projection matrix.

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

void osg::Camera::setProjectionMatrixAsFrustum double  left,
double