S60 3rd Edition API Reference: orientationbase.h Source File

00001 /*
00002 * ==============================================================================
00003 *  Name        : OrientationBase.h
00004 *  Part of     : Effects Framework
00005 *  Description : This is the definition of the orientation effect baseclass.
00006 *
00007 *  Version     : 1
00008 *
00009 *  Copyright � 2004 Nokia Corporation.
00010 *  This material, including documentation and any related
00011 *  computer programs, is protected by copyright controlled by
00012 *  Nokia Corporation. All rights are reserved. Copying,
00013 *  including reproducing, storing, adapting or translating, any
00014 *  or all of this material requires the prior written consent of
00015 *  Nokia Corporation. This material also contains confidential
00016 *  information which may not be disclosed to others without the
00017 *  prior written consent of Nokia Corporation.
00018 * ==============================================================================
00019 */
00020 
00021 #ifndef CORIENTATION_H
00022 #define CORIENTATION_H
00023 
00024 // INCLUDES
00025 
00026 #include <e32base.h>
00027 #include <AudioEffectBase.h>
00028 #include <OrientationData.h>
00029 #include <MCustomInterface.h>
00030 
00031 // CLASS DECLARATION
00032 
00040 class COrientation : public CAudioEffect
00041         {
00042 
00043         protected:      // Constructors and destructor
00044 
00049                 IMPORT_C virtual ~COrientation();
00050 
00054                 IMPORT_C COrientation();
00055 
00056 
00057         public:         //New Functions
00058 
00067                 IMPORT_C void Orientation( TInt32& aHeading, TInt32& aPitch, TInt32& aRoll );
00068 
00080                 IMPORT_C void OrientationVectors( TInt32& aFrontX, TInt32& aFrontY, TInt32& aFrontZ,
00081                                                                               TInt32& aAboveX, TInt32& aAboveY, TInt32& aAboveZ );
00082 
00091                 IMPORT_C void SetOrientationL( TInt32 aHeading, TInt32 aPitch, TInt32 aRoll );
00092 
00104                 IMPORT_C void SetOrientationVectorsL( TInt32 aFrontX, TInt32 aFrontY, TInt32 aFrontZ,
00105                                                                               TInt32 aAboveX, TInt32 aAboveY, TInt32 aAboveZ );
00106 
00107     protected:  // Functions from base classes
00108 
00115                 IMPORT_C const TDesC8& DoEffectData();
00116 
00124         IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer );
00125 
00126         protected:
00127 
00128                 // Orientation data structure
00129                 TEfOrientation iOrientationData;
00130                 // Data package sent to server
00131                 TEfOrientationDataPckg iDataPckgTo;
00132                 // Data package received from server
00133                 TEfOrientationDataPckg iDataPckgFrom;
00134         };
00135 
00136 // of CORIENTATION_H
00137 #endif
00138 
00139 // End of File