1. Home
  2. Documentation
  3. API
  4. CameraEffectManager Class Reference

CameraEffectManager Class Reference

#include <CameraEffectManager.h>

Inheritance diagram for CameraEffectManager:
ListenerObject

# Public Member Functions

void constructor ()
 Class' constructor.
override bool handleMessage (Telegram telegram)
void reset ()
 Reset the manager's state.
void setFadeIncrement (uint8 fadeEffectIncrement)
Brightness getDefaultBrightness ()
virtual void startEffect (int32 effect, va_list args)
virtual void stopEffect (int32 effect)

# Private Attributes

Brightness fxFadeTargetBrightness
 Target brightness for the current fade effect.
ListenerObject fxFadeScope
 Callback scope for the current fade effect.
uint8 fxFadeDelay
 Delay for the current fade effect.
uint8 fadeEffectIncrement
 Fade increment.
bool startingANewEffect
 Flag to signal that the current event listener has to be removed when the effect is complete.
- Private Attributes inherited from ListenerObject
VirtualList events
 List of registered events.
int8 eventFirings
 Counter that keeps track of the number of fired events to prevent race conditions in nested firings.

# Additional Inherited Members

- Private Member Functions inherited from ListenerObject
void constructor ()
 Class' constructor.
void destructor ()
 Class' destructor.
void addEventListener (ListenerObject listener, uint16 eventCode)
void removeEventListener (ListenerObject listener, uint16 eventCode)
void removeEventListeners (uint16 eventCode)
void removeAllEventListeners ()
 Remove all listener objects.
bool hasActiveEventListeners ()
void fireEvent (uint16 eventCode)
void sendMessageTo (ListenerObject receiver, uint32 message, uint32 delay, uint32 randomDelay)
void sendMessageToSelf (uint32 message, uint32 delay, uint32 randomDelay)
void discardAllMessages ()
 Discard all messages, both to be sent and to be received.
void discardMessages (uint32 message)
virtual bool onEvent (ListenerObject eventFirer, uint16 eventCode)

# Detailed Description

Class CameraEffectManager

Inherits from ListenerObject

Manages camera's special effects, brightness transitions, etc.

Definition at line 51 of file CameraEffectManager.h.

# Member Function Documentation

# constructor()

void CameraEffectManager::constructor ( )

Class' constructor.

Definition at line 61 of file CameraEffectManager.c.

# getDefaultBrightness()

Brightness CameraEffectManager::getDefaultBrightness ( )

Retrieve the default brighness values for the current stage

Returns
Struct with the brightness levels

Definition at line 117 of file CameraEffectManager.c.

# handleMessage()

bool CameraEffectManager::handleMessage ( Telegram telegram)
virtual

Receive and process a Telegram.

Parameters
telegramReceived telegram to process
Returns
True if the telegram was processed

Reimplemented from ListenerObject.

Definition at line 87 of file CameraEffectManager.c.

# reset()

void CameraEffectManager::reset ( )

Reset the manager's state.

Definition at line 101 of file CameraEffectManager.c.

# setFadeIncrement()

void CameraEffectManager::setFadeIncrement ( uint8 fadeEffectIncrement)

Set the fade increment to apply on the next effect.

Parameters
fadeEffectIncrementFade increment

Definition at line 110 of file CameraEffectManager.c.

# startEffect()

void CameraEffectManager::startEffect ( int32 effect,
va_list args )
virtual

Start a camera effect.

Parameters
effectCode of the effect to start
argsVariable arguments list depending on the effect to start

Definition at line 142 of file CameraEffectManager.c.

# stopEffect()

void CameraEffectManager::stopEffect ( int32 effect)
virtual

Stop a camera effect.

Parameters
effectCode of the effect to stop

Definition at line 178 of file CameraEffectManager.c.

# Member Data Documentation

# fadeEffectIncrement

uint8 CameraEffectManager::fadeEffectIncrement
private

Fade increment.

Definition at line 63 of file CameraEffectManager.h.

# fxFadeDelay

uint8 CameraEffectManager::fxFadeDelay
private

Delay for the current fade effect.

Definition at line 60 of file CameraEffectManager.h.

# fxFadeScope

ListenerObject CameraEffectManager::fxFadeScope
private

Callback scope for the current fade effect.

Definition at line 57 of file CameraEffectManager.h.

# fxFadeTargetBrightness

Brightness CameraEffectManager::fxFadeTargetBrightness
private

Target brightness for the current fade effect.

Definition at line 54 of file CameraEffectManager.h.

# startingANewEffect

bool CameraEffectManager::startingANewEffect
private

Flag to signal that the current event listener has to be removed when the effect is complete.

Definition at line 66 of file CameraEffectManager.h.


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