Fawkes API  Fawkes Development Version
firevision::DummyCameraControl Class Reference

Plain dummy control. More...

#include <>>

Inheritance diagram for firevision::DummyCameraControl:

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...
 
- Public Member Functions inherited from firevision::CameraControlColor
virtual ~CameraControlColor ()
 Empty virtual destructor. More...
 
virtual void set_auto_all (bool enabled)
 Enable/disable all automatic settings. More...
 
- Public Member Functions inherited from firevision::CameraControl
virtual ~CameraControl ()
 Virtual empty destructor. More...
 
- Public Member Functions inherited from firevision::CameraControlImage
virtual ~CameraControlImage ()
 Empty virtual destructor. More...
 
- Public Member Functions inherited from firevision::CameraControlPanTilt
virtual ~CameraControlPanTilt ()
 Empty virtual destructor. More...
 
- Public Member Functions inherited from firevision::CameraControlZoom
virtual ~CameraControlZoom ()
 Empty virtual destructor. More...
 
- Public Member Functions inherited from firevision::CameraControlEffect
virtual ~CameraControlEffect ()
 Empty virtual destructor. More...
 
- Public Member Functions inherited from firevision::CameraControlFocus
virtual ~CameraControlFocus ()
 Empty virtual destructor. More...
 

Additional Inherited Members

- Static Public Attributes inherited from firevision::CameraControlEffect
static const unsigned int EFFECT_NONE = 0
 No effect constant. More...
 

Detailed Description

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.

Author
Tim Niemueller

Definition at line 44 of file dummy.h.

Member Function Documentation

◆ auto_focus()

bool firevision::DummyCameraControl::auto_focus ( )
virtual

Check if auto focus is enabled.

Returns
true, if the camera is in auto focus mode, false otherwise
Exceptions
NotImplementedExceptionNot implemented by this control

Implements firevision::CameraControlFocus.

Definition at line 396 of file dummy.cpp.

◆ auto_gain()

bool firevision::DummyCameraControl::auto_gain ( )
virtual

Return whether auto gain is enabled.

Returns
true if auto gain is enabled

Implements firevision::CameraControlColor.

Definition at line 40 of file dummy.cpp.

◆ auto_white_balance()

bool firevision::DummyCameraControl::auto_white_balance ( )
virtual

Return whether auto white balance is enabled.

Returns
true if auto white balance is enabled

Implements firevision::CameraControlColor.

Definition at line 49 of file dummy.cpp.

◆ blue_balance()

int firevision::DummyCameraControl::blue_balance ( )
virtual

Get current blue balance.

Returns
current blue balance value

Implements firevision::CameraControlColor.

Definition at line 77 of file dummy.cpp.

◆ brightness()

unsigned int firevision::DummyCameraControl::brightness ( )
virtual

Get current brightness.

Returns
current brightness value

Implements firevision::CameraControlColor.

Definition at line 106 of file dummy.cpp.

◆ contrast()

unsigned int firevision::DummyCameraControl::contrast ( )
virtual

Get current contrast.

Returns
current contrast value

Implements firevision::CameraControlColor.

Definition at line 115 of file dummy.cpp.

◆ effect()

unsigned int firevision::DummyCameraControl::effect ( )
virtual

Current effect.

Returns
current effect.

Implements firevision::CameraControlEffect.

Definition at line 387 of file dummy.cpp.

References firevision::CameraControlEffect::EFFECT_NONE.

◆ exposure()

unsigned int firevision::DummyCameraControl::exposure ( )
virtual

Get current exposure.

Returns
current exposure value

Implements firevision::CameraControlColor.

Definition at line 142 of file dummy.cpp.

◆ exposure_auto()

unsigned int firevision::DummyCameraControl::exposure_auto ( )
virtual

Return whether auto exposure is enabled.

Returns
true if auto exposure is enabled

Implements firevision::CameraControlColor.

Definition at line 58 of file dummy.cpp.

◆ focus()

unsigned int firevision::DummyCameraControl::focus ( )
virtual

Get current focus value.

Returns
current focus value.

Implements firevision::CameraControlFocus.

Definition at line 405 of file dummy.cpp.

◆ focus_max()

unsigned int firevision::DummyCameraControl::focus_max ( )
virtual

Get maximum focus value.

Returns
maximum focus value.

Implements firevision::CameraControlFocus.

Definition at line 419 of file dummy.cpp.

◆ focus_min()

unsigned int firevision::DummyCameraControl::focus_min ( )
virtual

Get minimum focus value.

Returns
minimum focus value.

Implements firevision::CameraControlFocus.

Definition at line 414 of file dummy.cpp.

◆ format()

const char * firevision::DummyCameraControl::format ( )
virtual

Get the image format the camera currently uses.

Check implementation documentation for details on the format.

Returns
a string describing the image format
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 161 of file dummy.cpp.

◆ fps()

unsigned int firevision::DummyCameraControl::fps ( )
virtual

Get the number of frames per second the camera tries to deliver.

Returns
the current fps
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 218 of file dummy.cpp.

◆ gain()

unsigned int firevision::DummyCameraControl::gain ( )
virtual

Get current gain.

Returns
current gain value

Implements firevision::CameraControlColor.

Definition at line 151 of file dummy.cpp.

◆ height()

unsigned int firevision::DummyCameraControl::height ( )
virtual

Get the current height of the image.

Returns
height in pixels

Implements firevision::CameraControlImage.

Definition at line 175 of file dummy.cpp.

◆ horiz_mirror()

bool firevision::DummyCameraControl::horiz_mirror ( )
virtual

Return whether the camera image is horizontally mirrored.

Returns
true if the image is horizontally mirrored
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 190 of file dummy.cpp.

◆ hue()

int firevision::DummyCameraControl::hue ( )
virtual

Get current hue.

Returns
current hue value

Implements firevision::CameraControlColor.

Definition at line 133 of file dummy.cpp.

◆ lens_corr()

void firevision::DummyCameraControl::lens_corr ( unsigned int &  x_corr,
unsigned int &  y_corr 
)
virtual

Get current lens correction.

Parameters
[out]x_corrwhere the current lens x correction will be stored
[out]y_corrwhere the current lens y correction will be stored
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 238 of file dummy.cpp.

◆ lens_x_corr()

unsigned int firevision::DummyCameraControl::lens_x_corr ( )
virtual

Get current lens x correction.

Returns
current lens x correction
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 228 of file dummy.cpp.

◆ lens_y_corr()

unsigned int firevision::DummyCameraControl::lens_y_corr ( )
virtual

Get current lens y correction.

Returns
current lens y correction
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 233 of file dummy.cpp.

◆ max_pan()

int firevision::DummyCameraControl::max_pan ( )
virtual

Get maximum pan value.

Returns
maximum camera-specific pan value

Implements firevision::CameraControlPanTilt.

Definition at line 315 of file dummy.cpp.

◆ max_tilt()

int firevision::DummyCameraControl::max_tilt ( )
virtual

Get maximum tilt value.

Returns
maximum camera-specific tilt value

Implements firevision::CameraControlPanTilt.

Definition at line 325 of file dummy.cpp.

◆ min_pan()

int firevision::DummyCameraControl::min_pan ( )
virtual

Get minimum pan value.

Returns
minimum camera-specific pan value

Implements firevision::CameraControlPanTilt.

Definition at line 310 of file dummy.cpp.

◆ min_tilt()

int firevision::DummyCameraControl::min_tilt ( )
virtual

Get minimum tilt value.

Returns
minimum camera-specific tilt value

Implements firevision::CameraControlPanTilt.

Definition at line 320 of file dummy.cpp.

◆ mirror()

void firevision::DummyCameraControl::mirror ( bool &  horiz,
bool &  vert 
)
virtual

Get information about current camera image mirroring.

Parameters
[out]horizupon return contains flag if horizontal mirroring is enabled
[out]vertupon return contains flag if vertical mirroring is enabled
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 200 of file dummy.cpp.

◆ pan()

int firevision::DummyCameraControl::pan ( )
virtual

Get pan value.

Returns
camera control specific pan value

Implements firevision::CameraControlPanTilt.

Definition at line 286 of file dummy.cpp.

◆ pan_tilt()

void firevision::DummyCameraControl::pan_tilt ( int &  pan,
int &  tilt 
)
virtual

Get pan and tilt at the same time.

This will store the current pan and tilt values in the given arguments.

Parameters
pancontains current pan after call
tiltcontains current tilt after call

Implements firevision::CameraControlPanTilt.

Definition at line 300 of file dummy.cpp.

◆ pan_tilt_rad()

void firevision::DummyCameraControl::pan_tilt_rad ( float &  pan,
float &  tilt 
)
virtual

Get pan and tilt at the same time in radiant.

This will store the current pan and tilt values in the given arguments.

Parameters
pancontains current pan after call
tiltcontains current tilt after call
See also
set_pan_tilt_rad()

Implements firevision::CameraControlPanTilt.

Definition at line 305 of file dummy.cpp.

◆ process_pantilt()

void firevision::DummyCameraControl::process_pantilt ( )
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.

Definition at line 255 of file dummy.cpp.

◆ red_balance()

int firevision::DummyCameraControl::red_balance ( )
virtual

Get current red balance.

Returns
current red balance value

Implements firevision::CameraControlColor.

Definition at line 68 of file dummy.cpp.

◆ reset_effect()

void firevision::DummyCameraControl::reset_effect ( )
virtual

Reset effect.

Disable all effects.

Implements firevision::CameraControlEffect.

Definition at line 392 of file dummy.cpp.

◆ reset_pan_tilt()

void firevision::DummyCameraControl::reset_pan_tilt ( )
virtual

Bring camera into home position.

After the reset the camera shall look forward (horizontally and vertically centered "home" position).

Implements firevision::CameraControlPanTilt.

Definition at line 330 of file dummy.cpp.

◆ reset_pan_tilt_limit()

void firevision::DummyCameraControl::reset_pan_tilt_limit ( )
virtual

Reset pan/tilt limits.

This removes all limits from the pan/tilt methods thus the only constraints are hardware induced.

Implements firevision::CameraControlPanTilt.

Definition at line 339 of file dummy.cpp.

◆ reset_zoom()

void firevision::DummyCameraControl::reset_zoom ( )
virtual

Reset zoom.

Exceptions
NotImplementedExceptionNot implemented by this control

Implements firevision::CameraControlZoom.

Definition at line 343 of file dummy.cpp.

◆ saturation()

unsigned int firevision::DummyCameraControl::saturation ( )
virtual

Get current saturation.

Returns
current saturation value

Implements firevision::CameraControlColor.

Definition at line 124 of file dummy.cpp.

◆ set_auto_focus()

void firevision::DummyCameraControl::set_auto_focus ( bool  enabled)
virtual

Enable or disable auto focus.

Parameters
enabledif true, enable auto focus, otherwise disable
Exceptions
NotImplementedExceptionNot implemented by this control

Implements firevision::CameraControlFocus.

Definition at line 401 of file dummy.cpp.

◆ set_auto_gain()

void firevision::DummyCameraControl::set_auto_gain ( bool  enabled)
virtual

Enable/disable auto gain.

Parameters
enabledwhether auto gain should be enabled

Implements firevision::CameraControlColor.

Definition at line 45 of file dummy.cpp.

◆ set_auto_white_balance()

void firevision::DummyCameraControl::set_auto_white_balance ( bool  enabled)
virtual

Enable/disable auto white balance.

Parameters
enabledwhether auto white balance should be enabled

Implements firevision::CameraControlColor.

Definition at line 54 of file dummy.cpp.

◆ set_blue_balance()

void firevision::DummyCameraControl::set_blue_balance ( int  blue_balance)
virtual

Set blue balance.

Parameters
blue_balancenew blue balance

Implements firevision::CameraControlColor.

Definition at line 82 of file dummy.cpp.

◆ set_brightness()

void firevision::DummyCameraControl::set_brightness ( unsigned int  brightness)
virtual

Set new brightness.

Parameters
brightnessnew brightness

Implements firevision::CameraControlColor.

Definition at line 111 of file dummy.cpp.

◆ set_contrast()

void firevision::DummyCameraControl::set_contrast ( unsigned int  contrast)
virtual

Set new contrast.

Parameters
contrastnew contrast

Implements firevision::CameraControlColor.

Definition at line 120 of file dummy.cpp.

◆ set_effect()

void firevision::DummyCameraControl::set_effect ( unsigned int  effect)
virtual

Enable effect.

Parameters
effectcamera-specific effect.

Implements firevision::CameraControlEffect.

Definition at line 383 of file dummy.cpp.

◆ set_exposure()

void firevision::DummyCameraControl::set_exposure ( unsigned int  exposure)
virtual

Set new exposure.

Parameters
exposurenew exposure

Implements firevision::CameraControlColor.

Definition at line 147 of file dummy.cpp.

◆ set_exposure_auto()

void firevision::DummyCameraControl::set_exposure_auto ( unsigned int  enabled)
virtual

Enable/disable auto exposure.

Parameters
enabledwhether auto exposure should be enabled

Implements firevision::CameraControlColor.

Definition at line 63 of file dummy.cpp.

◆ set_focus()

void firevision::DummyCameraControl::set_focus ( unsigned int  focus)
virtual

Set new focus value.

Parameters
focusnew focus value

Implements firevision::CameraControlFocus.

Definition at line 410 of file dummy.cpp.

◆ set_format()

void firevision::DummyCameraControl::set_format ( const char *  format)
virtual

Set the image format the camera should use.

Check implementation documentation for details on the format.

Parameters
formatthe new image format
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 166 of file dummy.cpp.

◆ set_fps()

void firevision::DummyCameraControl::set_fps ( unsigned int  fps)
virtual

Set the number of frames per second the camera tries to deliver.

Parameters
fpsthe new fps
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 223 of file dummy.cpp.

◆ set_gain()

void firevision::DummyCameraControl::set_gain ( unsigned int  gain)
virtual

Set new gain.

Parameters
gainnew gain

Implements firevision::CameraControlColor.

Definition at line 156 of file dummy.cpp.

◆ set_horiz_mirror()

void firevision::DummyCameraControl::set_horiz_mirror ( bool  enabled)
virtual

Set whether the camera should mirror images horizontally.

Parameters
enabledif true, images should be mirrored horizontally
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 205 of file dummy.cpp.

◆ set_hue()

void firevision::DummyCameraControl::set_hue ( int  hue)
virtual

Set new hue.

Parameters
huenew hue

Implements firevision::CameraControlColor.

Definition at line 138 of file dummy.cpp.

◆ set_lens_corr()

void firevision::DummyCameraControl::set_lens_corr ( unsigned int  x_corr,
unsigned int  y_corr 
)
virtual

Set lens correction.

Parameters
x_corrnew lens x correction
y_corrnew lens y correction
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 251 of file dummy.cpp.

◆ set_lens_x_corr()

void firevision::DummyCameraControl::set_lens_x_corr ( unsigned int  x_corr)
virtual

Set lens x correction.

Parameters
x_corrnew lens x correction
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 243 of file dummy.cpp.

◆ set_lens_y_corr()

void firevision::DummyCameraControl::set_lens_y_corr ( unsigned int  y_corr)
virtual

Set lens y correction.

Parameters
y_corrnew lens y correction
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 247 of file dummy.cpp.

◆ set_mirror()

void firevision::DummyCameraControl::set_mirror ( bool  horiz,
bool  vert 
)
virtual

Set whether the camera should mirror images.

Parameters
horiztrue to mirror images horizontally, false to disable mirroring
verttrue to mirror images vertically, false to disable mirroring
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 213 of file dummy.cpp.

◆ set_pan()

void firevision::DummyCameraControl::set_pan ( int  pan)
virtual

Set pan value.

The pan value is dependent on the camera control. See the implementations documentation for details.

Parameters
pannew pan value

Implements firevision::CameraControlPanTilt.

Definition at line 270 of file dummy.cpp.

◆ set_pan_tilt()

void firevision::DummyCameraControl::set_pan_tilt ( int  pan,
int  tilt 
)
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.

Parameters
pannew pan value
tiltnew tilt value

Implements firevision::CameraControlPanTilt.

Definition at line 278 of file dummy.cpp.

◆ set_pan_tilt_limit()

void firevision::DummyCameraControl::set_pan_tilt_limit ( int  pan_left,
int  pan_right,
int  tilt_up,
int  tilt_down 
)
virtual

Set pan/tilt limits.

Some camera controls allow for extra constraints to the min and max pan/tilt values.

Parameters
pan_leftnew minimum pan limit
pan_rightnew maximum pan limit
tilt_upnew minimum tilt limit
tilt_downnew maximum tilt limit

Implements firevision::CameraControlPanTilt.

Definition at line 334 of file dummy.cpp.

◆ set_pan_tilt_rad()

void firevision::DummyCameraControl::set_pan_tilt_rad ( float  pan,
float  tilt 
)
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.

Parameters
pannew pan value in radiant
tiltnew tilt value in radiant

Implements firevision::CameraControlPanTilt.

Definition at line 282 of file dummy.cpp.

◆ set_red_balance()

void firevision::DummyCameraControl::set_red_balance ( int  red_balance)
virtual

Set red balance.

Parameters
red_balancenew red balance

Implements firevision::CameraControlColor.

Definition at line 73 of file dummy.cpp.

◆ set_saturation()

void firevision::DummyCameraControl::set_saturation ( unsigned int  saturation)
virtual

Set new saturation.

Parameters
saturationnew saturation

Implements firevision::CameraControlColor.

Definition at line 129 of file dummy.cpp.

◆ set_size()

void firevision::DummyCameraControl::set_size ( unsigned int  width,
unsigned int  height 
)
virtual

Set the image size the camera should use.

Parameters
widthnew width of the image
heightnew height of the image
Exceptions
Exceptionthrown for instance if size setting at run-time is not supported

Implements firevision::CameraControlImage.

Definition at line 185 of file dummy.cpp.

◆ set_tilt()

void firevision::DummyCameraControl::set_tilt ( int  tilt)
virtual

Set tilt value.

The tilt value is dependent on the camera control. See the implementations documentation for details.

Parameters
tiltnew tilt value

Implements firevision::CameraControlPanTilt.

Definition at line 274 of file dummy.cpp.

◆ set_u_balance()

void firevision::DummyCameraControl::set_u_balance ( int  u_balance)
virtual

Set u balance.

Parameters
u_balancenew u balance

Implements firevision::CameraControlColor.

Definition at line 92 of file dummy.cpp.

◆ set_v_balance()

void firevision::DummyCameraControl::set_v_balance ( int  v_balance)
virtual

Set v balance.

Parameters
v_balancenew v balance

Implements firevision::CameraControlColor.

Definition at line 101 of file dummy.cpp.

◆ set_vert_mirror()

void firevision::DummyCameraControl::set_vert_mirror ( bool  enabled)
virtual

Set whether the camera should mirror images vertically.

Parameters
enabledif true, images should be mirrored vertically
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 209 of file dummy.cpp.

◆ set_zoom()

void firevision::DummyCameraControl::set_zoom ( unsigned int  zoom)
virtual

Set new camera-specific zoom value.

Parameters
zoomzoom value

Implements firevision::CameraControlZoom.

Definition at line 347 of file dummy.cpp.

◆ set_zoom_digital_enabled()

void firevision::DummyCameraControl::set_zoom_digital_enabled ( bool  enabled)
virtual

Set if digital zoom may be used.

Parameters
enabledtrue, to enable digital zoom, false otherwise
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlZoom.

Definition at line 374 of file dummy.cpp.

◆ set_zoom_speed_tele()

void firevision::DummyCameraControl::set_zoom_speed_tele ( unsigned int  speed)
virtual

Set speed in tele range.

Parameters
speedcamera-specific speed value
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlZoom.

Definition at line 366 of file dummy.cpp.

◆ set_zoom_speed_wide()

void firevision::DummyCameraControl::set_zoom_speed_wide ( unsigned int  speed)
virtual

Set speed in wide range.

Parameters
speedcamera-specific speed value.
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlZoom.

Definition at line 370 of file dummy.cpp.

◆ size()

void firevision::DummyCameraControl::size ( unsigned int &  width,
unsigned int &  height 
)
virtual

Get the current image size.

Parameters
[out]widthupon return contains the width of the image
[out]heightupon return contains the height of the image

Reimplemented from firevision::CameraControlImage.

Definition at line 180 of file dummy.cpp.

◆ start_get_pan_tilt()

void firevision::DummyCameraControl::start_get_pan_tilt ( )
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.

Definition at line 296 of file dummy.cpp.

◆ supports_effect()

bool firevision::DummyCameraControl::supports_effect ( unsigned int  effect)
virtual

Check if camera control supports desired effect.

Use camera-specific constants.

Parameters
effectsupported effect
Returns
true, if effect is supported, false otherwise

Implements firevision::CameraControlEffect.

Definition at line 378 of file dummy.cpp.

◆ supports_pan()

bool firevision::DummyCameraControl::supports_pan ( )
virtual

Check whether this controller supports panning.

Returns
true if panning is supported

Implements firevision::CameraControlPanTilt.

Definition at line 260 of file dummy.cpp.

◆ supports_tilt()

bool firevision::DummyCameraControl::supports_tilt ( )
virtual

Check whether this controller supports tilting.

Returns
true if tilting is supported

Implements firevision::CameraControlPanTilt.

Definition at line 265 of file dummy.cpp.

◆ tilt()

int firevision::DummyCameraControl::tilt ( )
virtual

Get tilt value.

Returns
camera control specific tilt value

Implements firevision::CameraControlPanTilt.

Definition at line 291 of file dummy.cpp.

◆ u_balance()

int firevision::DummyCameraControl::u_balance ( )
virtual

Get current u balance.

Returns
current u balance value

Implements firevision::CameraControlColor.

Definition at line 87 of file dummy.cpp.

◆ v_balance()

int firevision::DummyCameraControl::v_balance ( )
virtual

Get current v balance.

Returns
current v balance value

Implements firevision::CameraControlColor.

Definition at line 96 of file dummy.cpp.

◆ vert_mirror()

bool firevision::DummyCameraControl::vert_mirror ( )
virtual

Return whether the camera image is vertically mirrored.

Returns
true if the image is vertically mirrored
Exceptions
NotImplementedExceptionNot implemented by this control

Reimplemented from firevision::CameraControlImage.

Definition at line 195 of file dummy.cpp.

◆ width()

unsigned int firevision::DummyCameraControl::width ( )
virtual

Get the current width of the image.

Returns
width in pixels

Implements firevision::CameraControlImage.

Definition at line 170 of file dummy.cpp.

◆ zoom()

unsigned int firevision::DummyCameraControl::zoom ( )
virtual

Get current zoom value.

Returns
current zoom value.

Implements firevision::CameraControlZoom.

Definition at line 351 of file dummy.cpp.

◆ zoom_max()

unsigned int firevision::DummyCameraControl::zoom_max ( )
virtual

Maximum zoom value.

Returns
maximum zoom value

Implements firevision::CameraControlZoom.

Definition at line 356 of file dummy.cpp.

◆ zoom_min()

unsigned int firevision::DummyCameraControl::zoom_min ( )
virtual

Minimum zoom value.

Returns
Minimum zoom value

Implements firevision::CameraControlZoom.

Definition at line 361 of file dummy.cpp.


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