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