Capture interface that plugins must implement. More...
#include <Capture.h>
Public Member Functions | |
| Capture (const CaptureDevice captureDevice) | |
| Constructor. | |
| CaptureDevice | captureDevice () |
| The camera information associated to this capture object. | |
| virtual IplImage * | captureImage ()=0 |
| Capture one image from the camera. | |
| bool | isCapturing () |
| Test if the camera was properly initialized. | |
| virtual bool | loadSettings (std::string filename) |
| Load camera settings from a file. | |
| virtual bool | saveSettings (std::string filename) |
| Save camera settings to a file. | |
| virtual bool | Serialize (Serialization *serialization)=0 |
| Performs serialization of the class members and configuration. | |
| virtual std::string | SerializeId ()=0 |
| The identification of the class for serialization. | |
| virtual void | setResolution (const unsigned long xResolution, const unsigned long yResolution) |
| Set the resolution. | |
| virtual bool | showSettingsDialog ()=0 |
| Show the settings dialog of the camera. | |
| virtual bool | start ()=0 |
| Starts the camera capture. | |
| virtual void | stop ()=0 |
| Stops the camera capture. | |
| unsigned long | xResolution () |
| The resolution along the x axis (horizontal). | |
| unsigned long | yResolution () |
| The resolution along the y axis (vertical). | |
| virtual | ~Capture () |
| Destructor. | |
Protected Attributes | |
| CaptureDevice | mCaptureDevice |
| bool | mIsCapturing |
| unsigned long | mXResolution |
| unsigned long | mYResolution |
Detailed Description
Capture interface that plugins must implement.
All plugins must implement the Capture interface. This is the class that implements all of the camera capture funtionality. This class is created by the CapturePlugin implementation.
Constructor & Destructor Documentation
| alvar::Capture::Capture | ( | const CaptureDevice | captureDevice | ) | [inline] |
| virtual alvar::Capture::~Capture | ( | ) | [inline, virtual] |
Member Function Documentation
| CaptureDevice alvar::Capture::captureDevice | ( | ) | [inline] |
The camera information associated to this capture object.
| virtual IplImage* alvar::Capture::captureImage | ( | ) | [pure virtual] |
Capture one image from the camera.
Do not modify this image.
- Returns:
- The captured image.
Implemented in alvar::plugins::CaptureDSCapture, alvar::plugins::CapturePtgrey, alvar::plugins::CaptureHighgui, alvar::plugins::CaptureCmu, and alvar::plugins::CaptureFile.
| bool alvar::Capture::isCapturing | ( | ) | [inline] |
| virtual bool alvar::Capture::loadSettings | ( | std::string | filename | ) | [inline, virtual] |
Load camera settings from a file.
- Parameters:
-
filename The filename to read from.
- Returns:
- True if the settings were sucessfully loaded, false otherwise.
| virtual bool alvar::Capture::saveSettings | ( | std::string | filename | ) | [inline, virtual] |
Save camera settings to a file.
- Parameters:
-
filename The filename to write to.
- Returns:
- True if the settings were sucessfully saved, false otherwise.
| virtual bool alvar::Capture::Serialize | ( | Serialization * | serialization | ) | [pure virtual] |
Performs serialization of the class members and configuration.
- Parameters:
-
serialization The Serialization object.
- Returns:
- True if the serialization of the class was successful, false otherwise.
Implemented in alvar::plugins::CaptureDSCapture, alvar::plugins::CapturePtgrey, alvar::plugins::CaptureHighgui, alvar::plugins::CaptureCmu, and alvar::plugins::CaptureFile.
| virtual std::string alvar::Capture::SerializeId | ( | ) | [pure virtual] |
The identification of the class for serialization.
Implemented in alvar::plugins::CaptureDSCapture, alvar::plugins::CapturePtgrey, alvar::plugins::CaptureHighgui, alvar::plugins::CaptureCmu, and alvar::plugins::CaptureFile.
| virtual void alvar::Capture::setResolution | ( | const unsigned long | xResolution, |
| const unsigned long | yResolution | ||
| ) | [inline, virtual] |
Set the resolution.
- Parameters:
-
xResolution The resolution along the x axis (horizontal). yResolution The resolution along the y axis (vertical).
Reimplemented in alvar::plugins::CaptureHighgui.
| virtual bool alvar::Capture::showSettingsDialog | ( | ) | [pure virtual] |
Show the settings dialog of the camera.
- Returns:
- True if the settings dialog was shown, false otherwise.
Implemented in alvar::plugins::CaptureDSCapture, alvar::plugins::CapturePtgrey, alvar::plugins::CaptureHighgui, alvar::plugins::CaptureCmu, and alvar::plugins::CaptureFile.
| virtual bool alvar::Capture::start | ( | ) | [pure virtual] |
Starts the camera capture.
- Returns:
- True if the camera was properly initialized, false otherwise.
Implemented in alvar::plugins::CaptureDSCapture, alvar::plugins::CapturePtgrey, alvar::plugins::CaptureHighgui, alvar::plugins::CaptureCmu, and alvar::plugins::CaptureFile.
| virtual void alvar::Capture::stop | ( | ) | [pure virtual] |
Stops the camera capture.
Implemented in alvar::plugins::CaptureDSCapture, alvar::plugins::CapturePtgrey, alvar::plugins::CaptureHighgui, alvar::plugins::CaptureCmu, and alvar::plugins::CaptureFile.
| unsigned long alvar::Capture::xResolution | ( | ) | [inline] |
| unsigned long alvar::Capture::yResolution | ( | ) | [inline] |
Member Data Documentation
CaptureDevice alvar::Capture::mCaptureDevice [protected] |
bool alvar::Capture::mIsCapturing [protected] |
unsigned long alvar::Capture::mXResolution [protected] |
unsigned long alvar::Capture::mYResolution [protected] |
The documentation for this class was generated from the following file: