iMSTK: imstk::VTKScreenCaptureUtility Class Reference

Utility class to manage screen capture through VTK. More...

Inheritance diagram for imstk::VTKScreenCaptureUtility:

Collaboration diagram for imstk::VTKScreenCaptureUtility:

Public Member Functions
	VTKScreenCaptureUtility (vtkRenderWindow *const rw, const std::string prefix="Screenshot-")

virtual std::string	saveScreenShot (const std::string &captureName) override
	Saves the screenshot as a png file.

Public Member Functions inherited from imstk::ScreenCaptureUtility
	ScreenCaptureUtility (std::string prefix="Screenshot-")
	Constructor.

std::string	saveScreenShot ()
	Saves a screenshot with a name of <prefix><screenshotNumber>.<implementationImageType> the <ImplementationImageType> is most likely `.png`. More...

unsigned int	getScreenShotNumber () const
	Returns the number of the next screenshot.

void	setScreenShotPrefix (const std::string &newPrefix)
	set/reset the prefix and the count numbers

void	resetScreenShotNumber ()
	reset the screenshot number

Protected Attributes
vtkSmartPointer< vtkWindowToImageFilter >	m_windowToImageFilter

vtkSmartPointer< vtkPNGWriter >	m_pngWriter
	using vtk's png writer to save the screenshots

vtkRenderWindow *	m_renderWindow
	render window whose screen shot will be taken

Protected Attributes inherited from imstk::ScreenCaptureUtility
unsigned int	m_screenShotNumber = 0
	screen shot number is added to the file prefix, and incremented everytime a screen shot is taken

std::string	m_screenShotPrefix
	the prefix for the screenshots to be saved

Detailed Description

Utility class to manage screen capture through VTK.

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