Inheritance diagram for osgViewer::ScreenCaptureHandler:

Classes
class	CaptureOperation

class	WriteToFile

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)

CaptureOperation *	getCaptureOperation () const

virtual bool	handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)

virtual void	captureNextFrame (osgViewer::ViewerBase &viewer)

void	setFramesToCapture (int numFrames)

int	getFramesToCapture () const

void	startCapture ()

void	stopCapture ()

virtual void	getUsage (osg::ApplicationUsage &usage) const

Public Member Functions inherited from osgGA::GUIEventHandler
	GUIEventHandler ()

	GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgGA, GUIEventHandler)

virtual bool	handle (osgGA::Event event, osg::Object object, osg::NodeVisitor *nv)

virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object , osg::NodeVisitor )

Public Member Functions inherited from osgGA::EventHandler
	EventHandler ()

	EventHandler (const EventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgGA, EventHandler)

virtual NodeCallback *	asNodeCallback ()

virtual const NodeCallback *	asNodeCallback () const

virtual DrawableEventCallback *	asDrawableEventCallback ()

virtual const DrawableEventCallback *	asDrawableEventCallback () const

virtual EventHandler *	asEventHandler ()

virtual const EventHandler *	asEventHandler () const

virtual bool	run (osg::Object object, osg::Object data)

virtual void	operator() (osg::Node node, osg::NodeVisitor nv)

virtual void	event (osg::NodeVisitor nv, osg::Drawable drawable)

Public Member Functions inherited from osg::NodeCallback
	NodeCallback ()

	NodeCallback (const NodeCallback &nc, const CopyOp &copyop)

	META_Object (osg, NodeCallback)

Public Member Functions inherited from osg::Callback
	Callback ()

	Callback (const Callback &cb, const CopyOp &copyop)

	META_Object (osg, Callback)

virtual Callback *	asCallback ()

virtual const Callback *	asCallback () const

virtual CallbackObject *	asCallbackObject ()

virtual const CallbackObject *	asCallbackObject () const

virtual StateAttributeCallback *	asStateAttributeCallback ()

virtual const StateAttributeCallback *	asStateAttributeCallback () const

virtual UniformCallback *	asUniformCallback ()

virtual const UniformCallback *	asUniformCallback () const

virtual DrawableUpdateCallback *	asDrawableUpdateCallback ()

virtual const DrawableUpdateCallback *	asDrawableUpdateCallback () const

virtual DrawableCullCallback *	asDrawableCullCallback ()

virtual const DrawableCullCallback *	asDrawableCullCallback () const

bool	traverse (osg::Object object, osg::Object data)

void	setNestedCallback (osg::Callback *cb)

osg::Callback *	getNestedCallback ()

const osg::Callback *	getNestedCallback () const

void	addNestedCallback (osg::Callback *nc)

void	removeNestedCallback (osg::Callback *nc)

Public Member Functions inherited from osg::Object
	Object ()

	Object (bool threadSafeRefUnref)

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

virtual Object *	cloneType () const =0

virtual Object *	clone (const CopyOp &) const =0

virtual bool	isSameKindAs (const Object *) const

virtual const char *	libraryName () const =0

virtual const char *	className () const =0

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual StateSet *	asStateSet ()

virtual const StateSet *	asStateSet () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

virtual Camera *	asCamera ()

virtual const Camera *	asCamera () const

virtual Drawable *	asDrawable ()

virtual const Drawable *	asDrawable () const

virtual UserDataContainer *	asUserDataContainer ()

virtual const UserDataContainer *	asUserDataContainer () const

virtual ValueObject *	asValueObject ()

virtual const ValueObject *	asValueObject () const

virtual Image *	asImage ()

virtual const Image *	asImage () const

virtual void	setThreadSafeRefUnref (bool threadSafe)

virtual void	setName (const std::string &name)

void	setName (const char *name)

const std::string &	getName () const

void	setDataVariance (DataVariance dv)

DataVariance	getDataVariance () const

virtual void	computeDataVariance ()

void	setUserDataContainer (osg::UserDataContainer *udc)

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () const

template<typename T >
bool	getUserValue (const std::string &name, T &value) const

template<typename T >
void	setUserValue (const std::string &name, const T &value)

virtual void	resizeGLObjectBuffers (unsigned int)

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

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () const

void	addObserver (Observer *observer) const

void	removeObserver (Observer *observer) const

Public Member Functions inherited from osg::DrawableEventCallback
	DrawableEventCallback ()

	DrawableEventCallback (const DrawableEventCallback &org, const CopyOp &copyop)

	META_Object (osg, DrawableEventCallback)

Protected Member Functions
void	addCallbackToViewer (osgViewer::ViewerBase &viewer)

void	removeCallbackFromViewer (osgViewer::ViewerBase &viewer)

osg::Camera *	findAppropriateCameraForCallback (osgViewer::ViewerBase &viewer)

Protected Member Functions inherited from osgGA::GUIEventHandler
virtual	~GUIEventHandler ()

Protected Member Functions inherited from osg::NodeCallback
virtual	~NodeCallback ()

Protected Member Functions inherited from osg::Callback
virtual	~Callback ()

Protected Member Functions inherited from osg::Object
virtual	~Object ()

Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()

void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

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 osg::Callback
ref_ptr< Callback >	_nestedCallback

Protected Attributes inherited from osg::Object
std::string	_name

DataVariance	_dataVariance

osg::UserDataContainer *	_userDataContainer

Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet

OpenThreads::Atomic	_refCount

Additional Inherited Members
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

Detailed Description

Event handler that will capture the screen on key press.

Constructor & Destructor Documentation

◆ ScreenCaptureHandler()

osgViewer::ScreenCaptureHandler::ScreenCaptureHandler	(	CaptureOperation *	defaultOperation = `0`,
		int	numFrames = `1`
	)

Parameters

defaultOperation	: operation to do when screen capture happens.
numFrames	>0: capture that number of frames. <0: capture all frames, call stopCapture() to stop it.

Member Function Documentation

◆ addCallbackToViewer()

void osgViewer::ScreenCaptureHandler::addCallbackToViewer ( osgViewer::ViewerBase & viewer )

protected

◆ captureNextFrame()

virtual void osgViewer::ScreenCaptureHandler::captureNextFrame ( osgViewer::ViewerBase & viewer )

virtual

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

◆ findAppropriateCameraForCallback()

osg::Camera* osgViewer::ScreenCaptureHandler::findAppropriateCameraForCallback ( osgViewer::ViewerBase & viewer )

protected

◆ getCaptureOperation()

CaptureOperation* osgViewer::ScreenCaptureHandler::getCaptureOperation ( ) const

◆ getFramesToCapture()

int osgViewer::ScreenCaptureHandler::getFramesToCapture ( ) const

Get the number of frames to capture.

◆ getKeyEventTakeScreenShot()

int osgViewer::ScreenCaptureHandler::getKeyEventTakeScreenShot ( ) const

inline

◆ getKeyEventToggleContinuousCapture()

int osgViewer::ScreenCaptureHandler::getKeyEventToggleContinuousCapture ( ) const

inline

◆ getUsage()

virtual void osgViewer::ScreenCaptureHandler::getUsage ( osg::ApplicationUsage & usage ) const

virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

◆ handle()

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

virtual

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

Reimplemented from osgGA::GUIEventHandler.

◆ removeCallbackFromViewer()

void osgViewer::ScreenCaptureHandler::removeCallbackFromViewer ( osgViewer::ViewerBase & viewer )

protected

◆ setCaptureOperation()

void osgViewer::ScreenCaptureHandler::setCaptureOperation ( CaptureOperation * operation )

◆ setFramesToCapture()

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.

◆ setKeyEventTakeScreenShot()

void osgViewer::ScreenCaptureHandler::setKeyEventTakeScreenShot ( int key )

inline

◆ setKeyEventToggleContinuousCapture()

void osgViewer::ScreenCaptureHandler::setKeyEventToggleContinuousCapture ( int key )

inline

◆ startCapture()

void osgViewer::ScreenCaptureHandler::startCapture ( )

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

◆ stopCapture()

void osgViewer::ScreenCaptureHandler::stopCapture ( )

Stop capturing.

Member Data Documentation

◆ _callback

osg::ref_ptr<osg::Camera::DrawCallback> osgViewer::ScreenCaptureHandler::_callback

protected

◆ _keyEventTakeScreenShot

int osgViewer::ScreenCaptureHandler::_keyEventTakeScreenShot

protected

◆ _keyEventToggleContinuousCapture

int osgViewer::ScreenCaptureHandler::_keyEventToggleContinuousCapture

protected

◆ _operation

osg::ref_ptr<CaptureOperation> osgViewer::ScreenCaptureHandler::_operation

protected

◆ _startCapture

bool osgViewer::ScreenCaptureHandler::_startCapture

protected

◆ _stopCapture

bool osgViewer::ScreenCaptureHandler::_stopCapture

protected

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

osgViewer/ViewerEventHandlers

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScreenCaptureHandler()

Member Function Documentation

◆ addCallbackToViewer()

◆ captureNextFrame()

◆ findAppropriateCameraForCallback()

◆ getCaptureOperation()

◆ getFramesToCapture()

◆ getKeyEventTakeScreenShot()

◆ getKeyEventToggleContinuousCapture()

◆ getUsage()

◆ handle()

◆ removeCallbackFromViewer()

◆ setCaptureOperation()

◆ setFramesToCapture()

◆ setKeyEventTakeScreenShot()

◆ setKeyEventToggleContinuousCapture()

◆ startCapture()

◆ stopCapture()

Member Data Documentation

◆ _callback

◆ _keyEventTakeScreenShot

◆ _keyEventToggleContinuousCapture

◆ _operation

◆ _startCapture

◆ _stopCapture