Public Member Functions | Private Attributes | List of all members
alvar::plugins::CaptureFile Class Reference

Implementation of Capture interface for File plugin. More...

#include <CapturePluginFile.h>

Inheritance diagram for alvar::plugins::CaptureFile:
Inheritance graph
[legend]

Public Member Functions

 CaptureFile (const CaptureDevice captureDevice)
 Constructor. More...
 
IplImage * captureImage ()
 Capture one image from the camera. More...
 
bool Serialize (Serialization *serialization)
 Performs serialization of the class members and configuration. More...
 
std::string SerializeId ()
 The identification of the class for serialization. More...
 
bool showSettingsDialog ()
 Show the settings dialog of the camera. More...
 
bool start ()
 Starts the camera capture. More...
 
void stop ()
 Stops the camera capture. More...
 
 ~CaptureFile ()
 Destructor. More...
 
- Public Member Functions inherited from alvar::Capture
 Capture (const CaptureDevice captureDevice)
 Constructor. More...
 
CaptureDevice captureDevice ()
 The camera information associated to this capture object. More...
 
bool isCapturing ()
 Test if the camera was properly initialized. More...
 
virtual bool loadSettings (std::string filename)
 Load camera settings from a file. More...
 
virtual bool saveSettings (std::string filename)
 Save camera settings to a file. More...
 
virtual void setResolution (const unsigned long xResolution, const unsigned long yResolution)
 Set the resolution. More...
 
unsigned long xResolution ()
 The resolution along the x axis (horizontal). More...
 
unsigned long yResolution ()
 The resolution along the y axis (vertical). More...
 
virtual ~Capture ()
 Destructor. More...
 

Private Attributes

IplImage mImage
 
cv::Mat mMatrix
 
cv::VideoCapture mVideoCapture
 

Additional Inherited Members

- Protected Attributes inherited from alvar::Capture
CaptureDevice mCaptureDevice
 
bool mIsCapturing
 
unsigned long mXResolution
 
unsigned long mYResolution
 

Detailed Description

Implementation of Capture interface for File plugin.

Definition at line 58 of file CapturePluginFile.h.

Constructor & Destructor Documentation

alvar::plugins::CaptureFile::CaptureFile ( const CaptureDevice  captureDevice)

Constructor.

Parameters
captureDeviceInformation of which camera to create.

Definition at line 29 of file CapturePluginFile.cpp.

alvar::plugins::CaptureFile::~CaptureFile ( )

Destructor.

Definition at line 37 of file CapturePluginFile.cpp.

Member Function Documentation

IplImage * alvar::plugins::CaptureFile::captureImage ( )
virtual

Capture one image from the camera.

Do not modify this image.

Returns
The captured image.

Implements alvar::Capture.

Definition at line 66 of file CapturePluginFile.cpp.

bool alvar::plugins::CaptureFile::Serialize ( Serialization serialization)
virtual

Performs serialization of the class members and configuration.

Parameters
serializationThe Serialization object.
Returns
True if the serialization of the class was successful, false otherwise.

Implements alvar::Capture.

Definition at line 100 of file CapturePluginFile.cpp.

std::string alvar::plugins::CaptureFile::SerializeId ( )
virtual

The identification of the class for serialization.

Implements alvar::Capture.

Definition at line 95 of file CapturePluginFile.cpp.

bool alvar::plugins::CaptureFile::showSettingsDialog ( )
virtual

Show the settings dialog of the camera.

Returns
True if the settings dialog was shown, false otherwise.

Implements alvar::Capture.

Definition at line 89 of file CapturePluginFile.cpp.

bool alvar::plugins::CaptureFile::start ( )
virtual

Starts the camera capture.

Returns
True if the camera was properly initialized, false otherwise.

Implements alvar::Capture.

Definition at line 42 of file CapturePluginFile.cpp.

void alvar::plugins::CaptureFile::stop ( )
virtual

Stops the camera capture.

Implements alvar::Capture.

Definition at line 58 of file CapturePluginFile.cpp.

Member Data Documentation

IplImage alvar::plugins::CaptureFile::mImage
private

Definition at line 81 of file CapturePluginFile.h.

cv::Mat alvar::plugins::CaptureFile::mMatrix
private

Definition at line 80 of file CapturePluginFile.h.

cv::VideoCapture alvar::plugins::CaptureFile::mVideoCapture
private

Definition at line 79 of file CapturePluginFile.h.


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


ar_track_alvar
Author(s): Scott Niekum
autogenerated on Mon Jun 10 2019 12:47:05