Collapse all Symbian^3 Application Developer Library

CLocation Class Reference

class CLocation : public CAudioEffect

This is the base class for location effect settings.

LocationEffect.lib

Since: 3.0

Inherits from

CLocation
- CAudioEffect
  - CBase

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 ()
	~CLocation ()
IMPORT_C const TDesC8 &	DoEffectData ()
IMPORT_C void	SetEffectData (const TDesC8 &)

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

Protected Attributes
TEfLocationDataPckg	iDataPckgFrom
TEfLocationDataPckg	iDataPckgTo
TEfLocation	iLocationData

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

Constructor & Destructor Documentation

CLocation()

IMPORT_C

CLocation

(

)

[protected]

Private C++ constructor for this class.

~CLocation()

IMPORT_C

~CLocation

(

)

[protected, virtual]

Destructor

Member Functions Documentation

DoEffectData()

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

From CAudioEffect Create a package of the effect data

Since: 3.0

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

Parameters

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

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

Parameters

TInt32 & aAzimuth	The Azimuth of the position (thousandths of radians)
TInt32 & aElevation	The elevation of the position (thousandths of radians)
TInt32 & aRadius	The radius of the position (thousandths of radians)

SetEffectData(const TDesC8 &)

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameters

const TDesC8 & aEffectDataBuffer

Descriptor containing packed effect data

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

Parameters

TInt32 & aX	The x-coordinate of the position
TInt32 & aY	The y-coordinate of the position
TInt32 & aZ	The z-coordinate of the position

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

Parameters

TInt32 & aAzimuth	The Azimuth of the position (thousandths of radians)
TInt32 & aElevation	The elevation of the position (thousandths of radians)
TInt32 & aRadius	The radius of the position (thousandths of radians)

Member Data Documentation

TEfLocationDataPckg iDataPckgFrom

TEfLocationDataPckg

iDataPckgFrom

[protected]

TEfLocationDataPckg iDataPckgTo

TEfLocationDataPckg

iDataPckgTo

[protected]

TEfLocation iLocationData

TEfLocation

iLocationData

[protected]