Fawkes API  Fawkes Development Version
effect.cpp
1 
2 /***************************************************************************
3  * effect.cpp - 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 #include <fvcams/control/effect.h>
26 
27 namespace firevision {
28 #if 0 /* just to make Emacs auto-indent happy */
29 }
30 #endif
31 
32 /** @class CameraControlEffect <fvcams/control/effect.h>
33  * Camera effect control interface.
34  * Some cameras feature camera effects.
35  *
36  * This interface shall be implemented by such cameras.
37  *
38  * @author Tim Niemueller
39  * @author Tobias Kellner
40  *
41  * @fn bool CameraControlEffect::supports_effect(unsigned int effect) = 0
42  * Check if camera control supports desired effect.
43  * Use camera-specific constants.
44  * @param effect supported effect
45  * @return true, if effect is supported, false otherwise
46  *
47  * @fn void CameraControlEffect::set_effect(unsigned int effect) = 0
48  * Enable effect.
49  * @param effect camera-specific effect.
50  *
51  * @fn unsigned int CameraControlEffect::effect() = 0
52  * Current effect.
53  * @return current effect.
54  *
55  * @fn void CameraControlEffect::reset_effect() = 0
56  * Reset effect.
57  * Disable all effects.
58  */
59 
60 /** No effect constant.
61  * This is the only effect constant defined in the interface. All others that
62  * may exist are specific for each camera control implementation.
63  */
64 const unsigned int CameraControlEffect::EFFECT_NONE = 0;
65 
66 
67 /** Empty virtual destructor. */
69 {
70 }
71 
72 } // end namespace firevision
virtual ~CameraControlEffect()
Empty virtual destructor.
Definition: effect.cpp:68
static const unsigned int EFFECT_NONE
No effect constant.
Definition: effect.h:38