Fawkes API  Fawkes Development Version
firevision::CameraControlColor Class Referenceabstract

Camera color control interface. More...

#include <>>

Inheritance diagram for firevision::CameraControlColor:

Public Member Functions

virtual ~CameraControlColor ()
 Empty virtual destructor. More...
 
virtual bool auto_gain ()=0
 Return whether auto gain is enabled. More...
 
virtual void set_auto_gain (bool enabled)=0
 Enable/disable auto gain. More...
 
virtual bool auto_white_balance ()=0
 Return whether auto white balance is enabled. More...
 
virtual void set_auto_white_balance (bool enabled)=0
 Enable/disable auto white balance. More...
 
virtual unsigned int exposure_auto ()=0
 Return whether auto exposure is enabled. More...
 
virtual void set_exposure_auto (unsigned int enabled)=0
 Enable/disable auto exposure. More...
 
virtual void set_auto_all (bool enabled)
 Enable/disable all automatic settings. More...
 
virtual int red_balance ()=0
 Get current red balance. More...
 
virtual void set_red_balance (int red_balance)=0
 Set red balance. More...
 
virtual int blue_balance ()=0
 Get current blue balance. More...
 
virtual void set_blue_balance (int blue_balance)=0
 Set blue balance. More...
 
virtual int u_balance ()=0
 Get current u balance. More...
 
virtual void set_u_balance (int u_balance)=0
 Set u balance. More...
 
virtual int v_balance ()=0
 Get current v balance. More...
 
virtual void set_v_balance (int v_balance)=0
 Set v balance. More...
 
virtual unsigned int brightness ()=0
 Get current brightness. More...
 
virtual void set_brightness (unsigned int brightness)=0
 Set new brightness. More...
 
virtual unsigned int contrast ()=0
 Get current contrast. More...
 
virtual void set_contrast (unsigned int contrast)=0
 Set new contrast. More...
 
virtual unsigned int saturation ()=0
 Get current saturation. More...
 
virtual void set_saturation (unsigned int saturation)=0
 Set new saturation. More...
 
virtual int hue ()=0
 Get current hue. More...
 
virtual void set_hue (int hue)=0
 Set new hue. More...
 
virtual unsigned int exposure ()=0
 Get current exposure. More...
 
virtual void set_exposure (unsigned int exposure)=0
 Set new exposure. More...
 
virtual unsigned int gain ()=0
 Get current gain. More...
 
virtual void set_gain (unsigned int gain)=0
 Set new gain. More...
 
- Public Member Functions inherited from firevision::CameraControl
virtual ~CameraControl ()
 Virtual empty destructor. More...
 

Detailed Description

Camera color control interface.

Some cameras feature adjustable color controls like white balance, brightness etc. In general methods might throw an NotImplementedException if a particular method if not available.

This interface shall be implemented by such cameras.

Author
Tobias Kellner
Tim Niemueller

Definition at line 35 of file color.h.

Constructor & Destructor Documentation

◆ ~CameraControlColor()

firevision::CameraControlColor::~CameraControlColor ( )
virtual

Empty virtual destructor.

Definition at line 155 of file color.cpp.

Member Function Documentation

◆ auto_gain()

bool firevision::CameraControlColor::auto_gain ( )
pure virtual

Return whether auto gain is enabled.

Returns
true if auto gain is enabled

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ auto_white_balance()

bool firevision::CameraControlColor::auto_white_balance ( )
pure virtual

Return whether auto white balance is enabled.

Returns
true if auto white balance is enabled

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ blue_balance()

int firevision::CameraControlColor::blue_balance ( )
pure virtual

Get current blue balance.

Returns
current blue balance value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ brightness()

unsigned int firevision::CameraControlColor::brightness ( )
pure virtual

Get current brightness.

Returns
current brightness value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ contrast()

unsigned int firevision::CameraControlColor::contrast ( )
pure virtual

Get current contrast.

Returns
current contrast value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ exposure()

unsigned int firevision::CameraControlColor::exposure ( )
pure virtual

Get current exposure.

Returns
current exposure value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ exposure_auto()

bool firevision::CameraControlColor::exposure_auto ( )
pure virtual

Return whether auto exposure is enabled.

Returns
true if auto exposure is enabled

Implemented in firevision::V4L2Camera, firevision::DummyCameraControl, and firevision::NaoCamera.

◆ gain()

unsigned int firevision::CameraControlColor::gain ( )
pure virtual

Get current gain.

Returns
current gain value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ hue()

int firevision::CameraControlColor::hue ( )
pure virtual

Get current hue.

Returns
current hue value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ red_balance()

int firevision::CameraControlColor::red_balance ( )
pure virtual

Get current red balance.

Returns
current red balance value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ saturation()

unsigned int firevision::CameraControlColor::saturation ( )
pure virtual

Get current saturation.

Returns
current saturation value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_auto_all()

void firevision::CameraControlColor::set_auto_all ( bool  enabled)
virtual

Enable/disable all automatic settings.

Most of the time, you'll want to disable all of them.

Parameters
enabledwhether the automatic settings should be enabled or disabled

Definition at line 165 of file color.cpp.

References set_auto_gain(), set_auto_white_balance(), and set_exposure_auto().

◆ set_auto_gain()

void firevision::CameraControlColor::set_auto_gain ( bool  enabled)
pure virtual

Enable/disable auto gain.

Parameters
enabledwhether auto gain should be enabled

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

Referenced by set_auto_all().

◆ set_auto_white_balance()

void firevision::CameraControlColor::set_auto_white_balance ( bool  enabled)
pure virtual

Enable/disable auto white balance.

Parameters
enabledwhether auto white balance should be enabled

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

Referenced by set_auto_all().

◆ set_blue_balance()

void firevision::CameraControlColor::set_blue_balance ( int  blue_balance)
pure virtual

Set blue balance.

Parameters
blue_balancenew blue balance

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_brightness()

void firevision::CameraControlColor::set_brightness ( unsigned int  brightness)
pure virtual

Set new brightness.

Parameters
brightnessnew brightness

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_contrast()

void firevision::CameraControlColor::set_contrast ( unsigned int  contrast)
pure virtual

Set new contrast.

Parameters
contrastnew contrast

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_exposure()

void firevision::CameraControlColor::set_exposure ( unsigned int  exposure)
pure virtual

Set new exposure.

Parameters
exposurenew exposure

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_exposure_auto()

void firevision::CameraControlColor::set_exposure_auto ( unsigned int  enabled)
pure virtual

Enable/disable auto exposure.

Parameters
enabledwhether auto exposure should be enabled

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

Referenced by set_auto_all().

◆ set_gain()

void firevision::CameraControlColor::set_gain ( unsigned int  gain)
pure virtual

Set new gain.

Parameters
gainnew gain

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_hue()

void firevision::CameraControlColor::set_hue ( int  hue)
pure virtual

Set new hue.

Parameters
huenew hue

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_red_balance()

int firevision::CameraControlColor::set_red_balance ( int  red_balance)
pure virtual

Set red balance.

Parameters
red_balancenew red balance

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_saturation()

void firevision::CameraControlColor::set_saturation ( unsigned int  saturation)
pure virtual

Set new saturation.

Parameters
saturationnew saturation

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_u_balance()

void firevision::CameraControlColor::set_u_balance ( int  u_balance)
pure virtual

Set u balance.

Parameters
u_balancenew u balance

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ set_v_balance()

void firevision::CameraControlColor::set_v_balance ( int  v_balance)
pure virtual

Set v balance.

Parameters
v_balancenew v balance

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ u_balance()

int firevision::CameraControlColor::u_balance ( )
pure virtual

Get current u balance.

Returns
current u balance value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.

◆ v_balance()

int firevision::CameraControlColor::v_balance ( )
pure virtual

Get current v balance.

Returns
current v balance value

Implemented in firevision::V4L2Camera, and firevision::DummyCameraControl.


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