IlvImageTileLoader Class Reference

This class is an IlvMapTileLoader specialized for loading a set of images, each image representing a tile in a tiled data set. More...

#include <ilviews/maps/format/image/imgtloader.h>

Inheritance diagram for IlvImageTileLoader:

List of all members.

Public Member Functions
	IlvImageTileLoader (IlvDisplay *display, const char *pattern, const char *colFormat, const char *rowFormat, const IlvMapAdapter *adapter)
	constructor.
const char *	getColFormat () const
	Returns the column format specifier.
IlvFeatureRenderer *	getDefaultFeatureRenderer (IlvDisplay *display)
	Returns the default feature renderer used for the rendering of map features of the current tile.
virtual IlvMapFeatureIterator *	getFeatureIterator (IlvTile *tile)
	Returns the feature iterator to read features for the specified tile.
virtual const char *	getFileName (IlvTile *tile)
IlvMapInfo *	getMapInfo ()
	Returns the IlvMapInfo used to generate the IlvGraphic objects.
const char *	getPattern () const
	Returns the pattern specifier.
const char *	getRowFormat () const
	Returns the row format specifier.
virtual IlBoolean	isPersistent () const
	Returns IlTrue if this tile loader must be saved by a tile controller.

---

Detailed Description

This class is an IlvMapTileLoader specialized for loading a set of images, each image representing a tile in a tiled data set.

Library: ilvmaps

---

Constructor & Destructor Documentation

IlvImageTileLoader::IlvImageTileLoader	(	IlvDisplay *	display,
		const char *	pattern,
		const char *	colFormat,
		const char *	rowFormat,
		const IlvMapAdapter *	adapter
	)

constructor.

Creates an IlvImageTileLoader by specifying a pattern and two formats used to construct a file name for a given IlvTile. The pattern string must contain one r and one c specifier. When a tile is to be loaded, a file name is built by replacing the r conversion specifier with the row index of the tile, using the row format string. The same operation is performed for the column of the tile, replacing the c conversion specifier with the column index of the tile, using the column format string. For example, if the pattern is "<code>ADirectory/file_%c_%r_image.jpg</code>" and the colFormat is "%03d" and the colFormat is "%04d", the resulting file name for the tile at (12, 34) will be "<code>ADirectory/file_0034_012_image.jpg</code>".

Parameters:

	pattern	The file name pattern, containing one 'c' and one 'r'.
	colFormat	A formatting string that is interpreted as the regular C function printf used as the column specifier.
	rowFormat	A formatting string that is interpreted as the regular C function printf used as the row specifier.
	adapter	The IlvMapAdapter.

---

Member Function Documentation

const char* IlvImageTileLoader::getColFormat

(

)

const

Returns the column format specifier.

Returns:

The column format specifier.

IlvFeatureRenderer* IlvImageTileLoader::getDefaultFeatureRenderer

(

IlvDisplay *

display

)

[virtual]

Returns the default feature renderer used for the rendering of map features of the current tile.

This default feature renderer is used when the user does not set a feature renderer.

Parameters:

display

The IlvDisplay

Returns:

The default feature renderer.

Implements IlvMapTileLoader.

virtual IlvMapFeatureIterator* IlvImageTileLoader::getFeatureIterator

(

IlvTile *

tile

)

[virtual]

Returns the feature iterator to read features for the specified tile.

Parameters:

tile

The tile to load.

Returns:

The feature iterator to load features for this tile, or 0 if no features are to be loaded.

Implements IlvMapTileLoader.

virtual const char* IlvImageTileLoader::getFileName

(

IlvTile *

tile

)

[virtual]

Returns the file name corresponding to the tile tile. This file name is built using the pattern and the formats specified by the constructor of the class.

Parameters:

tile

The tile to be loaded.

Returns:

The resulting file name.

IlvMapInfo* IlvImageTileLoader::getMapInfo

(

)

[virtual]

Returns the IlvMapInfo used to generate the IlvGraphic objects.

Returns:

The IlvMapInfo used to generate the IlvGraphic objects.

Implements IlvMapTileLoader.

const char* IlvImageTileLoader::getPattern

(

)

const

Returns the pattern specifier.

Returns:

The pattern specifier.

const char* IlvImageTileLoader::getRowFormat

(

)

const

Returns the row format specifier.

Returns:

The row format specifier.

virtual IlBoolean IlvImageTileLoader::isPersistent

(

)

const [virtual]

Returns IlTrue if this tile loader must be saved by a tile controller.

Returns:

IlTrue if this tile loader must be saved.

Implements IlvMapTileLoader.