1.1 --- a/epoc32/include/orientationbase.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/orientationbase.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,137 @@
1.4 -orientationbase.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 orientation effect baseclass.
1.19 +*
1.20 +*
1.21 +*/
1.22 +
1.23 +
1.24 +#ifndef CORIENTATION_H
1.25 +#define CORIENTATION_H
1.26 +
1.27 +// INCLUDES
1.28 +
1.29 +#include <e32base.h>
1.30 +#include <AudioEffectBase.h>
1.31 +#include <OrientationData.h>
1.32 +#include <MCustomInterface.h>
1.33 +
1.34 +// CLASS DECLARATION
1.35 +
1.36 +/**
1.37 +* This is the orientation effect base class.
1.38 +*
1.39 +* @lib OrientationEffect.lib
1.40 +* @since 3.0
1.41 +*/
1.42 +
1.43 +class COrientation : public CAudioEffect
1.44 + {
1.45 +
1.46 + protected: // Constructors and destructor
1.47 +
1.48 + /**
1.49 + *
1.50 + * Destructor
1.51 + */
1.52 + IMPORT_C virtual ~COrientation();
1.53 +
1.54 + /**
1.55 + * Private C++ constructor for this class.
1.56 + */
1.57 + IMPORT_C COrientation();
1.58 +
1.59 +
1.60 + public: //New Functions
1.61 +
1.62 + /**
1.63 + * Get the orientation vectors for the position
1.64 + * @since 3.0
1.65 + * @param aHeading The heading (thousandths of radians)
1.66 + * @param aPitch The Pitch (thousandths of radians)
1.67 + * @param aRoll The Roll (thousandths of radians)
1.68 + * @return -
1.69 + */
1.70 + IMPORT_C void Orientation( TInt32& aHeading, TInt32& aPitch, TInt32& aRoll );
1.71 +
1.72 + /**
1.73 + * Gets the orientation of the position.
1.74 + * @since 3.0
1.75 + * @param aFrontX X value of Front vector
1.76 + * @param aFrontY Y value of Front vector
1.77 + * @param aFrontZ Z value of Front vector
1.78 + * @param aAboveX X value of Above vector
1.79 + * @param aAboveY Y value of Above vector
1.80 + * @param aAboveZ Z value of Above vector
1.81 + * @return -
1.82 + */
1.83 + IMPORT_C void OrientationVectors( TInt32& aFrontX, TInt32& aFrontY, TInt32& aFrontZ,
1.84 + TInt32& aAboveX, TInt32& aAboveY, TInt32& aAboveZ );
1.85 +
1.86 + /**
1.87 + * Sets the Heading, Pitch, Roll values for the orientation of the source
1.88 + * @since 3.0
1.89 + * @param aHeading The heading (thousandths of radians)
1.90 + * @param aPitch The Pitch (thousandths of radians)
1.91 + * @param aRoll The Roll (thousandths of radians)
1.92 + * @return -
1.93 + */
1.94 + IMPORT_C void SetOrientationL( TInt32 aHeading, TInt32 aPitch, TInt32 aRoll );
1.95 +
1.96 + /**
1.97 + * Sets the Front and Above vectors for the orientation of the position.
1.98 + * @since 3.0
1.99 + * @param aFrontX X value of Front vector
1.100 + * @param aFrontY Y value of Front vector
1.101 + * @param aFrontZ Z value of Front vector
1.102 + * @param aAboveX X value of Above vector
1.103 + * @param aAboveY Y value of Above vector
1.104 + * @param aAboveZ Z value of Above vector
1.105 + * @return -
1.106 + */
1.107 + IMPORT_C void SetOrientationVectorsL( TInt32 aFrontX, TInt32 aFrontY, TInt32 aFrontZ,
1.108 + TInt32 aAboveX, TInt32 aAboveY, TInt32 aAboveZ );
1.109 +
1.110 + protected: // Functions from base classes
1.111 +
1.112 + /**
1.113 + * From CAudioEffect
1.114 + * Create a package of the effect data
1.115 + * @since 3.0
1.116 + * @return A descriptor containing the effect data.
1.117 + */
1.118 + IMPORT_C const TDesC8& DoEffectData();
1.119 +
1.120 + /**
1.121 + * From CAudioEffect
1.122 + * Internal function to unpack effect data
1.123 + * @since 3.0
1.124 + * @param aEffectDataBuffer Descriptor containing packed effect data
1.125 + * @return -
1.126 + */
1.127 + IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer );
1.128 +
1.129 + protected:
1.130 +
1.131 + // Orientation data structure
1.132 + TEfOrientation iOrientationData;
1.133 + // Data package sent to server
1.134 + TEfOrientationDataPckg iDataPckgTo;
1.135 + // Data package received from server
1.136 + TEfOrientationDataPckg iDataPckgFrom;
1.137 + };
1.138 +
1.139 +#endif // of CORIENTATION_H
1.140 +
1.141 +// End of File