CameraControlEffect Class Reference

Camera effect control interface. More...

#include <cams/control/effect.h>

Inheritance diagram for CameraControlEffect:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual ~CameraControlEffect ()
 Empty virtual destructor.
virtual bool supports_effect (unsigned int effect)=0
 Check if camera control supports desired effect.
virtual void set_effect (unsigned int effect)=0
 Enable effect.
virtual unsigned int effect ()=0
 Current effect.
virtual void reset_effect ()=0
 Reset effect.

Static Public Attributes

static const unsigned int EFFECT_NONE = 0
 No effect constant.

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 30 of file effect.h.

Constructor & Destructor Documentation

CameraControlEffect::~CameraControlEffect (  )  [virtual]

Empty virtual destructor.

Definition at line 63 of file effect.cpp.

Member Function Documentation

unsigned int CameraControlEffect::effect (  )  [pure virtual]

Current effect.

Returns:
current effect.

Implemented in DummyCameraControl, and SonyEviD100PControl.

void CameraControlEffect::reset_effect (  )  [pure virtual]

Reset effect.

Disable all effects.

Implemented in DummyCameraControl, and SonyEviD100PControl.

void CameraControlEffect::set_effect ( unsigned int  effect  )  [pure virtual]

Enable effect.

Parameters:
effect camera-specific effect.

Implemented in DummyCameraControl, and SonyEviD100PControl.

bool CameraControlEffect::supports_effect ( unsigned int  effect  )  [pure virtual]

Check if camera control supports desired effect.

Use camera-specific constants.

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

Implemented in DummyCameraControl, and SonyEviD100PControl.

Member Data Documentation

const unsigned int 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 33 of file effect.h.

Referenced by DummyCameraControl::effect(), SonyEviD100PControl::set_effect(), SonyEviD100PControl::SonyEviD100PControl(), and SonyEviD100PControl::supports_effect().

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