Collapse all Symbian^3 Product Developer Library

TAlfPointCommand Class Reference

class TAlfPointCommand : public TAlfObjectCommand

TAlfPointCommand is a command that operates on a timed point. Usage:

  //Create timed point command to set visual size
   TAlfRealPoint p1( 0.1, 0.1 );
   TAlfPointCommand command1( iVisual, EAlfValueCommandVisualSize, p1, 1 );
  
  //Send command , Primary image will be set
   iEnv->Send( command, 1 );

Inherits from

TAlfPointCommand
- TAlfObjectCommand
  - TAlfCommand

Public Member Functions
	TAlfPointCommand(TAny *, TAlfPointCommandTarget, TAlfOp)
	TAlfPointCommand(TAny *, TAlfPointCommandTarget, TAlfRealPoint, TInt, TParameterTarget)
	TAlfPointCommand(TAny *, TAlfPointCommandTarget, TAlfOp, TAlfRealPoint, TReal32, TParameterTarget)
IMPORT_C void	ExecuteL(CAlfEnv &)
IMPORT_C TInt	Size()
IMPORT_C TReal32	Speed()
IMPORT_C TAlfRealPoint	Target()
IMPORT_C TAlfPointCommandTarget	TimedPoint()
IMPORT_C TInt	TransitionTime()

Protected Member Functions
IMPORT_C void	CommandExtension(const TUid &, TAny **)

Inherited Functions
	TAlfCommand::TAlfCommand(TAlfCommandType)
	TAlfCommand::Type()const
	TAlfCommand::~TAlfCommand()
	TAlfObjectCommand::Object()const
	TAlfObjectCommand::ObjectCommand()const
	TAlfObjectCommand::Operation()const
	TAlfObjectCommand::TAlfObjectCommand(TAlfCommandType,TAny *,TAlfOp)

Public Member Enumerations
enum	TParameterTarget { EBoth = 0, EXOnly, EYOnly }

Private Attributes
TParameterTarget	iParameterTarget
TInt	iSpare1
TInt	iSpare2
TReal32	iSpeed
TAlfRealPoint	iTarget
TAlfPointCommandTarget	iTimedPoint
TInt	iTransitionTime

Constructor & Destructor Documentation

TAlfPointCommand(TAny *, TAlfPointCommandTarget, TAlfOp)

IMPORT_C	TAlfPointCommand	(	TAny *	aObject,
			TAlfPointCommandTarget	aObjectType,
			TAlfOp	aOperation
		)

Constructs a new timed point command.

Parameters

TAny * aObject	Object. Needs to match with aObjectType
TAlfPointCommandTarget aObjectType	Timed value to modify.
TAlfOp aOperation	Operation to perform.

TAlfPointCommand(TAny *, TAlfPointCommandTarget, TAlfRealPoint, TInt, TParameterTarget)

IMPORT_C	TAlfPointCommand	(	TAny *	aObject,
			TAlfPointCommandTarget	aObjectType,
			TAlfRealPoint	aTarget,
			TInt	aTransitionTime = 0,
			TParameterTarget	aParameterTarget = EBoth
		)

Constructs a new timed point command.

Parameters

TAny * aObject	Object. Needs to match with aObjectType
TAlfPointCommandTarget aObjectType	Timed value to modify.
TAlfRealPoint aTarget	Target value
TInt aTransitionTime = 0	Time (in milliseconds) for the transition to occur.
TParameterTarget aParameterTarget = EBoth

TAlfPointCommand(TAny *, TAlfPointCommandTarget, TAlfOp, TAlfRealPoint, TReal32, TParameterTarget)

IMPORT_C	TAlfPointCommand	(	TAny *	aObject,
			TAlfPointCommandTarget	aObjectType,
			TAlfOp	aOperation,
			TAlfRealPoint	aTarget,
			TReal32	aTiming = 0.0,
			TParameterTarget	aParameterTarget = EBoth
		)

Constructs a new timed point command. This constructor takes an operation parameter in addition to the target and timing values.

Parameters

TAny * aObject	Object. Needs to match with aObjectType
TAlfPointCommandTarget aObjectType	Timed value to modify.
TAlfOp aOperation	Operation to perform.
TAlfRealPoint aTarget	Target value.
TReal32 aTiming = 0.0	Time (in milliseconds) for the transition to occur.
TParameterTarget aParameterTarget = EBoth

Member Functions Documentation

CommandExtension(const TUid &, TAny **)

IMPORT_C void	CommandExtension	(	const TUid &	aExtensionUid,
			TAny **	aExtensionParams
		)	[protected, virtual]

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParams

ExecuteL(CAlfEnv &)

IMPORT_C void

ExecuteL

(

CAlfEnv &

aEnv

)

const [virtual]

Executes the command.

Parameters

CAlfEnv & aEnv

The environment in which the command is being executed.

Size()

IMPORT_C TInt

Size

(

)

const [virtual]

Returns the size of the command.

Speed()

IMPORT_C TReal32

Speed

(

)

const

Returns the transition speed. Zero, if not set.

Target()

IMPORT_C TAlfRealPoint

Target

(

)

const

Returns the target value.

TimedPoint()

IMPORT_C TAlfPointCommandTarget

TimedPoint

(

)

const

Returns the object type that the command operates on.

TransitionTime()

IMPORT_C TInt

TransitionTime

(

)

const

Returns the transition time.

Member Enumerations Documentation

Enum TParameterTarget

Enumerators

EBoth = 0
EXOnly
EYOnly

Member Data Documentation

TParameterTarget iParameterTarget

TParameterTarget

iParameterTarget

[private]

TInt iSpare1

TInt

iSpare1

[private]

TInt iSpare2

TInt

iSpare2

[private]

TReal32 iSpeed

TReal32

iSpeed

[private]

Optionally, transition speed in units/second.

TAlfRealPoint iTarget

TAlfRealPoint

iTarget

[private]

Target value.

TAlfPointCommandTarget iTimedPoint

TAlfPointCommandTarget

iTimedPoint

[private]

Timed point being operated on.

TInt iTransitionTime

TInt

iTransitionTime

[private]

Transition time in milliseconds.