Collapse all Symbian^3 Application Developer Library

TMnMapImageParams Class Reference

class TMnMapImageParams

Container class for map image rendering parameters. It stores following parameters:

center coordinate of map image,
size of the image,
image scale
image direction
type of image

Since

5.0

Public Member Functions
	TMnMapImageParams ()
TReal32	Direction ()
void	GetCenterPoint ( TCoordinate &)
void	GetVisibleArea ( TReal32 &, TReal32 &)
TMapImageType	ImageType ()
TInt	ProjectionId ()
void	SetCenterPoint (const TCoordinate &)
void	SetDirection ( TReal32 )
void	SetImageType ( TMapImageType )
void	SetProjectionId ( TInt )
void	SetSize (const TSize &)
void	SetVisibleArea ( TReal32 , TReal32 )
TSize	Size ()

Public Member Enumerations
enum	TMapImageType { ETypeUnspecified = 0x00, ETypeVectorMap = 0x01, ETypeSatelliteImage = 0x02 }

Public Member Type Definitions
typedef	TUint32 TMapImageTypes

Private Attributes
TReal32	iAreaHeight
TReal32	iAreaWidth
TCoordinate	iCenterPoint
TReal32	iDirection
TMapImageType	iImageType
TInt	iProjectionId
TSize	iSize
TInt8	reserved

Constructor & Destructor Documentation

TMnMapImageParams()

IMPORT_C

TMnMapImageParams

(

)

Member Functions Documentation

Direction()

TReal32

Direction

(

)

const [inline]

Returns selected direction of the map. For details of direction definition, see SetDirection() .

GetCenterPoint(TCoordinate &)

void

GetCenterPoint

(

TCoordinate &

aCoordinate

)

const [inline]

Returns world location, selected by client as the map center.

Parameters

TCoordinate & aCoordinate

Coordinate of map's center.

GetVisibleArea(TReal32 &, TReal32 &)

void	GetVisibleArea	(	TReal32 &	aWidth,
			TReal32 &	aHeight
		)	const [inline]

Returns the width and heigth of the world area to be covered by the map image. These two parameters define an ellipse, covering the world area, which is required to be visible on the map. Actual visible area can be larger, if given image size and area have different aspect ratios.

Parameters

TReal32 & aWidth	The length in meters of the line, orthogonal to the image direction and going through center point
TReal32 & aHeight	The length in meters of the line, parallel to the image direction and going through center point

ImageType()

TMapImageType

ImageType

(

)

const [inline]

Returns type of last rendered map image. (It always matches the value specified by client in SetImageType except if ETypeUnspecified is given by client.)

ProjectionId()

TInt

ProjectionId

(

)

[inline]

Sets internal ID of a projection used by renderer. It is meaningful if provider supports several projections. Currently must not be used by clients, only for internal purposes of provider application.

SetCenterPoint(const TCoordinate &)

void

SetCenterPoint

(

const TCoordinate &

aCoordinate

)

[inline]

Sets a world coordinate as a center of desired image.

Parameters

const TCoordinate & aCoordinate

World location to be center of rendered map.

SetDirection(TReal32)

void

SetDirection

(

TReal32

aDirection

)

[inline]

Sets required direction of the map. Image direction is defined as clockwise angle between two vectors:

a. vector from center point towards true North Pole parallel to center s longitude. If center is positioned at North Pole, then this vector is directed towards South Pole parallel to center s longitude.
b. vector from center point (see SetCenterPoint() ) towards center of image s top side.

This direction parameter can be thought of as "true heading" of the image.

Parameters

TReal32 aDirection

Direction in degrees.

SetImageType(TMapImageType)

void

SetImageType

(

TMapImageType

aImageType

)

[inline]

Sets desired type of map image. If set, then rendering will provide (if supported) maps of specified type. Default value is ETypeUnspecified, which allows provider to select best suitable image for given scale, center etc.

Parameters

TMapImageType aImageType

SetProjectionId(TInt)

void

SetProjectionId

(

TInt

aProjectionId

)

[inline]

Sets internal ID of a projection used by renderer. It is useful if provider supports several projections. Currently must not be used by clients, only for internal purposes of provider application.

Parameters

TInt aProjectionId

Renderer'd internal id of used projection

SetSize(const TSize &)

void

SetSize

(

const TSize &

aImageSize

)

[inline]

Sets size of desired map image in pixels.

Parameters

const TSize & aImageSize

Width and height of the map image.

SetVisibleArea(TReal32, TReal32)

void	SetVisibleArea	(	TReal32	aWidth,
			TReal32	aHeight
		)	[inline]

Sets the width and heigth of the world area to be covered by the map image. These two parameters define an ellipse, covering the world area, which is required to be visible on the map. Actual visible area can be larger, if given image size and area have different aspect ratios.

Parameters

TReal32 aWidth	The length in meters of the line, orthogonal to the image direction and going through center point
TReal32 aHeight	The length in meters of the line, parallel to the image direction and going through center point

Size()

TSize

Size

(

)

const [inline]

Returns size of desired map image in pixels.

Member Enumerations Documentation

Enum TMapImageType

Types of map images

Enumerators

ETypeUnspecified = 0x00	Type is unknown or unspecified
ETypeVectorMap = 0x01	Scalable graphical maps (e.g. street maps)
ETypeSatelliteImage = 0x02	Image built of satellite photographs of Earth