OpenSceneGraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgViewer::ScreenCaptureHandler::WriteToFile Class Reference

Concrete implementation of a CaptureOperation that writes the screen capture to a file. More...

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

Public Types

enum  SavePolicy { OVERWRITE, SEQUENTIAL_NUMBER }
 

Public Member Functions

 WriteToFile (const std::string &filename, const std::string &extension, SavePolicy savePolicy=SEQUENTIAL_NUMBER)
 
virtual void operator() (const osg::Image &image, const unsigned int context_id)
 
void setSavePolicy (SavePolicy savePolicy)
 
SavePolicy getSavePolicy () const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

WriteToFileoperator= (const WriteToFile &)
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

const std::string _filename
 
const std::string _extension
 
SavePolicy _savePolicy
 
std::vector< unsigned int > _contextSaveCounter
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

Concrete implementation of a CaptureOperation that writes the screen capture to a file.

Member Enumeration Documentation

◆ SavePolicy

Enumerator
OVERWRITE 
SEQUENTIAL_NUMBER 

Constructor & Destructor Documentation

◆ WriteToFile()

osgViewer::ScreenCaptureHandler::WriteToFile::WriteToFile ( const std::string &  filename,
const std::string &  extension,
SavePolicy  savePolicy = SEQUENTIAL_NUMBER 
)

Member Function Documentation

◆ getSavePolicy()

SavePolicy osgViewer::ScreenCaptureHandler::WriteToFile::getSavePolicy ( ) const
inline

◆ operator()()

virtual void osgViewer::ScreenCaptureHandler::WriteToFile::operator() ( const osg::Image image,
const unsigned int  context_id 
)
virtual

◆ operator=()

WriteToFile& osgViewer::ScreenCaptureHandler::WriteToFile::operator= ( const WriteToFile )
inlineprotected

◆ setSavePolicy()

void osgViewer::ScreenCaptureHandler::WriteToFile::setSavePolicy ( SavePolicy  savePolicy)
inline

Member Data Documentation

◆ _contextSaveCounter

std::vector<unsigned int> osgViewer::ScreenCaptureHandler::WriteToFile::_contextSaveCounter
protected

◆ _extension

const std::string osgViewer::ScreenCaptureHandler::WriteToFile::_extension
protected

◆ _filename

const std::string osgViewer::ScreenCaptureHandler::WriteToFile::_filename
protected

◆ _savePolicy

SavePolicy osgViewer::ScreenCaptureHandler::WriteToFile::_savePolicy
protected

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