COrientation Class Reference

API published in: S60 3rd Ed

Link against: orientationbase.lib

Capability Information

Required Capabilities

None

#include <orientationbase.h>

Inherits CAudioEffect.

Inherited by CListenerOrientation, and CSourceOrientation.

Detailed Description

This is the orientation effect base class.

Public Member Functions
IMPORT_C void  Orientation (TInt32 &aHeading, TInt32 &aPitch, TInt32 &aRoll)
  Get the orientation vectors for the position.
IMPORT_C void  OrientationVectors (TInt32 &aFrontX, TInt32 &aFrontY, TInt32 &aFrontZ, TInt32 &aAboveX, TInt32 &aAboveY, TInt32 &aAboveZ)
  Gets the orientation of the position.
IMPORT_C void  SetOrientationL (TInt32 aHeading, TInt32 aPitch, TInt32 aRoll)
  Sets the Heading, Pitch, Roll values for the orientation of the source.
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.

Protected Member Functions
virtual IMPORT_C  ~COrientation ()
  Destructor.
IMPORT_C  COrientation ()
  Private C++ constructor for this class.
IMPORT_C const TDesC8 &  DoEffectData ()
  From CAudioEffect Create a package of the effect data.
IMPORT_C void  SetEffectData (const TDesC8 &aEffectDataBuffer)
  From CAudioEffect Internal function to unpack effect data.

Protected Attributes
TEfOrientation  iOrientationData
TEfOrientationDataPckg  iDataPckgTo
TEfOrientationDataPckg  iDataPckgFrom

Constructor & Destructor Documentation

virtual IMPORT_C COrientation::~COrientation (   )  [protected, virtual]
 

Destructor.

IMPORT_C COrientation::COrientation (   )  [protected]
 

Private C++ constructor for this class.

Member Function Documentation

IMPORT_C const TDesC8& COrientation::DoEffectData (   )  [protected, virtual]
 

From CAudioEffect Create a package of the effect data.

Returns:
A descriptor containing the effect data.

Implements CAudioEffect.

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

Get the orientation vectors for the position.

Parameters:
aHeading  The heading (thousandths of radians)
aPitch  The Pitch (thousandths of radians)
aRoll  The Roll (thousandths of radians)
Returns:
-
IMPORT_C void COrientation::OrientationVectors (  TInt32 &  aFrontX,
TInt32 &  aFrontY,
TInt32 &  aFrontZ,
TInt32 &  aAboveX,
TInt32 &  aAboveY,
TInt32 &  aAboveZ
) 
 

Gets the orientation of the position.

Parameters:
aFrontX  X value of Front vector
aFrontY  Y value of Front vector
aFrontZ  Z value of Front vector
aAboveX  X value of Above vector
aAboveY  Y value of Above vector
aAboveZ  Z value of Above vector
Returns:
-
IMPORT_C void COrientation::SetEffectData (  const TDesC8 &  aEffectDataBuffer  )  [protected, virtual]
 

From CAudioEffect Internal function to unpack effect data.

Parameters:
aEffectDataBuffer  Descriptor containing packed effect data
Returns:
-

Implements CAudioEffect.

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

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

Parameters:
aHeading  The heading (thousandths of radians)
aPitch  The Pitch (thousandths of radians)
aRoll  The Roll (thousandths of radians)
Returns:
-
IMPORT_C void COrientation::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.

Parameters:
aFrontX  X value of Front vector
aFrontY  Y value of Front vector
aFrontZ  Z value of Front vector
aAboveX  X value of Above vector
aAboveY  Y value of Above vector
aAboveZ  Z value of Above vector
Returns:
-

Field Documentation

TEfOrientationDataPckg COrientation::iDataPckgFrom [protected]
 
TEfOrientationDataPckg COrientation::iDataPckgTo [protected]
 
TEfOrientation COrientation::iOrientationData [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top