Fawkes API
Fawkes Development Version
|
Plain dummy control. More...
#include <>>
Public Member Functions | |
virtual bool | auto_gain () |
Return whether auto gain is enabled. More... | |
virtual void | set_auto_gain (bool enabled) |
Enable/disable auto gain. More... | |
virtual bool | auto_white_balance () |
Return whether auto white balance is enabled. More... | |
virtual void | set_auto_white_balance (bool enabled) |
Enable/disable auto white balance. More... | |
virtual unsigned int | exposure_auto () |
Return whether auto exposure is enabled. More... | |
virtual void | set_exposure_auto (unsigned int enabled) |
Enable/disable auto exposure. More... | |
virtual int | red_balance () |
Get current red balance. More... | |
virtual void | set_red_balance (int red_balance) |
Set red balance. More... | |
virtual int | blue_balance () |
Get current blue balance. More... | |
virtual void | set_blue_balance (int blue_balance) |
Set blue balance. More... | |
virtual int | u_balance () |
Get current u balance. More... | |
virtual void | set_u_balance (int u_balance) |
Set u balance. More... | |
virtual int | v_balance () |
Get current v balance. More... | |
virtual void | set_v_balance (int v_balance) |
Set v balance. More... | |
virtual unsigned int | brightness () |
Get current brightness. More... | |
virtual void | set_brightness (unsigned int brightness) |
Set new brightness. More... | |
virtual unsigned int | contrast () |
Get current contrast. More... | |
virtual void | set_contrast (unsigned int contrast) |
Set new contrast. More... | |
virtual unsigned int | saturation () |
Get current saturation. More... | |
virtual void | set_saturation (unsigned int saturation) |
Set new saturation. More... | |
virtual int | hue () |
Get current hue. More... | |
virtual void | set_hue (int hue) |
Set new hue. More... | |
virtual unsigned int | exposure () |
Get current exposure. More... | |
virtual void | set_exposure (unsigned int exposure) |
Set new exposure. More... | |
virtual unsigned int | gain () |
Get current gain. More... | |
virtual void | set_gain (unsigned int gain) |
Set new gain. More... | |
virtual const char * | format () |
Get the image format the camera currently uses. More... | |
virtual void | set_format (const char *format) |
Set the image format the camera should use. More... | |
virtual unsigned int | width () |
Get the current width of the image. More... | |
virtual unsigned int | height () |
Get the current height of the image. More... | |
virtual void | size (unsigned int &width, unsigned int &height) |
Get the current image size. More... | |
virtual void | set_size (unsigned int width, unsigned int height) |
Set the image size the camera should use. More... | |
virtual bool | horiz_mirror () |
Return whether the camera image is horizontally mirrored. More... | |
virtual bool | vert_mirror () |
Return whether the camera image is vertically mirrored. More... | |
virtual void | mirror (bool &horiz, bool &vert) |
Get information about current camera image mirroring. More... | |
virtual void | set_horiz_mirror (bool enabled) |
Set whether the camera should mirror images horizontally. More... | |
virtual void | set_vert_mirror (bool enabled) |
Set whether the camera should mirror images vertically. More... | |
virtual void | set_mirror (bool horiz, bool vert) |
Set whether the camera should mirror images. More... | |
virtual unsigned int | fps () |
Get the number of frames per second the camera tries to deliver. More... | |
virtual void | set_fps (unsigned int fps) |
Set the number of frames per second the camera tries to deliver. More... | |
virtual unsigned int | lens_x_corr () |
Get current lens x correction. More... | |
virtual unsigned int | lens_y_corr () |
Get current lens y correction. More... | |
virtual void | lens_corr (unsigned int &x_corr, unsigned int &y_corr) |
Get current lens correction. More... | |
virtual void | set_lens_x_corr (unsigned int x_corr) |
Set lens x correction. More... | |
virtual void | set_lens_y_corr (unsigned int y_corr) |
Set lens y correction. More... | |
virtual void | set_lens_corr (unsigned int x_corr, unsigned int y_corr) |
Set lens correction. More... | |
virtual void | process_pantilt () |
Process pan/tilt information. More... | |
virtual bool | supports_pan () |
Check whether this controller supports panning. More... | |
virtual bool | supports_tilt () |
Check whether this controller supports tilting. More... | |
virtual void | set_pan (int pan) |
Set pan value. More... | |
virtual void | set_tilt (int tilt) |
Set tilt value. More... | |
virtual void | set_pan_tilt (int pan, int tilt) |
Set pan and tilt in one go. More... | |
virtual void | set_pan_tilt_rad (float pan, float tilt) |
Set pan and tilt as float value. More... | |
virtual int | pan () |
Get pan value. More... | |
virtual int | tilt () |
Get tilt value. More... | |
virtual void | start_get_pan_tilt () |
Start asynchronous fetch operation for pan and tilt values. More... | |
virtual void | pan_tilt (int &pan, int &tilt) |
Get pan and tilt at the same time. More... | |
virtual void | pan_tilt_rad (float &pan, float &tilt) |
Get pan and tilt at the same time in radiant. More... | |
virtual int | min_pan () |
Get minimum pan value. More... | |
virtual int | max_pan () |
Get maximum pan value. More... | |
virtual int | min_tilt () |
Get minimum tilt value. More... | |
virtual int | max_tilt () |
Get maximum tilt value. More... | |
virtual void | reset_pan_tilt () |
Bring camera into home position. More... | |
virtual void | set_pan_tilt_limit (int pan_left, int pan_right, int tilt_up, int tilt_down) |
Set pan/tilt limits. More... | |
virtual void | reset_pan_tilt_limit () |
Reset pan/tilt limits. More... | |
virtual void | reset_zoom () |
Reset zoom. More... | |
virtual void | set_zoom (unsigned int zoom) |
Set new camera-specific zoom value. More... | |
virtual unsigned int | zoom () |
Get current zoom value. More... | |
virtual unsigned int | zoom_max () |
Maximum zoom value. More... | |
virtual unsigned int | zoom_min () |
Minimum zoom value. More... | |
virtual void | set_zoom_speed_tele (unsigned int speed) |
Set speed in tele range. More... | |
virtual void | set_zoom_speed_wide (unsigned int speed) |
Set speed in wide range. More... | |
virtual void | set_zoom_digital_enabled (bool enabled) |
Set if digital zoom may be used. More... | |
virtual bool | supports_effect (unsigned int effect) |
Check if camera control supports desired effect. More... | |
virtual void | set_effect (unsigned int effect) |
Enable effect. More... | |
virtual unsigned int | effect () |
Current effect. More... | |
virtual void | reset_effect () |
Reset effect. More... | |
virtual bool | auto_focus () |
Check if auto focus is enabled. More... | |
virtual void | set_auto_focus (bool enabled) |
Enable or disable auto focus. More... | |
virtual unsigned int | focus () |
Get current focus value. More... | |
virtual void | set_focus (unsigned int focus) |
Set new focus value. More... | |
virtual unsigned int | focus_min () |
Get minimum focus value. More... | |
virtual unsigned int | focus_max () |
Get maximum focus value. More... | |
![]() | |
virtual | ~CameraControlColor () |
Empty virtual destructor. More... | |
virtual void | set_auto_all (bool enabled) |
Enable/disable all automatic settings. More... | |
![]() | |
virtual | ~CameraControl () |
Virtual empty destructor. More... | |
![]() | |
virtual | ~CameraControlImage () |
Empty virtual destructor. More... | |
![]() | |
virtual | ~CameraControlPanTilt () |
Empty virtual destructor. More... | |
![]() | |
virtual | ~CameraControlZoom () |
Empty virtual destructor. More... | |
![]() | |
virtual | ~CameraControlEffect () |
Empty virtual destructor. More... | |
![]() | |
virtual | ~CameraControlFocus () |
Empty virtual destructor. More... | |
Additional Inherited Members | |
![]() | |
static const unsigned int | EFFECT_NONE = 0 |
No effect constant. More... | |
Plain dummy control.
Dummy camera control.
Does nothing, supports nothing. Use to avoid unecessary NULL checks
This control supports every control type, but the operations are NOOPs. This is useful to instantiate the dummy control to avoid NULL checks.
|
virtual |
Check if auto focus is enabled.
NotImplementedException | Not implemented by this control |
Implements firevision::CameraControlFocus.
|
virtual |
Return whether auto gain is enabled.
Implements firevision::CameraControlColor.
|
virtual |
Return whether auto white balance is enabled.
Implements firevision::CameraControlColor.
|
virtual |
Get current blue balance.
Implements firevision::CameraControlColor.
|
virtual |
|
virtual |
|
virtual |
Current effect.
Implements firevision::CameraControlEffect.
Definition at line 387 of file dummy.cpp.
References firevision::CameraControlEffect::EFFECT_NONE.
|
virtual |
|
virtual |
Return whether auto exposure is enabled.
Implements firevision::CameraControlColor.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Get the image format the camera currently uses.
Check implementation documentation for details on the format.
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Get the number of frames per second the camera tries to deliver.
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
|
virtual |
Get the current height of the image.
Implements firevision::CameraControlImage.
|
virtual |
Return whether the camera image is horizontally mirrored.
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
|
virtual |
Get current lens correction.
[out] | x_corr | where the current lens x correction will be stored |
[out] | y_corr | where the current lens y correction will be stored |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Get current lens x correction.
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Get current lens y correction.
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Get maximum pan value.
Implements firevision::CameraControlPanTilt.
|
virtual |
Get maximum tilt value.
Implements firevision::CameraControlPanTilt.
|
virtual |
Get minimum pan value.
Implements firevision::CameraControlPanTilt.
|
virtual |
Get minimum tilt value.
Implements firevision::CameraControlPanTilt.
|
virtual |
Get information about current camera image mirroring.
[out] | horiz | upon return contains flag if horizontal mirroring is enabled |
[out] | vert | upon return contains flag if vertical mirroring is enabled |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Get pan value.
Implements firevision::CameraControlPanTilt.
|
virtual |
Get pan and tilt at the same time.
This will store the current pan and tilt values in the given arguments.
pan | contains current pan after call |
tilt | contains current tilt after call |
Implements firevision::CameraControlPanTilt.
|
virtual |
Get pan and tilt at the same time in radiant.
This will store the current pan and tilt values in the given arguments.
pan | contains current pan after call |
tilt | contains current tilt after call |
Implements firevision::CameraControlPanTilt.
|
virtual |
Process pan/tilt information.
Some operations allow for asynchronous usage (like fetching pan/tilt data). This is because some cameras need some time to retrieve the information and thus it is a good idea to let that run besides the image processing loop. With process_control the incoming information is processed.
Implements firevision::CameraControlPanTilt.
|
virtual |
Get current red balance.
Implements firevision::CameraControlColor.
|
virtual |
|
virtual |
Bring camera into home position.
After the reset the camera shall look forward (horizontally and vertically centered "home" position).
Implements firevision::CameraControlPanTilt.
|
virtual |
Reset pan/tilt limits.
This removes all limits from the pan/tilt methods thus the only constraints are hardware induced.
Implements firevision::CameraControlPanTilt.
|
virtual |
Reset zoom.
NotImplementedException | Not implemented by this control |
Implements firevision::CameraControlZoom.
|
virtual |
|
virtual |
Enable or disable auto focus.
enabled | if true, enable auto focus, otherwise disable |
NotImplementedException | Not implemented by this control |
Implements firevision::CameraControlFocus.
|
virtual |
Enable/disable auto gain.
enabled | whether auto gain should be enabled |
Implements firevision::CameraControlColor.
|
virtual |
Enable/disable auto white balance.
enabled | whether auto white balance should be enabled |
Implements firevision::CameraControlColor.
|
virtual |
Set blue balance.
blue_balance | new blue balance |
Implements firevision::CameraControlColor.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Enable/disable auto exposure.
enabled | whether auto exposure should be enabled |
Implements firevision::CameraControlColor.
|
virtual |
|
virtual |
Set the image format the camera should use.
Check implementation documentation for details on the format.
format | the new image format |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Set the number of frames per second the camera tries to deliver.
fps | the new fps |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
|
virtual |
Set whether the camera should mirror images horizontally.
enabled | if true, images should be mirrored horizontally |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
|
virtual |
Set lens correction.
x_corr | new lens x correction |
y_corr | new lens y correction |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Set lens x correction.
x_corr | new lens x correction |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Set lens y correction.
y_corr | new lens y correction |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Set whether the camera should mirror images.
horiz | true to mirror images horizontally, false to disable mirroring |
vert | true to mirror images vertically, false to disable mirroring |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Set pan value.
The pan value is dependent on the camera control. See the implementations documentation for details.
pan | new pan value |
Implements firevision::CameraControlPanTilt.
|
virtual |
Set pan and tilt in one go.
Sometimes camera controls have a command for setting pan and tilt at the same time. If possible this should be preferred since is minimizes the number of required operations and communication acts. See the implementations documentation for details.
pan | new pan value |
tilt | new tilt value |
Implements firevision::CameraControlPanTilt.
|
virtual |
Set pan/tilt limits.
Some camera controls allow for extra constraints to the min and max pan/tilt values.
pan_left | new minimum pan limit |
pan_right | new maximum pan limit |
tilt_up | new minimum tilt limit |
tilt_down | new maximum tilt limit |
Implements firevision::CameraControlPanTilt.
|
virtual |
Set pan and tilt as float value.
You give a radiant value where the camera should head relative to the basic camera position. Implementations shall look forward (center the camera) for if pan equals zero, look right if the pan is positive and left is the pan is negative, they shall look forward (vertically centered) if tilt is zero, upwards if tilt is negative and downwards if tilt is positive.
pan | new pan value in radiant |
tilt | new tilt value in radiant |
Implements firevision::CameraControlPanTilt.
|
virtual |
|
virtual |
|
virtual |
Set the image size the camera should use.
width | new width of the image |
height | new height of the image |
Exception | thrown for instance if size setting at run-time is not supported |
Implements firevision::CameraControlImage.
|
virtual |
Set tilt value.
The tilt value is dependent on the camera control. See the implementations documentation for details.
tilt | new tilt value |
Implements firevision::CameraControlPanTilt.
|
virtual |
|
virtual |
|
virtual |
Set whether the camera should mirror images vertically.
enabled | if true, images should be mirrored vertically |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Set new camera-specific zoom value.
zoom | zoom value |
Implements firevision::CameraControlZoom.
|
virtual |
Set if digital zoom may be used.
enabled | true, to enable digital zoom, false otherwise |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlZoom.
|
virtual |
Set speed in tele range.
speed | camera-specific speed value |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlZoom.
|
virtual |
Set speed in wide range.
speed | camera-specific speed value. |
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlZoom.
|
virtual |
Get the current image size.
[out] | width | upon return contains the width of the image |
[out] | height | upon return contains the height of the image |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Start asynchronous fetch operation for pan and tilt values.
This will initiate fetching the pan and tilt values but will not wait until the values have been received but will return immediately (non-blocking).
Implements firevision::CameraControlPanTilt.
|
virtual |
Check if camera control supports desired effect.
Use camera-specific constants.
effect | supported effect |
Implements firevision::CameraControlEffect.
|
virtual |
Check whether this controller supports panning.
Implements firevision::CameraControlPanTilt.
|
virtual |
Check whether this controller supports tilting.
Implements firevision::CameraControlPanTilt.
|
virtual |
Get tilt value.
Implements firevision::CameraControlPanTilt.
|
virtual |
|
virtual |
|
virtual |
Return whether the camera image is vertically mirrored.
NotImplementedException | Not implemented by this control |
Reimplemented from firevision::CameraControlImage.
|
virtual |
Get the current width of the image.
Implements firevision::CameraControlImage.
|
virtual |
|
virtual |
|
virtual |