OpenSceneGraph  3.0.1
Classes | Public Member Functions | Protected Member Functions | Protected Attributes
osgViewer::ScreenCaptureHandler Class Reference

Event handler that will capture the screen on key press. More...

Inheritance diagram for osgViewer::ScreenCaptureHandler:
Inheritance graph
[legend]

List of all members.

Classes

class  CaptureOperation
 Abstract base class for what to do when a screen capture happens. More...
class  WriteToFile
 Concrete implementation of a CaptureOperation that writes the screen capture to a file. More...

Public Member Functions

 ScreenCaptureHandler (CaptureOperation *defaultOperation=0, int numFrames=1)
void setKeyEventTakeScreenShot (int key)
int getKeyEventTakeScreenShot () const
void setKeyEventToggleContinuousCapture (int key)
int getKeyEventToggleContinuousCapture () const
void setCaptureOperation (CaptureOperation *operation)
CaptureOperationgetCaptureOperation () const
virtual bool handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)
 Deprecated, Handle events, return true if handled, false otherwise.
virtual void captureNextFrame (osgViewer::ViewerBase &viewer)
 Capture the given viewer's views on the next frame.
void setFramesToCapture (int numFrames)
 Set the number of frames to capture.
int getFramesToCapture () const
 Get the number of frames to capture.
void startCapture ()
 Start capturing any viewer(s) the handler is attached to at the end of the next frame.
void stopCapture ()
 Stop capturing.
virtual void getUsage (osg::ApplicationUsage &usage) const
 Get the keyboard and mouse usage of this manipulator.
- Public Member Functions inherited from osgGA::GUIEventHandler
 GUIEventHandler ()
 GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop)
 META_Object (osgGA, GUIEventHandler)
virtual void operator() (osg::Node *node, osg::NodeVisitor *nv)
 Event traversal node callback method.
virtual void event (osg::NodeVisitor *nv, osg::Drawable *drawable)
 Event traversal drawable callback method.
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
 Handle events, return true if handled, false otherwise.
bool handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *object, osg::NodeVisitor *nv)
 Convenience method that only passes on to the handle(,,,) method events that either haven't been handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask.
bool handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa)
 Convenience method that only passes on to the handle(,) method events that either haven't been handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask.
void setIgnoreHandledEventsMask (unsigned int mask)
 Set a mask of osgGA::GUIEeventAdapter::Event to be ignored if marked as handled.
unsigned int getIgnoreHandledEventsMask () const
 Get the event mask of the osgGA::GUIEeventAdapter::Event to be ignored if marked as handled.
- Public Member Functions inherited from osg::NodeCallback
 NodeCallback ()
 NodeCallback (const NodeCallback &nc, const CopyOp &)
 META_Object (osg, NodeCallback)
void traverse (Node *node, NodeVisitor *nv)
 Call any nested callbacks and then traverse the scene graph.
void setNestedCallback (NodeCallback *nc)
NodeCallbackgetNestedCallback ()
const NodeCallbackgetNestedCallback () const
void addNestedCallback (NodeCallback *nc)
void removeNestedCallback (NodeCallback *nc)
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 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.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
 return the name of the object's library.
virtual const char * className () const =0
 return the name of the object's class type.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
virtual void resizeGLObjectBuffers (unsigned int)
 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.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.
- Public Member Functions inherited from osg::Drawable::EventCallback
 EventCallback ()
 EventCallback (const EventCallback &, const CopyOp &)
 META_Object (osg, EventCallback)

Protected Member Functions

void addCallbackToViewer (osgViewer::ViewerBase &viewer)
void removeCallbackFromViewer (osgViewer::ViewerBase &viewer)
osg::CamerafindAppropriateCameraForCallback (osgViewer::ViewerBase &viewer)

Protected Attributes

bool _startCapture
bool _stopCapture
int _keyEventTakeScreenShot
int _keyEventToggleContinuousCapture
osg::ref_ptr< CaptureOperation_operation
osg::ref_ptr
< osg::Camera::DrawCallback
_callback
- Protected Attributes inherited from osgGA::GUIEventHandler
unsigned int _ignoreHandledEventsMask

Detailed Description

Event handler that will capture the screen on key press.


Constructor & Destructor Documentation

osgViewer::ScreenCaptureHandler::ScreenCaptureHandler ( CaptureOperation defaultOperation = 0,
int  numFrames = 1 
)
Parameters:
numFrames>0: capture that number of frames. <0: capture all frames, call stopCapture() to stop it.

Member Function Documentation

void osgViewer::ScreenCaptureHandler::addCallbackToViewer ( osgViewer::ViewerBase viewer)
protected
virtual void osgViewer::ScreenCaptureHandler::captureNextFrame ( osgViewer::ViewerBase viewer)
virtual

Capture the given viewer's views on the next frame.

osg::Camera* osgViewer::ScreenCaptureHandler::findAppropriateCameraForCallback ( osgViewer::ViewerBase viewer)
protected
CaptureOperation* osgViewer::ScreenCaptureHandler::getCaptureOperation ( ) const
int osgViewer::ScreenCaptureHandler::getFramesToCapture ( ) const

Get the number of frames to capture.

int osgViewer::ScreenCaptureHandler::getKeyEventTakeScreenShot ( ) const
inline
int osgViewer::ScreenCaptureHandler::getKeyEventToggleContinuousCapture ( ) const
inline
virtual void osgViewer::ScreenCaptureHandler::getUsage ( osg::ApplicationUsage usage) const
virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::GUIEventHandler.

virtual bool osgViewer::ScreenCaptureHandler::handle ( const osgGA::GUIEventAdapter ,
osgGA::GUIActionAdapter  
)
virtual

Deprecated, Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::GUIEventHandler.

void osgViewer::ScreenCaptureHandler::removeCallbackFromViewer ( osgViewer::ViewerBase viewer)
protected
void osgViewer::ScreenCaptureHandler::setCaptureOperation ( CaptureOperation operation)
void osgViewer::ScreenCaptureHandler::setFramesToCapture ( int  numFrames)

Set the number of frames to capture.

Parameters:
numFrames>0: capture that number of frames. <0: capture all frames, call stopCapture() to stop it.
void osgViewer::ScreenCaptureHandler::setKeyEventTakeScreenShot ( int  key)
inline
void osgViewer::ScreenCaptureHandler::setKeyEventToggleContinuousCapture ( int  key)
inline
void osgViewer::ScreenCaptureHandler::startCapture ( )

Start capturing any viewer(s) the handler is attached to at the end of the next frame.

void osgViewer::ScreenCaptureHandler::stopCapture ( )

Stop capturing.


Member Data Documentation

osg::ref_ptr<osg::Camera::DrawCallback> osgViewer::ScreenCaptureHandler::_callback
protected
int osgViewer::ScreenCaptureHandler::_keyEventTakeScreenShot
protected
int osgViewer::ScreenCaptureHandler::_keyEventToggleContinuousCapture
protected
osg::ref_ptr<CaptureOperation> osgViewer::ScreenCaptureHandler::_operation
protected
bool osgViewer::ScreenCaptureHandler::_startCapture
protected
bool osgViewer::ScreenCaptureHandler::_stopCapture
protected

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

osg logo
Generated at Sat Jan 12 2013 03:06:16 for the OpenSceneGraph by doxygen 1.8.1.1.