makVrv::DtScreenCapture Class Reference

Inheritance diagram for makVrv::DtScreenCapture:

Public Member Functions
virtual	~DtScreenCapture ()
	Protected DCTOR.
virtual const DtUnicode &	screenCaptureFileName ()
	\ Returns the screen capture image file name managed by the API
virtual void	setScreenCaptureFileName (DtUnicode &val, bool makeUnique=true)
	\ Sets the screen capture image file name managed by the API
virtual const DtUnicode &	screenCaptureFileExtension ()
	\ Returns the screen capture image file name extension
virtual void	setScreenCaptureFileExtension (DtUnicode &val)
	\ Sets the screen capture image file name extension \ supported/tested extensions: png, tiff, bmp, dds
virtual void	takeScreenCapture ()
	\ Lookups up the observer and takes a screen capture from the active channel
virtual void	takeScreenCapture (const DtChannel *channel)=0
	\ Takes a screen capture from the channel's view port and stores it into the hard drive
virtual void	takeScreenCapture (const DtObserver &observer)
	\ Takes a screen capture from the observer's active channel view port and stores it into the hard drive
virtual DtUnicode	fileNameUniqueIdentifier ()
	\ Returns a unique identifier for the file name
virtual DtUnicode	generateFileName ()
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtScreenCapture &	instance (DtDe &de)
	an instance of DtScreenCaptureUtility

Protected Member Functions
	DtScreenCapture (DtDe &de)
	Protected CTOR. Must be called by creator.

Protected Attributes
DtDe &	myDe
DtUnicode	myScreenCaptureFileName
DtUnicode	myScreenCaptureFileExtension
int	myScreenCaptureCounter
std::string	myLastFileNameIdentifierUsed
bool	myMakeUnique

Private Member Functions
	DtScreenCapture ()
	constructor

Friends
class	DtScreenCaptureCreator

Constructor & Destructor Documentation

makVrv::DtScreenCapture::DtScreenCapture ( )

private

constructor

virtual makVrv::DtScreenCapture::~DtScreenCapture ( )

virtual

Protected DCTOR.

makVrv::DtScreenCapture::DtScreenCapture ( DtDe &  de )

protected

Protected CTOR. Must be called by creator.

Member Function Documentation

static DtScreenCapture& makVrv::DtScreenCapture::instance ( DtDe &  de )

static

an instance of DtScreenCaptureUtility

virtual const DtUnicode& makVrv::DtScreenCapture::screenCaptureFileName ( )

virtual

\ Returns the screen capture image file name managed by the API

virtual void makVrv::DtScreenCapture::setScreenCaptureFileName ( DtUnicode &  val, bool  makeUnique = true  )

virtual

\ Sets the screen capture image file name managed by the API

virtual const DtUnicode& makVrv::DtScreenCapture::screenCaptureFileExtension ( )

virtual

\ Returns the screen capture image file name extension

virtual void makVrv::DtScreenCapture::setScreenCaptureFileExtension ( DtUnicode &  val )

virtual

\ Sets the screen capture image file name extension \ supported/tested extensions: png, tiff, bmp, dds

virtual void makVrv::DtScreenCapture::takeScreenCapture ( )

virtual

\ Lookups up the observer and takes a screen capture from the active channel

virtual void makVrv::DtScreenCapture::takeScreenCapture ( const DtChannel *  channel )

pure virtual

\ Takes a screen capture from the channel's view port and stores it into the hard drive

Implemented in makVrv::DtOsgScreenCapture.

virtual void makVrv::DtScreenCapture::takeScreenCapture ( const DtObserver &  observer )

virtual

\ Takes a screen capture from the observer's active channel view port and stores it into the hard drive

virtual DtUnicode makVrv::DtScreenCapture::fileNameUniqueIdentifier ( )

virtual

\ Returns a unique identifier for the file name

virtual DtUnicode makVrv::DtScreenCapture::generateFileName ( )

virtual

Friends And Related Function Documentation

friend class DtScreenCaptureCreator

friend

Member Data Documentation

DtDe& makVrv::DtScreenCapture::myDe

protected

DtUnicode makVrv::DtScreenCapture::myScreenCaptureFileName

protected

DtUnicode makVrv::DtScreenCapture::myScreenCaptureFileExtension

protected

int makVrv::DtScreenCapture::myScreenCaptureCounter

protected

std::string makVrv::DtScreenCapture::myLastFileNameIdentifierUsed

protected

bool makVrv::DtScreenCapture::myMakeUnique

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvCore/DtScreenCapture.h