rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
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...
 
IlvTileControllergetController () const
 Returns the controller of the tile. More...
 
IlvDisplaygetDisplay () const
 Returns the display of controller manager. More...
 
IlvGraphicgetObject (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

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
gThe graphic object to be added.
idThe ID of the object. This parameter can take the null value. The ID is owned by the tile and will be deleted when the tile will be released.
See Also
IlvTile::getObject
IlvTileLoader
void IlvTile::boundingBox ( IlvRect rect) const

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

Parameters
rectThe returned IlvRect object containing the bounding box.
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.

IlInt IlvTile::getColumn ( ) const

Returns the column of the tile.

Returns
The column of the tile.
IlvTileController* IlvTile::getController ( ) const

Returns the controller of the tile.

Returns
The IlvTileController object that controls this tile.
IlvDisplay* IlvTile::getDisplay ( ) const

Returns the display of controller manager.

Returns
The IlvDisplay.
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
idThe ID of the object.
Returns
The corresponding object.
See Also
IlvTile::addObject
IlInt IlvTile::getRow ( ) const

Returns the row of the tile.

Returns
The row of the tile.
IlvTileStatus IlvTile::getStatus ( ) const

Returns the status of the tile.

Returns
The status of the tile.
See Also
IlvTileStatus
IlBoolean IlvTile::isLoadComplete ( ) const

Returns IlTrue if the tile is fully loaded.

Returns
IlTrue if the load is complete, IlFalse otherwise.
See Also
IlvTile::loadComplete.
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
graphicThe graphic object.
Returns
IlTrue if the object is shared, IlFalse otherwise.
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.
void IlvTile::reDraw ( ) const

Redraws a tile.

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


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.