mitk::VideoSource Class Reference

#include <mitkVideoSource.h>

Inheritance diagram for mitk::VideoSource:

Collaboration diagram for mitk::VideoSource:

Public Member Functions
	mitkClassMacroItkParent (VideoSource, itk::Object)
virtual void	FetchFrame ()
virtual unsigned char *	GetVideoTexture ()=0
virtual void	StartCapturing ()
virtual void	StopCapturing ()
virtual bool	IsCapturingEnabled () const
virtual int	GetImageWidth ()
virtual int	GetImageHeight ()
virtual unsigned long	GetFrameCount () const
virtual bool	GetCapturePaused () const
virtual void	PauseCapturing ()

Protected Member Functions
	VideoSource ()
	~VideoSource () override

Protected Attributes
unsigned char *	m_CurrentVideoTexture
int	m_CaptureWidth
int	m_CaptureHeight
bool	m_CapturingInProcess
unsigned long	m_FrameCount
bool	m_CapturePaused

Detailed Description

Simple base class for acquiring video data.

Definition at line 27 of file mitkVideoSource.h.

Constructor & Destructor Documentation

VideoSource()

mitk::VideoSource::VideoSource ( )

protected

init member

~VideoSource()

mitk::VideoSource::~VideoSource ( )

overrideprotected

deletes m_CurrentVideoTexture (if not 0)

Member Function Documentation

FetchFrame()

virtual void mitk::VideoSource::FetchFrame ( )

virtual

assigns the grabbing devices for acquiring the next frame. in this base implementation it does nothing except incrementing m_FrameCount

GetCapturePaused()

virtual bool mitk::VideoSource::GetCapturePaused ( ) const

virtual

Returns

true, if capturing is currently paused, false otherwise

GetFrameCount()

virtual unsigned long mitk::VideoSource::GetFrameCount ( ) const

virtual

Returns

the current frame count

GetImageHeight()

virtual int mitk::VideoSource::GetImageHeight ( )

virtual

Returns

the current frame height (might be 0 if unknown)

GetImageWidth()

virtual int mitk::VideoSource::GetImageWidth ( )

virtual

Returns

the current frame width (might be 0 if unknown)

GetVideoTexture()

virtual unsigned char* mitk::VideoSource::GetVideoTexture ( )

pure virtual

Returns

a pointer to the image data array for opengl rendering.

IsCapturingEnabled()

virtual bool mitk::VideoSource::IsCapturingEnabled ( ) const

virtual

Returns

true if video capturing is active.

See also

m_CapturingInProcess

mitkClassMacroItkParent()

mitk::VideoSource::mitkClassMacroItkParent	(	VideoSource	,
		itk::Object
	)

Smart pointer defs

PauseCapturing()

virtual void mitk::VideoSource::PauseCapturing ( )

virtual

toggles m_CapturePaused In Subclasses this function can be overwritten to take measurs to provide a pause image, BUT DO NOT FORGET TO TOGGLE m_CapturePaused

StartCapturing()

virtual void mitk::VideoSource::StartCapturing ( )

virtual

advices this class to start the video capturing. in this base implementation: toggles m_CapturingInProcess, resets m_FrameCount ATTENTION: this should be also done in subclasses overwriting this method

StopCapturing()

virtual void mitk::VideoSource::StopCapturing ( )

virtual

advices this class to stop the video capturing. in this base implementation: toggles m_CapturingInProcess, resets m_FrameCount ATTENTION: this should be also done in subclasses overwriting this method

Member Data Documentation

m_CaptureHeight

int mitk::VideoSource::m_CaptureHeight

protected

should be filled when the first frame is available default: 0

Definition at line 112 of file mitkVideoSource.h.

m_CapturePaused

bool mitk::VideoSource::m_CapturePaused

protected

Saves if the capturing is currently paused, i.e. this will not fetch any further frames but provide the current frame as long as m_CapturePaused is true default: false

Definition at line 133 of file mitkVideoSource.h.

m_CaptureWidth

int mitk::VideoSource::m_CaptureWidth

protected

should be filled when the first frame is available default: 0

Definition at line 106 of file mitkVideoSource.h.

m_CapturingInProcess

bool mitk::VideoSource::m_CapturingInProcess

protected

saves if capturing is in procress default: false

Definition at line 118 of file mitkVideoSource.h.

m_CurrentVideoTexture

unsigned char* mitk::VideoSource::m_CurrentVideoTexture

protected

finally this is what the video source must create: a video texture pointer default: 0

Definition at line 100 of file mitkVideoSource.h.

m_FrameCount

unsigned long mitk::VideoSource::m_FrameCount

protected

Saves the current frame count. Incremented in FetchFrame(). Resetted to 0 when StartCapturing() or StopCapturing() is called. default: 0

Definition at line 125 of file mitkVideoSource.h.

---

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

• mitkVideoSource.h