CLocation Class Reference

API published in: S60 3rd Ed

Link against: locationbase.lib

Capability Information

Required Capabilities

None

#include <locationbase.h>

Inherits CAudioEffect.

Inherited by CListenerLocation, and CSourceLocation.

Detailed Description

This is the base class for location effect settings.

Public Member Functions
IMPORT_C void  LocationCartesian (TInt32 &aX, TInt32 &aY, TInt32 &aZ)
  Gets the cartesian coordinates for the location of the position.
IMPORT_C void  LocationSpherical (TInt32 &aAzimuth, TInt32 &aElevation, TInt32 &aRadius)
  Gets the spherical coordinates for the location of the position.
IMPORT_C void  SetLocationCartesianL (TInt32 &aX, TInt32 &aY, TInt32 &aZ)
  Sets the cartesian coordinates for the location of the position.
IMPORT_C void  SetLocationSphericalL (TInt32 &aAzimuth, TInt32 &aElevation, TInt32 &aRadius)
  Sets the spherical coordinates for the location of the position.

Protected Member Functions
virtual IMPORT_C  ~CLocation ()
  Destructor.
IMPORT_C  CLocation ()
  Private C++ constructor for this class.
IMPORT_C const TDesC8 &  DoEffectData ()
  From CAudioEffect Create a package of the effect data.
IMPORT_C void  SetEffectData (const TDesC8 &aEffectDataBuffer)
  From CAudioEffect Internal function to unpack effect data.

Protected Attributes
TEfLocation  iLocationData
TEfLocationDataPckg  iDataPckgTo
TEfLocationDataPckg  iDataPckgFrom

Constructor & Destructor Documentation

virtual IMPORT_C CLocation::~CLocation (   )  [protected, virtual]
 

Destructor.

IMPORT_C CLocation::CLocation (   )  [protected]
 

Private C++ constructor for this class.

Member Function Documentation

IMPORT_C const TDesC8& CLocation::DoEffectData (   )  [protected, virtual]
 

From CAudioEffect Create a package of the effect data.

Returns:
A descriptor containing the effect data.

Implements CAudioEffect.

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

Gets the cartesian coordinates for the location of the position.

Parameters:
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:
-
IMPORT_C void CLocation::LocationSpherical (  TInt32 &  aAzimuth,
TInt32 &  aElevation,
TInt32 &  aRadius
) 
 

Gets the spherical coordinates for the location of the position.

Parameters:
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:
-
IMPORT_C void CLocation::SetEffectData (  const TDesC8 &  aEffectDataBuffer  )  [protected, virtual]
 

From CAudioEffect Internal function to unpack effect data.

Parameters:
aEffectDataBuffer  Descriptor containing packed effect data
Returns:
-

Implements CAudioEffect.

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

Sets the cartesian coordinates for the location of the position.

Parameters:
aX  The x-coordinate of the position
aY  The y-coordinate of the position
aZ  The z-coordinate of the position
Returns:
-
IMPORT_C void CLocation::SetLocationSphericalL (  TInt32 &  aAzimuth,
TInt32 &  aElevation,
TInt32 &  aRadius
) 
 

Sets the spherical coordinates for the location of the position.

Parameters:
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:
-

Field Documentation

TEfLocationDataPckg CLocation::iDataPckgFrom [protected]
 
TEfLocationDataPckg CLocation::iDataPckgTo [protected]
 
TEfLocation CLocation::iLocationData [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top