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
enum	TEffectInputType { EEffectInputTypeInt, EEffectInputTypeReal32, EEffectInputTypeCustom }

Public Member Functions
IMPORT_C void	BeginL()
IMPORT_C void	EndL()
IMPORT_C TAny *	Extension(TUid)
IMPORT_C TEffectInputType	InputType()
TBool	IsActive()
IMPORT_C void	LevelL(TInt &)
IMPORT_C void	LevelL(TReal32 &)
IMPORT_C void	LevelSettings(TInt &, TInt &, TInt &)
IMPORT_C void	LevelSettings(TReal32 &, TReal32 &, TReal32 &)
Plugin::MEffect &	PluginEffect()
IMPORT_C void	ResetL()
IMPORT_C void	SetLevelL(TInt)
IMPORT_C void	SetLevelL(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.

Enumerator	Value	Description
EEffectInputTypeInt
EEffectInputTypeReal32
EEffectInputTypeCustom

Constructor & Destructor Documentation

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

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

Constructor.

Parameter	Description
aUid	The uid of the effect.
aPluginEffect	The effect plugin.
aImageProcessorImpl	The image processor implementation.

Member Function Documentation

BeginL ( )

IMPORT_C void

BeginL

(

)

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

EndL ( )

IMPORT_C void

EndL

(

)

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

Extension ( TUid )

IMPORT_C TAny *

Extension

(

TUid

aExtension

)

Retrieves access to a custom extension.

Parameter	Description
aExtension	The UID of the extension to be retrieved

Returns: Extension corresponding to the UID given as a parameter.

InputType ( )

IMPORT_C TEffectInputType

InputType

(

)

const

Retrieves the input type for the effect.

Returns: TEffectInputType corresponding to the level type.

IsActive ( )

TBool

IsActive

(

)

const [inline]

Gets the state of the effect.

Returns: ETrue if the effect is active.

LevelL ( TInt & )

IMPORT_C void

LevelL

(

TInt &

aLevel

)

const

Retrieves the effect level.

leave: KErrNotSupported The input type is not supported by the effect. The supported input type can be queried by calling TEffect::InputType function.

See also: TEffect::InputType()

Parameter	Description
aLevel	The level value.

LevelL ( TReal32 & )

IMPORT_C void

LevelL

(

TReal32 &

aLevel

)

const

Retrieves the effect level.

leave: KErrNotSupported The input type is not supported by the effect. The supported input type can be queried by calling TEffect::InputType function.

See also: TEffect::InputType()

Parameter	Description
aLevel	The level value.

LevelSettings ( TInt &, TInt &, TInt & )

IMPORT_C void	LevelSettings	(	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.

Parameter	Description
aMinimumLevel	The minimum value of the level.
aMaximumLevel	The maximum value of the level.
aLevelStep	The value of the level step. The level step defines the level range resolution between minimim and maximum levels.

LevelSettings ( TReal32 &, TReal32 &, TReal32 & )

IMPORT_C void	LevelSettings	(	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.

Parameter	Description
aMinimumLevel	The minimum value of the level.
aMaximumLevel	The maximum value of the level.
aLevelStep	The 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.

Returns: A pointer to the related plugin effect instance.

ResetL ( )

IMPORT_C void

ResetL

(

)

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

SetLevelL ( TInt )

IMPORT_C void

SetLevelL

(

TInt

aLevel

)

Sets the level to the effect.

leave: KErrNotReady The effect is not active. The effect should be set active by calling TEffect::BeginL() function.

See also: TEffect::InputType()

Parameter	Description
aLevel	The level value to be set.

SetLevelL ( TReal32 )

IMPORT_C void

SetLevelL

(

TReal32

aLevel

)

Sets the level to the effect.

leave: KErrNotReady The effect is not active. The effect should be set active by calling TEffect::BeginL() function.

See also: TEffect::InputType()

Parameter	Description
aLevel	The level value to be set.

Type ( )

TUid

Type

(

)

const [inline]

Gets the effect type.

Returns: The UID of the effect.