epoc32/include/locationbase.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
     1.1 --- a/epoc32/include/locationbase.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/locationbase.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,127 @@
     1.4 -locationbase.h
     1.5 +/*
     1.6 +* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  This is the definition of the base class for location effect.
    1.19 +*
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +#ifndef CLOCATION_H
    1.25 +#define CLOCATION_H
    1.26 +
    1.27 +// INCLUDES
    1.28 +
    1.29 +#include <e32base.h>
    1.30 +#include <AudioEffectBase.h>
    1.31 +#include <LocationData.h>
    1.32 +
    1.33 +// CLASS DECLARATION
    1.34 +
    1.35 +/**
    1.36 +*  This is the base class for location effect settings.
    1.37 +*
    1.38 +*  @lib LocationEffect.lib
    1.39 +*  @since 3.0
    1.40 +*/
    1.41 +
    1.42 +class CLocation : public CAudioEffect
    1.43 +	{
    1.44 +
    1.45 +	protected:	// Constructors and destructor
    1.46 +
    1.47 +		/**
    1.48 +        *
    1.49 +        * Destructor
    1.50 +        */
    1.51 +		IMPORT_C virtual ~CLocation();
    1.52 +
    1.53 +		/**
    1.54 +		* Private C++ constructor for this class.
    1.55 +        */
    1.56 +		IMPORT_C CLocation();
    1.57 +
    1.58 +	public: // New Functions
    1.59 +
    1.60 +		/**
    1.61 +        * Gets the cartesian coordinates for the location of the position.
    1.62 +        * @since 3.0
    1.63 +        * @param aX The x-coordinate of the position (in millimeters)
    1.64 +        * @param aY The y-coordinate of the position (in millimeters)
    1.65 +        * @param aZ The z-coordinate of the position (in millimeters)
    1.66 +        * @return -
    1.67 +        */
    1.68 +		IMPORT_C void LocationCartesian( TInt32& aX, TInt32& aY, TInt32& aZ );
    1.69 +
    1.70 +		/**
    1.71 +        * Gets the spherical coordinates for the location of the position.
    1.72 +        * @since 3.0
    1.73 +        * @param aAzimuth The Azimuth of the position (thousandths of radians)
    1.74 +        * @param aElevation The elevation of the position (thousandths of radians)
    1.75 +        * @param aRadius The radius of the position (thousandths of radians)
    1.76 +        * @return -
    1.77 +        */
    1.78 +		IMPORT_C void LocationSpherical( TInt32& aAzimuth, TInt32& aElevation, TInt32& aRadius );
    1.79 +
    1.80 +		/**
    1.81 +        * Sets the cartesian coordinates for the location of the position.
    1.82 +        * @since 3.0
    1.83 +        * @param aX The x-coordinate of the position
    1.84 +        * @param aY The y-coordinate of the position
    1.85 +        * @param aZ The z-coordinate of the position
    1.86 +        * @return -
    1.87 +        */
    1.88 +		IMPORT_C void SetLocationCartesianL( TInt32& aX, TInt32& aY, TInt32& aZ );
    1.89 +
    1.90 +		/**
    1.91 +        * Sets the spherical coordinates for the location of the position.
    1.92 +        * @since 3.0
    1.93 +        * @param aAzimuth The Azimuth of the position (thousandths of radians)
    1.94 +        * @param aElevation The elevation of the position (thousandths of radians)
    1.95 +        * @param aRadius The radius of the position (thousandths of radians)
    1.96 +        * @return -
    1.97 +        */
    1.98 +		IMPORT_C void SetLocationSphericalL( TInt32& aAzimuth, TInt32& aElevation, TInt32& aRadius );
    1.99 +
   1.100 +    protected:  // Functions from base classes
   1.101 +
   1.102 +		/**
   1.103 +		* From CAudioEffect
   1.104 +		* Create a package of the effect data
   1.105 +        * @since 3.0
   1.106 +        * @return A descriptor containing the effect data.
   1.107 +        */
   1.108 +		IMPORT_C const TDesC8& DoEffectData();
   1.109 +
   1.110 +		/**
   1.111 +		* From CAudioEffect
   1.112 +		* Internal function to unpack effect data
   1.113 +        * @since 3.0
   1.114 +        * @param aEffectDataBuffer Descriptor containing packed effect data
   1.115 +        * @return -
   1.116 +        */
   1.117 +        IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer );
   1.118 +
   1.119 +	protected:
   1.120 +
   1.121 +		// Location data structure
   1.122 +		TEfLocation iLocationData;
   1.123 +		// Data package sent to server
   1.124 +		TEfLocationDataPckg iDataPckgTo;
   1.125 +		// Data package received from server
   1.126 +		TEfLocationDataPckg iDataPckgFrom;
   1.127 +	};
   1.128 +
   1.129 +#endif	// of CLOCATION_H
   1.130 +
   1.131 +// End of File