IlvMapCoordViewer Class Reference

Displays the coordinates of the mouse when it is on top of an IlvView displaying a map. More...

#include <ilviews/maps/gui/coordview.h>

Inheritance diagram for IlvMapCoordViewer:

List of all members.

Public Member Functions
	IlvMapCoordViewer (IlvDisplay *display, const IlvPoint &pos, IlvPalette *palette=0)
	Constructor.
	IlvMapCoordViewer (IlvDisplay *display, const IlvRect &rect, IlvPalette *palette=0)
	Constructor.
const char *	getEastingFormat ()
	Retrieves the easting format.
const char *	getEastinglabel ()
	Retrieves the easting label.
const char *	getNorthingFormat ()
	Retrieves the northing format.
const char *	getNorthinglabel ()
	Retrieves the northing label.
IlBoolean	isDisplayingEasting ()
	Checks if the object is displaying easting values.
IlBoolean	isDisplayingNorthing ()
	Checks if the object is displaying northing values.
void	setDisplayingEasting (IlBoolean displayEasting, IlBoolean redraw=IlFalse)
	Specifies whether the coordinate viewer should display the easting value of the mouse coordinates.
void	setDisplayingNorthing (IlBoolean displayNorthing, IlBoolean redraw=IlFalse)
	Specifies whether the coordinate viewer should display the northing value of the mouse coordinates.
void	setDisplayMode (IlvMapCoordViewerMode mode, IlBoolean redraw=IlFalse)
	Specifies the display mode of the mouse coordinates.
void	setEastingFormat (const char *format, IlBoolean redraw=IlFalse)
	Sets the easting format.
void	setEastinglabel (const char *label, IlBoolean redraw=IlFalse)
	Sets the prompt string to be displayed before the easting value.
void	setNorthingFormat (const char *format, IlBoolean redraw=IlFalse)
	Sets the northing format.
void	setNorthinglabel (const char *, IlBoolean redraw=IlFalse)
	Sets the prompt string to be displayed before the northing value.
void	setVertical (IlBoolean vertical, IlBoolean redraw=IlFalse)
	Sets the orientation of the display.
void	setView (IlvView *view)
	Sets the view for which coordinates are to be displayed.

---

Detailed Description

Displays the coordinates of the mouse when it is on top of an IlvView displaying a map.

Library: ilvmaps

The coordinates can be displayed in two modes:

• IlvMapCartesianMode: The coordinates are displayed in the projection coordinate system of the manager.
• IlvMapDMSMode: The coordinates are displayed in degrees, minutes and seconds in the geographic projection. This mode works only if the manager of the view that controls the coordinate viewer has an IlvMapInfo property. The coordinate viewer will then use the projection to convert the mouse coordinates in the geographic projection.

---

Constructor & Destructor Documentation

IlvMapCoordViewer::IlvMapCoordViewer	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlvPalette *	palette = 0
	)

Constructor.

Parameters:

	display	The IlvDisplay.
	rect	The position and dimension of the object.
	palette	The IlvPalette.

IlvMapCoordViewer::IlvMapCoordViewer	(	IlvDisplay *	display,
		const IlvPoint &	pos,
		IlvPalette *	palette = 0
	)

Constructor.

Parameters:

	display	The IlvDisplay.
	pos	The position of the upper left point of the object. A size is then automatically computed.
	palette	The IlvPalette.

---

Member Function Documentation

const char* IlvMapCoordViewer::getEastingFormat

(

)

Retrieves the easting format.

Returns:

The easting format. This string is still owned by the object.

const char* IlvMapCoordViewer::getEastinglabel

(

)

Retrieves the easting label.

Returns:

The easting label. The string is still owned by the IlvMapCoordViewer.

const char* IlvMapCoordViewer::getNorthingFormat

(

)

Retrieves the northing format.

Returns:

The northing format. This string is still owned by the object.

const char* IlvMapCoordViewer::getNorthinglabel

(

)

Retrieves the northing label.

Returns:

The northing label. This string is still owned by the IlvMapCoordViewer.

IlBoolean IlvMapCoordViewer::isDisplayingEasting

(

)

Checks if the object is displaying easting values.

Returns:

IlTrue if object is displaying easting, IlFalse otherwise.

IlBoolean IlvMapCoordViewer::isDisplayingNorthing

(

)

Checks if the object is displaying northing values.

Returns:

IlTrue if object is displaying northing, IlFalse otherwise.

void IlvMapCoordViewer::setDisplayingEasting	(	IlBoolean	displayEasting,
		IlBoolean	redraw = IlFalse
	)

Specifies whether the coordinate viewer should display the easting value of the mouse coordinates.

The coordinate viewer can be used to display either the easting value or the northing value of the coordinates, or both.

Parameters:

	displayEasting	If set to IlTrue, easting is displayed.
	redraw	Specifies if the object is to be redrawn.

void IlvMapCoordViewer::setDisplayingNorthing	(	IlBoolean	displayNorthing,
		IlBoolean	redraw = IlFalse
	)

Specifies whether the coordinate viewer should display the northing value of the mouse coordinates.

The coordinate viewer can be used to display either the northing value or the northing value of the coordinates, or both.

Parameters:

	displayNorthing	If set to IlTrue, northing is displayed.
	redraw	Specifies if the object is to be redrawn.

void IlvMapCoordViewer::setDisplayMode	(	IlvMapCoordViewerMode	mode,
		IlBoolean	redraw = IlFalse
	)

Specifies the display mode of the mouse coordinates.

Parameters:

	mode	The display mode.
	redraw	Specifies if the object is to be redrawn.

void IlvMapCoordViewer::setEastingFormat	(	const char *	format,
		IlBoolean	redraw = IlFalse
	)

Sets the easting format.

This string is used to format the value of the easting coordinate in Cartesian mode. The default value is 1.6f. This string is copied by the object.

Parameters:

	format	The easting format.
	redraw	Specifies if the object is to be redrawn.

void IlvMapCoordViewer::setEastinglabel	(	const char *	label,
		IlBoolean	redraw = IlFalse
	)

Sets the prompt string to be displayed before the easting value.

The default value is "X = ".

Parameters:

	label	The easting label. This string is copied by the object.
	redraw	Specifies if the object is to be redrawn.

void IlvMapCoordViewer::setNorthingFormat	(	const char *	format,
		IlBoolean	redraw = IlFalse
	)

Sets the northing format.

This string is used to format the value of the northing coordinate in Cartesian mode. The default value is 1.6f. This string is copied by the object.

Parameters:

	format	The northing format.
	redraw	Specifies if the object is to be redrawn.

void IlvMapCoordViewer::setNorthinglabel	(	const char *	,
		IlBoolean	redraw = IlFalse
	)

Sets the prompt string to be displayed before the northing value.

The default value is "Y = ".

Parameters:

	label	The northing label. This string is copied by the object.
	redraw	Specifies if the object is to be redrawn.

void IlvMapCoordViewer::setVertical	(	IlBoolean	vertical,
		IlBoolean	redraw = IlFalse
	)

Sets the orientation of the display.

Parameters:

	vertical	If set to IlTrue the northing value is displayed under the easting value. If set to IlFalse, the northing value is displayed to the right of the easting value.
	redraw	Specifies if the object is to be redrawn.

void IlvMapCoordViewer::setView

(

IlvView *

view

)

Sets the view for which coordinates are to be displayed.

Parameters:

view

The view for which coordinates are to be displayed.