Collapse all Symbian^3 Application Developer Library

ImageProcessor::TEffect Class Reference

class ImageProcessor::TEffect

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

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 &)

Public Member Enumerations
enum	TEffectInputType { EEffectInputTypeInt , EEffectInputTypeReal32 , EEffectInputTypeCustom }

Protected Attributes
CImageProcessorImpl &	iImageProcessorImpl
TBool	iIsActive
Plugin::MEffect &	iPluginEffect
TAny *	iReserved
TUid	iUid

Constructor & Destructor Documentation

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

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

Constructor.

Parameters

const TUid & aUid	The uid of the effect.
Plugin::MEffect & aPluginEffect	The effect plugin.
CImageProcessorImpl & aImageProcessorImpl	The image processor implementation.

Member Functions 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.

Parameters

TUid aExtension

The UID of the extension to be retrieved

InputType()

IMPORT_C TEffectInputType

InputType

(

)

const

Retrieves the input type for the effect.

IsActive()

TBool

IsActive

(

)

const [inline]

Gets the state of the effect.

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.

TEffect::InputType()

Parameters

TInt & 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.

TEffect::InputType()

Parameters

TReal32 & 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.

Parameters

TInt & aMinimumLevel	The minimum value of the level.
TInt & aMaximumLevel	The maximum value of the level.
TInt & 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.

Parameters

TReal32 & aMinimumLevel	The minimum value of the level.
TReal32 & aMaximumLevel	The maximum value of the level.
TReal32 & 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.

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.

TEffect::BeginL()

leave: KErrArgument The level is not in the level range. The range can be queried by calling TEffect::LevelSettings(TInt& aMinimumLevel, TInt& aMaximumLevel, TInt& aLevelStep) function.

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

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

TEffect::InputType()

Parameters

TInt 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.

TEffect::BeginL()

leave: KErrArgument The level is not in the level range. The range can be queried by calling TEffect::LevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel, TReal32& aLevelStep) function.

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

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

TEffect::InputType()