CImagePanorama Class Reference

#include <panorama/panorama.h>

Link against: panorama.lib

class CImagePanorama : public CBase

Inherits from

CImagePanorama
- CBase

Public Member Functions
	~CImagePanorama()
IMPORT_C void	AddBufferL(const TDesC8 &, CPanoramaTransform &)
IMPORT_C void	AddFileL(const TDesC &, CPanoramaTransform &)
IMPORT_C void	AddImageL(const CFbsBitmap &, CPanoramaTransform &)
IMPORT_C void	AddImageL(const CImageFrame &, CPanoramaTransform &)
IMPORT_C void	CurrentImageSizeL(TSize &)
IMPORT_C TAny *	Extension(TUid)
IMPORT_C void	InitializeL(const TSize &, const TPanoramaLens &, const TDirection &)
IMPORT_C CImagePanorama *	NewL()
IMPORT_C void	RenderL(const TDesC &)
IMPORT_C void	RenderL(const TDesC &, const TSize &, const TBool, const TUid &)
IMPORT_C void	RenderL(RFile &)
IMPORT_C void	RenderL(RFile &, const TSize &, const TBool, const TUid &)
IMPORT_C void	RenderL(HBufC8 *&)
IMPORT_C void	RenderL(HBufC8 *&, TUint32, const TSize &, const TBool, const TUid &)
IMPORT_C void	RenderL(const CFbsBitmap &)
IMPORT_C void	RenderL(const CFbsBitmap &, const TBool)
IMPORT_C void	RenderL(const CImageFrame &)
IMPORT_C void	RenderL(const CImageFrame &, const TBool)

Inherited Functions
	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()

Detailed Description

This class provides functions to get basic stitching. Input can be a file, descriptor, bitmap, imageframe.

Constructor & Destructor Documentation

~CImagePanorama ( )

IMPORT_C

~CImagePanorama

(

)

Member Function Documentation

AddBufferL ( const TDesC8 &, CPanoramaTransform & )

IMPORT_C void	AddBufferL	(	const TDesC8 &	aData,
			CPanoramaTransform &	aPanTrans
		)

Add an image to the panorama creation

Parameters
aData	The buffer containing the image data
aPanTrans	Panorama transform object

AddFileL ( const TDesC &, CPanoramaTransform & )

IMPORT_C void	AddFileL	(	const TDesC &	aFilename,
			CPanoramaTransform &	aPanTrans
		)

Add an image to the panorama creation

Parameters
aFilename	Input filename
aPanTrans	Panorama transform object

AddImageL ( const CFbsBitmap &, CPanoramaTransform & )

IMPORT_C void	AddImageL	(	const CFbsBitmap &	aBitmap,
			CPanoramaTransform &	aPanTrans
		)

Add an image to the panorama creation in progress

Parameters
aBitmap	A bitmap that will contain the image
aPanTrans	Panorama transform object

AddImageL ( const CImageFrame &, CPanoramaTransform & )

IMPORT_C void	AddImageL	(	const CImageFrame &	aImageFrame,
			CPanoramaTransform &	aPanTrans
		)

Add an image to the panorama creation in progress

Parameters
aImageFrame	A imageframe object.
aPanTrans	Panorama transform object.

CurrentImageSizeL ( TSize & )

IMPORT_C void

CurrentImageSizeL

(

TSize &

aSize

)

Retrieves the dimensions of the current session image.

Parameters
aSize	Dimensions of the image.

Extension ( TUid )

IMPORT_C TAny *

Extension

(

TUid

aExtension

)

Retrieves a non-standard extension on the image panorama.

Parameters
aExtension	The UID of the extension to be retrieved

Return Value: Extension corresponding to the UID given as a parameter.

InitializeL ( const TSize &, const TPanoramaLens &, const TDirection & )

IMPORT_C void	InitializeL	(	const TSize &	aSize,
			const TPanoramaLens &	aPanoramaLens,
			const TDirection &	aDirection
		)

Initialises the size, direction and panoramalens on plugin and creates the CCapsPanorama, CCapsPanoramaTransform objects.

Parameters
aSize	Size of the image.
aPanoramaLens	Panorama lens which is specific to camera
aDirection	Direction of the panorama

NewL ( )

IMPORT_C CImagePanorama *

NewL

(

)

[static]

Constructs a new image panorama object.

A leave occurs if there is insufficient memory available.

Return Value: A pointer to the new image panorama object.

RenderL ( const TDesC & )

IMPORT_C void

RenderL

(

const TDesC &

aFilename

)

Renders the currest session image to file.

Parameters
aFilename	Filename specifying where to store the output file.

RenderL ( const TDesC &, const TSize &, const TBool, const TUid & )

IMPORT_C void	RenderL	(	const TDesC &	aFilename,
			const TSize &	aSize,
			const TBool	aMaintainAspectRatio,
			const TUid &	aImageTypeUid
		)

Renders the current session image to file.

Parameters
aFilename	Filename specifying where to store the output file.
aSize	Dimensions of the output image.
aMaintainAspectRatio	Aspect ratio based on which output options will be defined
aImageTypeUid	The format Uid in which to encode the output image

RenderL ( RFile & )

IMPORT_C void

RenderL

(

RFile &

aFile

)

Renders the current session image to an open file handle.

Parameters
aFile	A file handler.

RenderL ( RFile &, const TSize &, const TBool, const TUid & )

IMPORT_C void	RenderL	(	RFile &	aFile,
			const TSize &	aSize,
			const TBool	aMaintainAspectRatio,
			const TUid &	aImageTypeUid
		)

Renders the current session image to an open file handle.

Parameters
aFile	A file handler
aSize	Dimensions of the output image.
aMaintainAspectRatio	Aspect ratio based on which output options will be defined.
aImageTypeUid	The format Uid in which to encode the output image.

RenderL ( HBufC8 *& )

IMPORT_C void

RenderL

(

HBufC8 *&

aDestData

)

Renders the current session image encoded to a buffer.

Parameters
aDestData	Pointer to a buffer which will recieve the encoded image data.

RenderL ( HBufC8 *&, TUint32, const TSize &, const TBool, const TUid & )

IMPORT_C void	RenderL	(	HBufC8 *&	aDestData,
			TUint32	aMaxBufferSize,
			const TSize &	aSize,
			const TBool	aMaintainAspectRatio,
			const TUid &	aImageTypeUid
		)

Renders the current session image encoded to a buffer.

Parameters
aDestData	Pointer to a buffer which will recieve the encoded image data.
aMaxBufferSize	The maximum size of the buffer in bytes.
aSize	Dimensions of the output image.
aMaintainAspectRatio	Aspect ratio based on which output options will be defined.
aImageTypeUid	The format Uid in which to encode the output image.

RenderL ( const CFbsBitmap & )

IMPORT_C void

RenderL

(

const CFbsBitmap &

aBitmap

)

Renders the output to a buffer in raw format.

Parameters
aBitmap	A bitmap to get the output image.

RenderL ( const CFbsBitmap &, const TBool )

IMPORT_C void	RenderL	(	const CFbsBitmap &	aBitmap,
			const TBool	aMaintainAspectRatio
		)

Renders the output to a buffer in raw format.

Parameters
aBitmap	A bitmap to get the output image.
aMaintainAspectRatio	Aspect ration based on which output options will be defined.

RenderL ( const CImageFrame & )

IMPORT_C void

RenderL

(

const CImageFrame &

aImageFrame

)

Renders the output to a buffer in raw format.

Parameters
aImageFrame	A imageframe object to get the output image.

RenderL ( const CImageFrame &, const TBool )

IMPORT_C void	RenderL	(	const CImageFrame &	aImageFrame,
			const TBool	aMaintainAspectRatio
		)

Renders the output to a buffer in raw format.

Parameters
aImageFrame	A imageframe object to get the output image.
aMaintainAspectRatio	Aspect ration based on which output options will be defined.