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 ()
 
virtual void set_auto_gain (bool enabled)
 
virtual bool auto_white_balance ()
 
virtual void set_auto_white_balance (bool enabled)
 
virtual unsigned int exposure_auto ()
 
virtual void set_exposure_auto (unsigned int enabled)
 
virtual int red_balance ()
 
virtual void set_red_balance (int red_balance)
 
virtual int blue_balance ()
 
virtual void set_blue_balance (int blue_balance)
 
virtual int u_balance ()
 
virtual void set_u_balance (int u_balance)
 
virtual int v_balance ()
 
virtual void set_v_balance (int v_balance)
 
virtual unsigned int brightness ()
 
virtual void set_brightness (unsigned int brightness)
 
virtual unsigned int contrast ()
 
virtual void set_contrast (unsigned int contrast)
 
virtual unsigned int saturation ()
 
virtual void set_saturation (unsigned int saturation)
 
virtual int hue ()
 
virtual void set_hue (int hue)
 
virtual unsigned int exposure ()
 
virtual void set_exposure (unsigned int exposure)
 
virtual unsigned int gain ()
 
virtual void set_gain (unsigned int gain)
 
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 ()
 
virtual unsigned int height ()
 
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)
 
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 ()
 
virtual bool supports_pan ()
 
virtual bool supports_tilt ()
 
virtual void set_pan (int pan)
 
virtual void set_tilt (int tilt)
 
virtual void set_pan_tilt (int pan, int tilt)
 
virtual void set_pan_tilt_rad (float pan, float tilt)
 
virtual int pan ()
 
virtual int tilt ()
 
virtual void start_get_pan_tilt ()
 
virtual void pan_tilt (int &pan, int &tilt)
 
virtual void pan_tilt_rad (float &pan, float &tilt)
 
virtual int min_pan ()
 
virtual int max_pan ()
 
virtual int min_tilt ()
 
virtual int max_tilt ()
 
virtual void reset_pan_tilt ()
 
virtual void set_pan_tilt_limit (int pan_left, int pan_right, int tilt_up, int tilt_down)
 
virtual void reset_pan_tilt_limit ()
 
virtual void reset_zoom ()
 
virtual void set_zoom (unsigned int zoom)
 
virtual unsigned int zoom ()
 
virtual unsigned int zoom_max ()
 
virtual unsigned int zoom_min ()
 
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)
 
virtual void set_effect (unsigned int effect)
 
virtual unsigned int effect ()
 
virtual void reset_effect ()
 
virtual bool auto_focus ()
 
virtual void set_auto_focus (bool enabled)
 
virtual unsigned int focus ()
 
virtual void set_focus (unsigned int focus)
 
virtual unsigned int focus_min ()
 
virtual unsigned int focus_max ()
 
- 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.

Does nothing, supports nothing. Use to avoid unecessary NULL checks

Dummy camera control. 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 47 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 469 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 44 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 55 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 88 of file dummy.cpp.

◆ brightness()

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

Get current brightness.

Returns
current brightness value

Implements firevision::CameraControlColor.

Definition at line 121 of file dummy.cpp.

◆ contrast()

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

Get current contrast.

Returns
current contrast value

Implements firevision::CameraControlColor.

Definition at line 132 of file dummy.cpp.

◆ effect()

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

Current effect.

Returns
current effect.

Implements firevision::CameraControlEffect.

Definition at line 458 of file dummy.cpp.

◆ exposure()

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

Get current exposure

Returns
current exposure value

Implements firevision::CameraControlColor.

Definition at line 165 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 66 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 480 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 497 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 491 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 188 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 255 of file dummy.cpp.

◆ gain()

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

Get current gain.

Returns
current gain value

Implements firevision::CameraControlColor.

Definition at line 176 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 205 of file dummy.cpp.

References width().

◆ 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 222 of file dummy.cpp.

◆ hue()

int firevision::DummyCameraControl::hue ( )
virtual

Get current hue.

Returns
current hue value

Implements firevision::CameraControlColor.

Definition at line 154 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 278 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 266 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 272 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 371 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 383 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 365 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 377 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 234 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 336 of file dummy.cpp.

Referenced by pan_tilt(), and start_get_pan_tilt().

◆ 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 353 of file dummy.cpp.

References pan(), and tilt().

◆ 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 359 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 299 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 77 of file dummy.cpp.

◆ reset_effect()

void firevision::DummyCameraControl::reset_effect ( )
virtual

Reset effect. Disable all effects.

Implements firevision::CameraControlEffect.

Definition at line 464 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 389 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 399 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 404 of file dummy.cpp.

◆ saturation()

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

Get current saturation.

Returns
current saturation value

Implements firevision::CameraControlColor.

Definition at line 143 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 475 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 50 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 61 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 94 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 127 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 138 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 453 of file dummy.cpp.

References firevision::CameraControlEffect::EFFECT_NONE.

◆ set_exposure()

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

Set new exposure.

Parameters
exposurenew exposure

Implements firevision::CameraControlColor.

Definition at line 171 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 72 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 486 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 194 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 261 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 182 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 240 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 160 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 294 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 284 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 289 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 250 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 316 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 326 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 394 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 331 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 83 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 149 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 217 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 321 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 105 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 116 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 245 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 409 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 442 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 432 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 437 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 211 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 348 of file dummy.cpp.

References pan(), and tilt().

◆ 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 447 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 304 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 310 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 342 of file dummy.cpp.

Referenced by pan_tilt(), and start_get_pan_tilt().

◆ u_balance()

int firevision::DummyCameraControl::u_balance ( )
virtual

Get current u balance.

Returns
current u balance value

Implements firevision::CameraControlColor.

Definition at line 99 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 110 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 228 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 199 of file dummy.cpp.

Referenced by height().

◆ zoom()

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

Get current zoom value.

Returns
current zoom value.

Implements firevision::CameraControlZoom.

Definition at line 414 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 420 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 426 of file dummy.cpp.


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