Fawkes API  Fawkes Development Version
effect.h
1 
2 /***************************************************************************
3  * effect.h - Abstract class defining a camera effect controller
4  *
5  * Created: Wed Apr 22 11:01:18 2009
6  * Copyright 2009 Tobias Kellner
7  * 2005-2009 Tim Niemueller [www.niemueller.de]
8  *
9  ****************************************************************************/
10 
11 /* This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version. A runtime exception applies to
15  * this software (see LICENSE.GPL_WRE file mentioned below for details).
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU Library General Public License for more details.
21  *
22  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
23  */
24 
25 #ifndef _FIREVISION_CAMS_CONTROL_EFFECT_H_
26 #define _FIREVISION_CAMS_CONTROL_EFFECT_H_
27 
28 #include <fvcams/control/control.h>
29 
30 namespace firevision {
31 
32 class CameraControlEffect : virtual public CameraControl
33 {
34 public:
35  static const unsigned int EFFECT_NONE;
36 
37  virtual ~CameraControlEffect();
38 
39  virtual bool supports_effect(unsigned int effect) = 0;
40  virtual void set_effect(unsigned int effect) = 0;
41  virtual unsigned int effect() = 0;
42  virtual void reset_effect() = 0;
43 };
44 
45 } // end namespace firevision
46 
47 #endif // FIREVISION_CAMS_CONTROL_EFFECT_H__
firevision::CameraControl
Camera control interface base class.
Definition: control.h:31
firevision::CameraControlEffect::supports_effect
virtual bool supports_effect(unsigned int effect)=0
Check if camera control supports desired effect.
firevision::CameraControlEffect::effect
virtual unsigned int effect()=0
Current effect.
firevision::CameraControlEffect
Camera effect control interface.
Definition: effect.h:33
firevision::CameraControlEffect::EFFECT_NONE
static const unsigned int EFFECT_NONE
No effect constant.
Definition: effect.h:35
firevision::CameraControlEffect::set_effect
virtual void set_effect(unsigned int effect)=0
Enable effect.
firevision::CameraControlEffect::~CameraControlEffect
virtual ~CameraControlEffect()
Empty virtual destructor.
Definition: effect.cpp:64
firevision::CameraControlEffect::reset_effect
virtual void reset_effect()=0
Reset effect.