CLocation Class Reference

#include <LocationBase.h>

Link against: LocationEffect.lib

class CLocation : public CAudioEffect

Inherits from

CLocation
- CAudioEffect

Protected Attributes
TEfLocationDataPckg	iDataPckgFrom
TEfLocationDataPckg	iDataPckgTo
TEfLocation	iLocationData

Public Member Functions
IMPORT_C void	LocationCartesian(TInt32 &, TInt32 &, TInt32 &)
IMPORT_C void	LocationSpherical(TInt32 &, TInt32 &, TInt32 &)
IMPORT_C void	SetLocationCartesianL(TInt32 &, TInt32 &, TInt32 &)
IMPORT_C void	SetLocationSphericalL(TInt32 &, TInt32 &, TInt32 &)

Protected Member Functions
	CLocation()
virtual	~CLocation()
virtual IMPORT_C const TDesC8 &	DoEffectData()
virtual IMPORT_C void	SetEffectData(const TDesC8 &)

Inherited Attributes
	CAudioEffect::iEnabled
	CAudioEffect::iEnforced
	CAudioEffect::iHaveUpdateRights
	CAudioEffect::iObservers

Inherited Functions
	CAudioEffect::ApplyL()
	CAudioEffect::CAudioEffect()
	CAudioEffect::DisableL()
	CAudioEffect::EnableL()
	CAudioEffect::EnforceL(TBool)
	CAudioEffect::HaveUpdateRights()const
	CAudioEffect::IsEnabled()const
	CAudioEffect::IsEnforced()const
	CAudioEffect::RegisterObserverL(MAudioEffectObserver &)
	CAudioEffect::Uid()const
	CAudioEffect::UnRegisterObserver(MAudioEffectObserver &)
	CAudioEffect::~CAudioEffect()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

This is the base class for location effect settings.

Since: 3.0

Member Attribute Documentation

iDataPckgFrom

TEfLocationDataPckg

iDataPckgFrom

[protected]

iDataPckgTo

TEfLocationDataPckg

iDataPckgTo

[protected]

iLocationData

TEfLocation

iLocationData

[protected]

Constructor & Destructor Documentation

CLocation ( )

IMPORT_C

CLocation

(

)

[protected]

Private C++ constructor for this class.

~CLocation ( )

IMPORT_C

~CLocation

(

)

[protected, virtual]

Destructor

Member Function Documentation

DoEffectData ( )

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

Reimplemented from CAudioEffect::DoEffectData()

From CAudioEffect Create a package of the effect data

Since: 3.0

Returns: A descriptor containing the effect data.

LocationCartesian ( TInt32 &, TInt32 &, TInt32 & )

IMPORT_C void	LocationCartesian	(	TInt32 &	aX,
			TInt32 &	aY,
			TInt32 &	aZ
		)

Gets the cartesian coordinates for the location of the position.

Since: 3.0

Parameter	Description
aX	The x-coordinate of the position (in millimeters)
aY	The y-coordinate of the position (in millimeters)
aZ	The z-coordinate of the position (in millimeters)

Returns: -

LocationSpherical ( TInt32 &, TInt32 &, TInt32 & )

IMPORT_C void	LocationSpherical	(	TInt32 &	aAzimuth,
			TInt32 &	aElevation,
			TInt32 &	aRadius
		)

Gets the spherical coordinates for the location of the position.

Since: 3.0

Parameter	Description
aAzimuth	The Azimuth of the position (thousandths of radians)
aElevation	The elevation of the position (thousandths of radians)
aRadius	The radius of the position (thousandths of radians)

Returns: -

SetEffectData ( const TDesC8 & )

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

Reimplemented from CAudioEffect::SetEffectData(const TDesC8 &)

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameter	Description
aEffectDataBuffer	Descriptor containing packed effect data

Returns: -

SetLocationCartesianL ( TInt32 &, TInt32 &, TInt32 & )

IMPORT_C void	SetLocationCartesianL	(	TInt32 &	aX,
			TInt32 &	aY,
			TInt32 &	aZ
		)

Sets the cartesian coordinates for the location of the position.

Since: 3.0

Parameter	Description
aX	The x-coordinate of the position
aY	The y-coordinate of the position
aZ	The z-coordinate of the position

Returns: -

SetLocationSphericalL ( TInt32 &, TInt32 &, TInt32 & )

IMPORT_C void	SetLocationSphericalL	(	TInt32 &	aAzimuth,
			TInt32 &	aElevation,
			TInt32 &	aRadius
		)

Sets the spherical coordinates for the location of the position.

Since: 3.0

Parameter	Description
aAzimuth	The Azimuth of the position (thousandths of radians)
aElevation	The elevation of the position (thousandths of radians)
aRadius	The radius of the position (thousandths of radians)

Returns: -