IlvTile Class Reference

This class represents the elementary element used by the load-on-demand process. More...

#include <ilviews/maps/tiling/tile.h>

Public Member Functions
void	addObject (IlvGraphic *g, IlvMapFeatureId *id=0)
	Adds a graphic object to an IlvTiledLayer. More...
void	boundingBox (IlvRect &rect) const
	Returns the bounding box of the tile in the manager coordinate system. More...
void	deleteAll ()
	Empties the tile except for the objects that are shared by another non empty tile. More...
IlInt	getColumn () const
	Returns the column of the tile. More...
IlvTileController *	getController () const
	Returns the controller of the tile. More...
IlvDisplay *	getDisplay () const
	Returns the display of controller manager. More...
IlvGraphic *	getObject (IlvMapFeatureId *id) const
	Returns the object of the specified ID if it is already loaded in the layer. More...
IlInt	getRow () const
	Returns the row of the tile. More...
IlvTileStatus	getStatus () const
	Returns the status of the tile. More...
IlBoolean	isLoadComplete () const
	Returns IlTrue if the tile is fully loaded. More...
IlBoolean	isObjectShared (IlvGraphic *graphic) const
	Returns IlTrue if the object graphic is shared by other tiles. More...
void	loadComplete ()
	Notifies the tile that it has been fully loaded, thus, the method must be called by the tile loaders. More...
void	reDraw () const
	Redraws a tile. More...

Detailed Description

This class represents the elementary element used by the load-on-demand process.

Library: ilvmaps
A tile represents an elementary rectangular area that is loaded or released when needed by the application. Tiles are managed by an IlvTileController.

In most cases, the tile controller will be associated with an IlvTiledLayer. This means that the tiles represent areas that must be filled with graphic objects when they become visible due to the user of the application scrolling or zooming on a view.

More sophisticated applications can use a tile controller without attaching it to a layer, for example, to load data that is needed to process an area that becomes visible.

Member Function Documentation

addObject()

void IlvTile::addObject	(	IlvGraphic *	g,
		IlvMapFeatureId *	id = 0
	)

Adds a graphic object to an IlvTiledLayer.

When implementing an IlvTileLoader, objects should not be added to a manager using IlvManager::addObject. This method must be called only if the tile controller is attached to a layer.

Parameters

g	The graphic object to be added.
id	The ID of the object. This parameter can be set to 0. The ID is owned by the tile and will be deleted when the tile will be released.

See also

getObject(), IlvTileLoader.

boundingBox()

void IlvTile::boundingBox

(

IlvRect &

rect

)

const

Returns the bounding box of the tile in the manager coordinate system.

Parameters

rect	The returned IlvRect object containing the bounding box.

deleteAll()

void IlvTile::deleteAll

(

)

Empties the tile except for the objects that are shared by another non empty tile.

This method must be called only if the tile controller is attached to a layer.

getColumn()

IlInt IlvTile::getColumn

(

)

const

Returns the column of the tile.

Returns

The column of the tile.

getController()

IlvTileController* IlvTile::getController

(

)

const

Returns the controller of the tile.

Returns

The IlvTileController object that controls this tile.

getDisplay()

IlvDisplay* IlvTile::getDisplay

(

)

const

Returns the display of controller manager.

Returns

The display instance for this tile.

getObject()

IlvGraphic* IlvTile::getObject

(

IlvMapFeatureId *

id

)

const

Returns the object of the specified ID if it is already loaded in the layer.

This method must be called only if the tile is attached to a layer.

Parameters

id	The ID of the object.

Returns

The corresponding object.

See also

addObject().

getRow()

IlInt IlvTile::getRow

(

)

const

Returns the row of the tile.

Returns

The row of the tile.

getStatus()

IlvTileStatus IlvTile::getStatus

(

)

const

Returns the status of the tile.

Returns

The status of the tile.

See also

IlvTileStatus

isLoadComplete()

IlBoolean IlvTile::isLoadComplete

(

)

const

Returns IlTrue if the tile is fully loaded.

Returns

IlTrue if the load is complete and IlFalse otherwise.

See also

loadComplete().

isObjectShared()

IlBoolean IlvTile::isObjectShared

(

IlvGraphic *

graphic

)

const

Returns IlTrue if the object graphic is shared by other tiles.

This method must be called only if the tile controller is attached to a layer. This method only tests objects against currently locked or cached tiles.

Parameters

graphic

The graphic object.

Returns

IlTrue if the object is shared and IlFalse otherwise.

loadComplete()

void IlvTile::loadComplete

(

)

Notifies the tile that it has been fully loaded, thus, the method must be called by the tile loaders.

See also

IlvTileLoader.

reDraw()

void IlvTile::reDraw

(

)

const

Redraws a tile.

Should be called only if the tile is attached to a layer.