Collapse all Symbian^3 Application Developer Library

COrientation Class Reference

class COrientation : public CAudioEffect

This is the orientation effect base class.

OrientationEffect.lib

Since: 3.0

Inherits from

COrientation
- CAudioEffect
  - CBase

Public Member Functions
IMPORT_C void	Orientation ( TInt32 &, TInt32 &, TInt32 &)
IMPORT_C void	OrientationVectors ( TInt32 &, TInt32 &, TInt32 &, TInt32 &, TInt32 &, TInt32 &)
IMPORT_C void	SetOrientationL ( TInt32 , TInt32 , TInt32 )
IMPORT_C void	SetOrientationVectorsL ( TInt32 , TInt32 , TInt32 , TInt32 , TInt32 , TInt32 )

Protected Member Functions
	COrientation ()
	~COrientation ()
IMPORT_C const TDesC8 &	DoEffectData ()
IMPORT_C void	SetEffectData (const TDesC8 &)

Inherited Functions
	CAudioEffect::ApplyL()
	CAudioEffect::CAudioEffect()
	CAudioEffect::DisableL()
	CAudioEffect::EnableL()
	CAudioEffect::EnforceL(TBool)
	CAudioEffect::HaveUpdateRights()const
	CAudioEffect::IsEnabled()const
	CAudioEffect::IsEnforced()const
	CAudioEffect::RegisterObserverL(MAudioEffectObserver &)
	CAudioEffect::Uid()const
	CAudioEffect::UnRegisterObserver(MAudioEffectObserver &)
	CAudioEffect::~CAudioEffect()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Protected Attributes
TEfOrientationDataPckg	iDataPckgFrom
TEfOrientationDataPckg	iDataPckgTo
TEfOrientation	iOrientationData

Inherited Attributes
	CAudioEffect::iEnabled
	CAudioEffect::iEnforced
	CAudioEffect::iHaveUpdateRights
	CAudioEffect::iObservers

Constructor & Destructor Documentation

COrientation()

IMPORT_C

COrientation

(

)

[protected]

Private C++ constructor for this class.

~COrientation()

IMPORT_C

~COrientation

(

)

[protected, virtual]

Destructor

Member Functions Documentation

DoEffectData()

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

From CAudioEffect Create a package of the effect data

Since: 3.0

Orientation(TInt32 &, TInt32 &, TInt32 &)

IMPORT_C void	Orientation	(	TInt32 &	aHeading,
			TInt32 &	aPitch,
			TInt32 &	aRoll
		)

Get the orientation vectors for the position

Since: 3.0

Parameters

TInt32 & aHeading	The heading (thousandths of radians)
TInt32 & aPitch	The Pitch (thousandths of radians)
TInt32 & aRoll	The Roll (thousandths of radians)

OrientationVectors(TInt32 &, TInt32 &, TInt32 &, TInt32 &, TInt32 &, TInt32 &)

IMPORT_C void	OrientationVectors	(	TInt32 &	aFrontX,
			TInt32 &	aFrontY,
			TInt32 &	aFrontZ,
			TInt32 &	aAboveX,
			TInt32 &	aAboveY,
			TInt32 &	aAboveZ
		)

Gets the orientation of the position.

Since: 3.0

Parameters

TInt32 & aFrontX	X value of Front vector
TInt32 & aFrontY	Y value of Front vector
TInt32 & aFrontZ	Z value of Front vector
TInt32 & aAboveX	X value of Above vector
TInt32 & aAboveY	Y value of Above vector
TInt32 & aAboveZ	Z value of Above vector

SetEffectData(const TDesC8 &)

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameters

const TDesC8 & aEffectDataBuffer

Descriptor containing packed effect data

SetOrientationL(TInt32, TInt32, TInt32)

IMPORT_C void	SetOrientationL	(	TInt32	aHeading,
			TInt32	aPitch,
			TInt32	aRoll
		)

Sets the Heading, Pitch, Roll values for the orientation of the source

Since: 3.0

Parameters

TInt32 aHeading	The heading (thousandths of radians)
TInt32 aPitch	The Pitch (thousandths of radians)
TInt32 aRoll	The Roll (thousandths of radians)

SetOrientationVectorsL(TInt32, TInt32, TInt32, TInt32, TInt32, TInt32)

IMPORT_C void	SetOrientationVectorsL	(	TInt32	aFrontX,
			TInt32	aFrontY,
			TInt32	aFrontZ,
			TInt32	aAboveX,
			TInt32	aAboveY,
			TInt32	aAboveZ
		)

Sets the Front and Above vectors for the orientation of the position.

Since: 3.0

Parameters

TInt32 aFrontX	X value of Front vector
TInt32 aFrontY	Y value of Front vector
TInt32 aFrontZ	Z value of Front vector
TInt32 aAboveX	X value of Above vector
TInt32 aAboveY	Y value of Above vector
TInt32 aAboveZ	Z value of Above vector

Member Data Documentation

TEfOrientationDataPckg iDataPckgFrom

TEfOrientationDataPckg

iDataPckgFrom

[protected]

TEfOrientationDataPckg iDataPckgTo

TEfOrientationDataPckg

iDataPckgTo

[protected]

TEfOrientation iOrientationData

TEfOrientation

iOrientationData

[protected]