|
1 /* |
|
2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: This is the definition of the base class for location effect. |
|
15 * |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef CLOCATION_H |
|
21 #define CLOCATION_H |
|
22 |
|
23 // INCLUDES |
|
24 |
|
25 #include <e32base.h> |
|
26 #include <AudioEffectBase.h> |
|
27 #include <LocationData.h> |
|
28 |
|
29 // CLASS DECLARATION |
|
30 |
|
31 /** |
|
32 * This is the base class for location effect settings. |
|
33 * |
|
34 * @lib LocationEffect.lib |
|
35 * @since 3.0 |
|
36 */ |
|
37 |
|
38 class CLocation : public CAudioEffect |
|
39 { |
|
40 |
|
41 protected: // Constructors and destructor |
|
42 |
|
43 /** |
|
44 * |
|
45 * Destructor |
|
46 */ |
|
47 IMPORT_C virtual ~CLocation(); |
|
48 |
|
49 /** |
|
50 * Private C++ constructor for this class. |
|
51 */ |
|
52 IMPORT_C CLocation(); |
|
53 |
|
54 public: // New Functions |
|
55 |
|
56 /** |
|
57 * Gets the cartesian coordinates for the location of the position. |
|
58 * @since 3.0 |
|
59 * @param aX The x-coordinate of the position (in millimeters) |
|
60 * @param aY The y-coordinate of the position (in millimeters) |
|
61 * @param aZ The z-coordinate of the position (in millimeters) |
|
62 * @return - |
|
63 */ |
|
64 IMPORT_C void LocationCartesian( TInt32& aX, TInt32& aY, TInt32& aZ ); |
|
65 |
|
66 /** |
|
67 * Gets the spherical coordinates for the location of the position. |
|
68 * @since 3.0 |
|
69 * @param aAzimuth The Azimuth of the position (thousandths of radians) |
|
70 * @param aElevation The elevation of the position (thousandths of radians) |
|
71 * @param aRadius The radius of the position (thousandths of radians) |
|
72 * @return - |
|
73 */ |
|
74 IMPORT_C void LocationSpherical( TInt32& aAzimuth, TInt32& aElevation, TInt32& aRadius ); |
|
75 |
|
76 /** |
|
77 * Sets the cartesian coordinates for the location of the position. |
|
78 * @since 3.0 |
|
79 * @param aX The x-coordinate of the position |
|
80 * @param aY The y-coordinate of the position |
|
81 * @param aZ The z-coordinate of the position |
|
82 * @return - |
|
83 */ |
|
84 IMPORT_C void SetLocationCartesianL( TInt32& aX, TInt32& aY, TInt32& aZ ); |
|
85 |
|
86 /** |
|
87 * Sets the spherical coordinates for the location of the position. |
|
88 * @since 3.0 |
|
89 * @param aAzimuth The Azimuth of the position (thousandths of radians) |
|
90 * @param aElevation The elevation of the position (thousandths of radians) |
|
91 * @param aRadius The radius of the position (thousandths of radians) |
|
92 * @return - |
|
93 */ |
|
94 IMPORT_C void SetLocationSphericalL( TInt32& aAzimuth, TInt32& aElevation, TInt32& aRadius ); |
|
95 |
|
96 protected: // Functions from base classes |
|
97 |
|
98 /** |
|
99 * From CAudioEffect |
|
100 * Create a package of the effect data |
|
101 * @since 3.0 |
|
102 * @return A descriptor containing the effect data. |
|
103 */ |
|
104 IMPORT_C const TDesC8& DoEffectData(); |
|
105 |
|
106 /** |
|
107 * From CAudioEffect |
|
108 * Internal function to unpack effect data |
|
109 * @since 3.0 |
|
110 * @param aEffectDataBuffer Descriptor containing packed effect data |
|
111 * @return - |
|
112 */ |
|
113 IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer ); |
|
114 |
|
115 protected: |
|
116 |
|
117 // Location data structure |
|
118 TEfLocation iLocationData; |
|
119 // Data package sent to server |
|
120 TEfLocationDataPckg iDataPckgTo; |
|
121 // Data package received from server |
|
122 TEfLocationDataPckg iDataPckgFrom; |
|
123 }; |
|
124 |
|
125 #endif // of CLOCATION_H |
|
126 |
|
127 // End of File |