Fawkes API  Fawkes Development Version
firevision::CameraControlEffect Class Referenceabstract

Camera effect control interface. More...

#include <>>

Inheritance diagram for firevision::CameraControlEffect:

Public Member Functions

virtual ~CameraControlEffect ()
 Empty virtual destructor. More...
 
virtual bool supports_effect (unsigned int effect)=0
 Check if camera control supports desired effect. More...
 
virtual void set_effect (unsigned int effect)=0
 Enable effect. More...
 
virtual unsigned int effect ()=0
 Current effect. More...
 
virtual void reset_effect ()=0
 Reset effect. More...
 
- Public Member Functions inherited from firevision::CameraControl
virtual ~CameraControl ()
 Virtual empty destructor. More...
 

Static Public Attributes

static const unsigned int EFFECT_NONE = 0
 No effect constant. More...
 

Detailed Description

Camera effect control interface.

Some cameras feature camera effects.

This interface shall be implemented by such cameras.

Author
Tim Niemueller
Tobias Kellner

Definition at line 35 of file effect.h.

Constructor & Destructor Documentation

◆ ~CameraControlEffect()

firevision::CameraControlEffect::~CameraControlEffect ( )
virtual

Empty virtual destructor.

Definition at line 68 of file effect.cpp.

Member Function Documentation

◆ effect()

unsigned int firevision::CameraControlEffect::effect ( )
pure virtual

Current effect.

Returns
current effect.

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

◆ reset_effect()

void firevision::CameraControlEffect::reset_effect ( )
pure virtual

Reset effect.

Disable all effects.

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

◆ set_effect()

void firevision::CameraControlEffect::set_effect ( unsigned int  effect)
pure virtual

Enable effect.

Parameters
effectcamera-specific effect.

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

◆ supports_effect()

bool firevision::CameraControlEffect::supports_effect ( unsigned int  effect)
pure virtual

Check if camera control supports desired effect.

Use camera-specific constants.

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

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

Member Data Documentation

◆ EFFECT_NONE

const unsigned int firevision::CameraControlEffect::EFFECT_NONE = 0
static

No effect constant.

This is the only effect constant defined in the interface. All others that may exist are specific for each camera control implementation.

Definition at line 38 of file effect.h.

Referenced by firevision::DummyCameraControl::effect().


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