ImageProcessor::TEffect Class Reference

#include <imageprocessor/imageprocessoreffect.h>

Link against: imageprocessor.lib

class ImageProcessor::TEffect
Protected Attributes
CImageProcessorImpl &iImageProcessorImpl
TBool iIsActive
Plugin::MEffect &iPluginEffect
TAny *iReserved
TUid iUid
Public Member Enumerations
enumTEffectInputType { EEffectInputTypeInt, EEffectInputTypeReal32, EEffectInputTypeCustom }
Public Member Functions
IMPORT_C voidBeginL()
IMPORT_C voidEndL()
IMPORT_C TAny *Extension(TUid)
IMPORT_C TEffectInputTypeInputType()
TBool IsActive()
IMPORT_C voidLevelL(TInt &)
IMPORT_C voidLevelL(TReal32 &)
IMPORT_C voidLevelSettings(TInt &, TInt &, TInt &)
IMPORT_C voidLevelSettings(TReal32 &, TReal32 &, TReal32 &)
Plugin::MEffect &PluginEffect()
IMPORT_C voidResetL()
IMPORT_C voidSetLevelL(TInt)
IMPORT_C voidSetLevelL(TReal32)
TUid Type()
Protected Member Functions
TEffect(const TUid &, Plugin::MEffect &, CImageProcessorImpl &)

Detailed Description

The class is the parent class of all effects. The extended class should implement three stages/functions: "begin -> set -> end"

Member Attribute Documentation

iImageProcessorImpl

CImageProcessorImpl &iImageProcessorImpl[protected]

iIsActive

TBool iIsActive[protected]

iPluginEffect

Plugin::MEffect &iPluginEffect[protected]

iReserved

TAny *iReserved[protected]

iUid

TUid iUid[protected]

Member Enumeration Documentation

Enum TEffectInputType

Describes the type of the effect in terms of the type of parameter input to adjust levels.

Constructor & Destructor Documentation

TEffect ( const TUid &, Plugin::MEffect &, CImageProcessorImpl & )

TEffect(const TUid &aUid,
Plugin::MEffect &aPluginEffect,
CImageProcessorImpl &aImageProcessorImpl
)[protected]

Constructor.

Parameters
aUidThe uid of the effect.
aPluginEffectThe effect plugin.
aImageProcessorImplThe image processor implementation.

Member Function Documentation

BeginL ( )

IMPORT_C voidBeginL()

The begin function of effects, which is first part of the three stages/functions: "begin -> set -> end". .

EndL ( )

IMPORT_C voidEndL()

The end function of effects, which is last part of the three stages/functions: "begin -> set -> end". .

Extension ( TUid )

IMPORT_C TAny *Extension(TUidaExtension)

Retrieves access to a custom extension.

Parameters
aExtensionThe UID of the extension to be retrieved
Return Value
Extension corresponding to the UID given as a parameter.

InputType ( )

IMPORT_C TEffectInputTypeInputType()const

Retrieves the input type for the effect.

Return Value
TEffectInputType corresponding to the level type.

IsActive ( )

TBool IsActive()const [inline]

Gets the state of the effect.

Return Value
ETrue if the effect is active.

LevelL ( TInt & )

IMPORT_C voidLevelL(TInt &aLevel)const

Retrieves the effect level.

See also: TEffect::InputType()

Parameters
aLevelThe level value.
Leave Codes
KErrNotSupportedThe input type is not supported by the effect. The supported input type can be queried by calling

LevelL ( TReal32 & )

IMPORT_C voidLevelL(TReal32 &aLevel)const

Retrieves the effect level.

See also: TEffect::InputType()

Parameters
aLevelThe level value.
Leave Codes
KErrNotSupportedThe input type is not supported by the effect. The supported input type can be queried by calling

LevelSettings ( TInt &, TInt &, TInt & )

IMPORT_C voidLevelSettings(TInt &aMinimumLevel,
TInt &aMaximumLevel,
TInt &aLevelStep
)const

Retrieves the effect level range. If minimum level equals the maximum level the particular input type is not supported.

Parameters
aMinimumLevelThe minimum value of the level.
aMaximumLevelThe maximum value of the level.
aLevelStepThe value of the level step. The level step defines the level range resolution between minimim and maximum levels.

LevelSettings ( TReal32 &, TReal32 &, TReal32 & )

IMPORT_C voidLevelSettings(TReal32 &aMinimumLevel,
TReal32 &aMaximumLevel,
TReal32 &aLevelStep
)const

Retrieves the effect level range. If minimum level equals the maximum level the particular input type is not supported.

Parameters
aMinimumLevelThe minimum value of the level.
aMaximumLevelThe maximum value of the level.
aLevelStepThe value of the level step. The level step defines the level range resolution between minimim and maximum levels.

PluginEffect ( )

Plugin::MEffect &PluginEffect()const [inline]

Gets associated plugin of the effect.

Return Value
A pointer to the related plugin effect instance.

ResetL ( )

IMPORT_C voidResetL()

The reset function of effects, which resets the effect parameters and state.

SetLevelL ( TInt )

IMPORT_C voidSetLevelL(TIntaLevel)

Sets the level to the effect.

See also: TEffect::BeginL()

See also: TEffect::LevelSettings(TInt& aMinimumLevel, TInt& aMaximumLevel, TInt& aLevelStep)

See also: TEffect::InputType()

Parameters
aLevelThe level value to be set.
Leave Codes
KErrNotReadyThe effect is not active. The effect should be set active by calling
KErrArgumentThe level is not in the level range. The range can be queried by calling TEffect::LevelSettings(TInt& aMinimumLevel, TInt& aMaximumLevel, TInt& aLevelStep) function.
KErrNotSupportedThe input type is not supported by the effect. The supported input type can be queried by calling

SetLevelL ( TReal32 )

IMPORT_C voidSetLevelL(TReal32aLevel)

Sets the level to the effect.

See also: TEffect::BeginL()

See also: TEffect::LevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel, TReal32& aLevelStep)

See also: TEffect::InputType()

Parameters
aLevelThe level value to be set.
Leave Codes
KErrNotReadyThe effect is not active. The effect should be set active by calling
KErrArgumentThe level is not in the level range. The range can be queried by calling TEffect::LevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel, TReal32& aLevelStep) function.
KErrNotSupportedThe input type is not supported for the effect. The supported input type can be queried by calling

Type ( )

TUid Type()const [inline]

Gets the effect type.

Return Value
The UID of the effect.