====== ThinkGeo.MapSuite.Core.TileCache ====== {{section>upgrade_map_suite_to_10.0}} This is the base class for TileCache system. ===== Inheritance Hierarchy ===== *System.Object ***ThinkGeo.MapSuite.Core.TileCache** *[[ThinkGeo.MapSuite.Core.BitmapTileCache]] *[[ThinkGeo.MapSuite.Core.NativeImageTileCache]] ===== Members Summary ===== ==== Public Constructors ==== ==== Protected Constructors ==== ** {{wiki:ProtectedMethod.gif|}} TileCache(String,TileImageFormat,TileMatrix) ** * //This is the constructor of the class.// == Remarks == * //N/A// == Parameters == * //cacheId// * Type:String * Description:This is the cache identifier which marks its difference with other TileCache. * //imageFormat// * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] * Description:This is the imageFormate showing what kind of image we are trying to save. * //tileMatrix// * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] * Description:This is the tile matrix system which is used for caculating tiles.
==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} SaveTile(Tile) ** * //This method will save the target tile passed in.// == Remarks == * //This method will not take effect when the ReadOnly is set to true.// == Return Value == * Type:Void * Description:N/A == Parameters == * //tile// * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] * Description:The target tile to be saved.
** {{wiki:PublicMethod.gif|}} SaveTiles(GeoImage,RectangleShape) ** * //This method will save the bitmap with its extent attached into tiles.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bitmap// * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] * Description:The target bitmap to be saved into tiles. * //bitmapExtent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:The target extent for the bitmap.
** {{wiki:PublicMethod.gif|}} DeleteTiles(RectangleShape) ** * //This method will delete the tiles within the passed in worldExtent.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //worldExtent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:The target extent to delete all tiles within it.
** {{wiki:PublicMethod.gif|}} DeleteTile(Tile) ** * //This method will delete the target tile passed in.// == Remarks == * //This method will not take effect when the ReadOnly is set to true.// == Return Value == * Type:Void * Description:N/A == Parameters == * //tile// * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] * Description:The target tile to be deleted.
** {{wiki:PublicMethod.gif|}} ClearCache() ** * //This method will clear all the tiles in the tileCache.// == Remarks == * //This method will not take effect when the ReadOnly is set to true.// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} ClearCacheCore() ** * //This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method.// == Remarks == * //This method will not take effect when the ReadOnly is set to true.// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) ** * //This abstract method will save the target tile passed in, for each sub TileCache class must implement this method.// == Remarks == * //This method will not take effect when the ReadOnly is set to true.// == Return Value == * Type:Void * Description:N/A == Parameters == * //tile// * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] * Description:The target tile to be saved.
** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) ** * //This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method.// == Remarks == * //This method will not take effect when the ReadOnly is set to true.// == Return Value == * Type:Void * Description:N/A == Parameters == * //tile// * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] * Description:The target tile to be deleted.
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} TileMatrix ** * //Gets or sets the TileMatrix which is used in caculation for tiles.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] ** {{wiki:PublicProperty.gif|}} TileAccessMode ** * //Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete// == Remarks == * //If you want it to take effect, you need set the ReadOnly property false.// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] ** {{wiki:PublicProperty.gif|}} NoDataTileImage ** * //This property returns back a preset image showing the tile data is missing.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] ** {{wiki:PublicProperty.gif|}} LoadingTileImage ** * //This property returns back a preset image showing the Tile is loading.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] ** {{wiki:PublicProperty.gif|}} ImageFormat ** * //Gets or sets the tile image format.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] ** {{wiki:PublicProperty.gif|}} JpegQuality ** * //Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.// == Remarks == * //N/A// == Return Value == * Type:Int16 ** {{wiki:PublicProperty.gif|}} CacheId ** * //Gets or sets the id of the TileCache.// == Remarks == * //N/A// == Return Value == * Type:String ==== Protected Properties ==== ==== Public Events ====