sl@0: /*
sl@0: * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:  This is the definition of the orientation effect baseclass.
sl@0: *
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef CORIENTATION_H
sl@0: #define CORIENTATION_H
sl@0: 
sl@0: // INCLUDES
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <AudioEffectBase.h>
sl@0: #include <OrientationData.h>
sl@0: #include <MCustomInterface.h>
sl@0: 
sl@0: // CLASS DECLARATION
sl@0: 
sl@0: /**
sl@0: *  This is the orientation effect base class.
sl@0: *
sl@0: *  @lib OrientationEffect.lib
sl@0: *  @since 3.0
sl@0: */
sl@0: 
sl@0: class COrientation : public CAudioEffect
sl@0: 	{
sl@0: 
sl@0: 	protected:	// Constructors and destructor
sl@0: 
sl@0: 		/**
sl@0:         *
sl@0:         * Destructor
sl@0:         */
sl@0: 		IMPORT_C virtual ~COrientation();
sl@0: 
sl@0: 		/**
sl@0: 		* Private C++ constructor for this class.
sl@0:         */
sl@0: 		IMPORT_C COrientation();
sl@0: 
sl@0: 
sl@0: 	public:		//New Functions
sl@0: 
sl@0: 		/**
sl@0:         * Get the orientation vectors for the position
sl@0:         * @since 3.0
sl@0:         * @param aHeading The heading (thousandths of radians)
sl@0:         * @param aPitch The Pitch (thousandths of radians)
sl@0:         * @param aRoll The Roll (thousandths of radians)
sl@0:         * @return -
sl@0:         */
sl@0: 		IMPORT_C void Orientation( TInt32& aHeading, TInt32& aPitch, TInt32& aRoll );
sl@0: 
sl@0: 		/**
sl@0:         * Gets the orientation of the position.
sl@0:         * @since 3.0
sl@0:         * @param aFrontX X value of Front vector
sl@0:         * @param aFrontY Y value of Front vector
sl@0:         * @param aFrontZ Z value of Front vector
sl@0:         * @param aAboveX X value of Above vector
sl@0:         * @param aAboveY Y value of Above vector
sl@0:         * @param aAboveZ Z value of Above vector
sl@0:         * @return -
sl@0:         */
sl@0: 		IMPORT_C void OrientationVectors( TInt32& aFrontX, TInt32& aFrontY, TInt32& aFrontZ,
sl@0: 								   	      TInt32& aAboveX, TInt32& aAboveY, TInt32& aAboveZ );
sl@0: 
sl@0: 		/**
sl@0:         * Sets the Heading, Pitch, Roll values for the orientation of the source
sl@0:         * @since 3.0
sl@0:         * @param aHeading The heading (thousandths of radians)
sl@0:         * @param aPitch The Pitch (thousandths of radians)
sl@0:         * @param aRoll The Roll (thousandths of radians)
sl@0:         * @return -
sl@0:         */
sl@0: 		IMPORT_C void SetOrientationL( TInt32 aHeading, TInt32 aPitch, TInt32 aRoll );
sl@0: 
sl@0: 		/**
sl@0:         * Sets the Front and Above vectors for the orientation of the position.
sl@0:         * @since 3.0
sl@0:         * @param aFrontX X value of Front vector
sl@0:         * @param aFrontY Y value of Front vector
sl@0:         * @param aFrontZ Z value of Front vector
sl@0:         * @param aAboveX X value of Above vector
sl@0:         * @param aAboveY Y value of Above vector
sl@0:         * @param aAboveZ Z value of Above vector
sl@0:         * @return -
sl@0:         */
sl@0: 		IMPORT_C void SetOrientationVectorsL( TInt32 aFrontX, TInt32 aFrontY, TInt32 aFrontZ,
sl@0: 								   	      TInt32 aAboveX, TInt32 aAboveY, TInt32 aAboveZ );
sl@0: 
sl@0:     protected:  // Functions from base classes
sl@0: 
sl@0: 		/**
sl@0: 		* From CAudioEffect
sl@0: 		* Create a package of the effect data
sl@0:         * @since 3.0
sl@0:         * @return A descriptor containing the effect data.
sl@0:         */
sl@0: 		IMPORT_C const TDesC8& DoEffectData();
sl@0: 
sl@0: 		/**
sl@0: 		* From CAudioEffect
sl@0: 		* Internal function to unpack effect data
sl@0:         * @since 3.0
sl@0:         * @param aEffectDataBuffer Descriptor containing packed effect data
sl@0:         * @return -
sl@0:         */
sl@0:         IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer );
sl@0: 
sl@0: 	protected:
sl@0: 
sl@0: 		// Orientation data structure
sl@0: 		TEfOrientation iOrientationData;
sl@0: 		// Data package sent to server
sl@0: 		TEfOrientationDataPckg iDataPckgTo;
sl@0: 		// Data package received from server
sl@0: 		TEfOrientationDataPckg iDataPckgFrom;
sl@0: 	};
sl@0: 
sl@0: #endif	// of CORIENTATION_H
sl@0: 
sl@0: // End of File