Capture interface that plugins must implement.
More...
#include <Capture.h>
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.
- Examples:
- SampleCamCalib.cpp, SampleCvTestbed.cpp, SampleIntegralImage.cpp, SampleLabeling.cpp, SampleMarkerDetector.cpp, SampleMarkerHide.cpp, SampleMarkerlessDetector.cpp, SampleMultiMarker.cpp, SampleMultiMarkerBundle.cpp, SamplePointcloud.cpp, and SampleTrack.cpp.
Definition at line 46 of file Capture.h.
Constructor.
- Parameters
-
| captureDevice | Information of which camera to create. |
Definition at line 54 of file Capture.h.
| virtual alvar::Capture::~Capture |
( |
| ) |
|
|
inlinevirtual |
The camera information associated to this capture object.
- Examples:
- SampleCamCalib.cpp, SampleCvTestbed.cpp, SampleIntegralImage.cpp, SampleLabeling.cpp, SampleMarkerDetector.cpp, SampleMarkerHide.cpp, SampleMarkerlessDetector.cpp, SampleMultiMarker.cpp, SampleMultiMarkerBundle.cpp, SamplePointcloud.cpp, and SampleTrack.cpp.
Definition at line 70 of file Capture.h.
| virtual IplImage* alvar::Capture::captureImage |
( |
| ) |
|
|
pure virtual |
| bool alvar::Capture::isCapturing |
( |
| ) |
|
|
inline |
Test if the camera was properly initialized.
Definition at line 85 of file Capture.h.
| virtual bool alvar::Capture::loadSettings |
( |
std::string |
filename | ) |
|
|
inlinevirtual |
Load camera settings from a file.
- Parameters
-
| filename | The filename to read from. |
- Returns
- True if the settings were sucessfully loaded, false otherwise.
- Examples:
- SampleCamCalib.cpp, SampleCvTestbed.cpp, SampleIntegralImage.cpp, SampleLabeling.cpp, SampleMarkerDetector.cpp, SampleMarkerHide.cpp, SampleMarkerlessDetector.cpp, SampleMultiMarker.cpp, SampleMultiMarkerBundle.cpp, SamplePointcloud.cpp, and SampleTrack.cpp.
Definition at line 145 of file Capture.h.
| virtual bool alvar::Capture::saveSettings |
( |
std::string |
filename | ) |
|
|
inlinevirtual |
Save camera settings to a file.
- Parameters
-
| filename | The filename to write to. |
- Returns
- True if the settings were sucessfully saved, false otherwise.
- Examples:
- SampleCamCalib.cpp, SampleCvTestbed.cpp, SampleIntegralImage.cpp, SampleLabeling.cpp, SampleMarkerDetector.cpp, SampleMarkerHide.cpp, SampleMarkerlessDetector.cpp, SampleMultiMarker.cpp, SampleMultiMarkerBundle.cpp, SamplePointcloud.cpp, and SampleTrack.cpp.
Definition at line 124 of file Capture.h.
| virtual bool alvar::Capture::Serialize |
( |
Serialization * |
serialization | ) |
|
|
pure virtual |
| virtual std::string alvar::Capture::SerializeId |
( |
| ) |
|
|
pure virtual |
| virtual void alvar::Capture::setResolution |
( |
const unsigned long |
xResolution, |
|
|
const unsigned long |
yResolution |
|
) |
| |
|
inlinevirtual |
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.
- Examples:
- SampleCamCalib.cpp, SampleCvTestbed.cpp, SampleIntegralImage.cpp, SampleLabeling.cpp, SampleMarkerDetector.cpp, SampleMarkerHide.cpp, SampleMarkerlessDetector.cpp, SampleMultiMarker.cpp, SampleMultiMarkerBundle.cpp, SamplePointcloud.cpp, and SampleTrack.cpp.
Definition at line 93 of file Capture.h.
| virtual bool alvar::Capture::showSettingsDialog |
( |
| ) |
|
|
pure virtual |
| 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.
- Examples:
- SampleCamCalib.cpp, SampleCvTestbed.cpp, SampleIntegralImage.cpp, SampleLabeling.cpp, SampleMarkerDetector.cpp, SampleMarkerHide.cpp, SampleMarkerlessDetector.cpp, SampleMultiMarker.cpp, SampleMultiMarkerBundle.cpp, SamplePointcloud.cpp, and SampleTrack.cpp.
| 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.
- Examples:
- SampleCamCalib.cpp, SampleCvTestbed.cpp, SampleIntegralImage.cpp, SampleLabeling.cpp, SampleMarkerDetector.cpp, SampleMarkerHide.cpp, SampleMarkerlessDetector.cpp, SampleMultiMarker.cpp, SampleMultiMarkerBundle.cpp, SamplePointcloud.cpp, and SampleTrack.cpp.
| unsigned long alvar::Capture::xResolution |
( |
| ) |
|
|
inline |
The resolution along the x axis (horizontal).
Definition at line 75 of file Capture.h.
| unsigned long alvar::Capture::yResolution |
( |
| ) |
|
|
inline |
The resolution along the y axis (vertical).
Definition at line 80 of file Capture.h.
| 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:
