Views
Maps Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvMapTileLoader Class Referenceabstract

The base abstract class for tile loaders specialized in loading map formats. More...

#include <ilviews/maps/format/maptloader.h>

Inheritance diagram for IlvMapTileLoader:
IlvTileLoader IlvGeoTIFFTileLoader IlvImageTileLoader IlvShapeFileTileLoader

Public Member Functions

virtual IlvFeatureRenderergetDefaultFeatureRenderer (IlvDisplay *display)=0
 Returns the default feature renderer used for the rendering of map features of the current tile. More...
 
virtual IlvMapFeatureIteratorgetFeatureIterator (IlvTile *tile)=0
 Returns the feature iterator to read features for the specified tile. More...
 
virtual IlvFeatureRenderergetFeatureRenderer (IlvDisplay *display)
 Returns the renderer to use with this tile loader. More...
 
IlvMapsError getInitStatus () const
 Checks the initialization status of this tile loader. More...
 
virtual IlvMapInfogetMapInfo ()=0
 Returns the IlvMapInfo used to generate the IlvGraphic objects. More...
 
virtual IlBoolean isAttachingAttributes () const
 Test if this tile loader is attaching attributes. More...
 
IlBoolean isOwnerOfRenderer () const
 Returns whether the tile loader is owner of its feature renderer or not. More...
 
virtual IlBoolean isPersistent () const =0
 Returns IlTrue if this tile loader must be saved by a tile controller. More...
 
virtual IlvMapsError load (IlvTile *tile)
 Method called when a tile has to be loaded. More...
 
virtual void release (IlvTile *tile)
 Releases the specified tile. More...
 
virtual void setAttachingAttributes (IlBoolean set)
 Specifies whether this tile loader is attaching attributes to the graphic objects it loads. More...
 
virtual void setFeatureRenderer (IlvFeatureRenderer *renderer, IlBoolean owner=IlFalse)
 Sets the renderer to use with this tile loader. More...
 
- Public Member Functions inherited from IlvTileLoader
virtual void controllerDeleted (IlvTileController *controller)
 Called when the controller is deleted. More...
 
virtual void tileDeleted (IlvTile *tile)
 Called when a tile is deleted during the controller destruction. More...
 

Protected Member Functions

 IlvMapTileLoader ()
 Constructor. More...
 
void setInitStatus (IlvMapsError status)
 Sets the error status of the tile loader. More...
 

Detailed Description

The base abstract class for tile loaders specialized in loading map formats.

Library: ilvmaps

This default implementation of an IlvTileLoader can load data from any data set on which IlvMapFeatureIterator can be constructed for a given tile.
This default implementation can also take advantage of classes implementing IlvLookAheadFeatureIterator.

Constructor & Destructor Documentation

◆ IlvMapTileLoader()

IlvMapTileLoader::IlvMapTileLoader ( )
protected

Constructor.

This class can only be instantiated by subclasses.

Member Function Documentation

◆ getDefaultFeatureRenderer()

virtual IlvFeatureRenderer* IlvMapTileLoader::getDefaultFeatureRenderer ( IlvDisplay display)
pure 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
displayThe IlvDisplay
Returns
The default feature renderer.

Implemented in IlvShapeFileTileLoader, IlvImageTileLoader, and IlvGeoTIFFTileLoader.

◆ getFeatureIterator()

virtual IlvMapFeatureIterator* IlvMapTileLoader::getFeatureIterator ( IlvTile tile)
pure virtual

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

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

Implemented in IlvShapeFileTileLoader, IlvImageTileLoader, and IlvGeoTIFFTileLoader.

◆ getFeatureRenderer()

virtual IlvFeatureRenderer* IlvMapTileLoader::getFeatureRenderer ( IlvDisplay display)
virtual

Returns the renderer to use with this tile loader.

Returns
The renderer to use with this tile loader.

◆ getInitStatus()

IlvMapsError IlvMapTileLoader::getInitStatus ( ) const

Checks the initialization status of this tile loader.

Returns
IlvMaps::NoError() if the initialization of this tile loader is successful, or an error code if an error occurred during the initalization.

◆ getMapInfo()

virtual IlvMapInfo* IlvMapTileLoader::getMapInfo ( )
pure virtual

Returns the IlvMapInfo used to generate the IlvGraphic objects.

Returns
The IlvMapInfo used to generate the IlvGraphic objects.

Implemented in IlvShapeFileTileLoader, IlvImageTileLoader, and IlvGeoTIFFTileLoader.

◆ isAttachingAttributes()

virtual IlBoolean IlvMapTileLoader::isAttachingAttributes ( ) const
virtual

Test if this tile loader is attaching attributes.

Returns
IlTrue if this tile loader is attaching attributes to the graphic objects it loads, when these are available, and IlFalse otherwise. The default is IlTrue.

◆ isOwnerOfRenderer()

IlBoolean IlvMapTileLoader::isOwnerOfRenderer ( ) const

Returns whether the tile loader is owner of its feature renderer or not.

See also
IlvMapTileLoader::setFeatureRenderer()

◆ isPersistent()

virtual IlBoolean IlvMapTileLoader::isPersistent ( ) const
pure virtual

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

Returns
IlTrue if this tile loader must be saved.

Implements IlvTileLoader.

Implemented in IlvShapeFileTileLoader, IlvImageTileLoader, and IlvGeoTIFFTileLoader.

◆ load()

virtual IlvMapsError IlvMapTileLoader::load ( IlvTile tile)
virtual

Method called when a tile has to be loaded.

The default implementation gets the feature iterator for the tile to load by using getFeatureIterator(), and then adds all the objects to the tile using the feature renderer of this tile loader.

If getFeatureIterator() returns 0, the specified tile is assumed to be inexistent and tile->loadComplete() is called.

Parameters
tileThe tile to load.
Returns
An IlvMapsError if an error occurs when loading objects from the specified tile.

Implements IlvTileLoader.

◆ release()

virtual void IlvMapTileLoader::release ( IlvTile tile)
virtual

Releases the specified tile.

The default implementation callsn tile->deleteAll()

Parameters
tileThe tile to release.

Implements IlvTileLoader.

◆ setAttachingAttributes()

virtual void IlvMapTileLoader::setAttachingAttributes ( IlBoolean  set)
virtual

Specifies whether this tile loader is attaching attributes to the graphic objects it loads.

Parameters
setIf IlTrue, attributes are attached.

◆ setFeatureRenderer()

virtual void IlvMapTileLoader::setFeatureRenderer ( IlvFeatureRenderer renderer,
IlBoolean  owner = IlFalse 
)
virtual

Sets the renderer to use with this tile loader.

Parameters
rendererThe feature renderer.
ownerIf this parameter is set to IlTrue, then the tile loader destructor will delete the renderer passed as first argument.

◆ setInitStatus()

void IlvMapTileLoader::setInitStatus ( IlvMapsError  status)
protected

Sets the error status of the tile loader.

Parameters
statusThe initialization error code.