thinkgeo.mapsuite.core.bitmaptilecache
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
thinkgeo.mapsuite.core.bitmaptilecache [2015/09/22 08:15] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.BitmapTileCache ====== | ||
| - | This is the base class for BitmapTileCache system which inherits from TileCache class. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | *ThinkGeo.MapSuite.Core.TileCache | ||
| - | ***ThinkGeo.MapSuite.Core.BitmapTileCache** | ||
| - | *[[ThinkGeo.MapSuite.Core.FileBitmapTileCache]] | ||
| - | *[[ThinkGeo.MapSuite.Core.InMemoryBitmapTileCache]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ==== Protected Constructors ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} BitmapTileCache(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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} GetTile(RectangleShape) ** | ||
| - | |||
| - | * //This method returns the BitmapTile corresponding to the tile bounding box passed in.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | ||
| - | * Description:Returns the BitmapTile corresponding to the passed in boundingBox. | ||
| - | |||
| - | == Parameters == | ||
| - | * //tileBoundingBox// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:The target boundingBox for the tile to fetch. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetTile(Int64,Int64) ** | ||
| - | |||
| - | * //This method returns the BitmapTile corresponding to passed in row and column.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | ||
| - | * Description:Returns the BitmapTile corresponding to the passed in row and column. | ||
| - | |||
| - | == Parameters == | ||
| - | * //row// | ||
| - | * Type:Int64 | ||
| - | * Description:The target row for the tile to fetch. | ||
| - | |||
| - | * //column// | ||
| - | * Type:Int64 | ||
| - | * Description:The target column for the tile to fetch. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetTiles(RectangleShape) ** | ||
| - | |||
| - | * //This method returns all the BitmapTiles within the passed in world extent, some of which may not has bitmap.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]> | ||
| - | * Description:Returns a collection of BitmapTiles within the passed in worldExtent. | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldExtent// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:The target worldExtent will be used to fetch all the BitmapTiles from. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHigherScaleTile(RectangleShape,Double) ** | ||
| - | |||
| - | * //This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | ||
| - | * Description:Returns the higher scale(higher zoomLevel) bitmap tile. | ||
| - | |||
| - | == Parameters == | ||
| - | * //tileBoundingBox// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:The parameter specifies the current tile bounding box. | ||
| - | |||
| - | * //tileScale// | ||
| - | * Type:Double | ||
| - | * Description:This parameter specifies the current tile scale. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveTile(Tile) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //tile// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape,Boolean) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //bitmap// | ||
| - | * Type:Bitmap | ||
| - | * Description:N/A | ||
| - | |||
| - | * //bitmapExtent// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //saveContainedCellsOnly// | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //bitmap// | ||
| - | * Type:Bitmap | ||
| - | * Description:N/A | ||
| - | |||
| - | * //bitmapExtent// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} DeleteTiles(RectangleShape) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldExtent// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} DeleteTile(Tile) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //tile// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ClearCache() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetTileCore(Int64,Int64) ** | ||
| - | |||
| - | * //This abstract method returns the BitmapTile corresponding to passed in row and column. Each concrete TileCache need to implement this logic to get tile from a row and column.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | ||
| - | * Description:Returns the BitmapTile corresponding to the passed in row and column. | ||
| - | |||
| - | == Parameters == | ||
| - | * //row// | ||
| - | * Type:Int64 | ||
| - | * Description:The target row for the tile to fetch. | ||
| - | |||
| - | * //column// | ||
| - | * Type:Int64 | ||
| - | * Description:The target column for the tile to fetch. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetHigherScaleTileCore(RectangleShape,Double) ** | ||
| - | |||
| - | * //This method is virtual and can be overriden by its sub classes. This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | ||
| - | * Description:Returns the higher scale(higher zoomLevel) bitmap tile. | ||
| - | |||
| - | == Parameters == | ||
| - | * //tileBoundingBox// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:The parameter specifies the current tile bounding box. | ||
| - | |||
| - | * //tileScale// | ||
| - | * Type:Double | ||
| - | * Description:This parameter specifies the current tile scale. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MergeBitmaps(IEnumerable<BitmapTile>,Double) ** | ||
| - | |||
| - | * //This method will merege the passed in bitmap tiles into a larege bitmap tile.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | ||
| - | * Description:Returns a merged bitmap tile. | ||
| - | |||
| - | == Parameters == | ||
| - | * //tilesToMerge// | ||
| - | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]> | ||
| - | * Description:The collection of tiles to be mereged. | ||
| - | |||
| - | * //scale// | ||
| - | * Type:Double | ||
| - | * Description:The target scale for result mereged bitmap tile. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} ClearCacheCore() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //tile// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //tile// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} TileMatrix ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TileAccessMode ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} NoDataTileImage ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Bitmap | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} LoadingTileImage ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Bitmap | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ImageFormat ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} JpegQuality ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Int16 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} CacheId ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} GottenCacheImage ** | ||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]] | ||
| - | |||
| - | ** {{wiki:PublicEvent.gif|}} GettingCacheImage ** | ||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]] | ||
| - | |||
thinkgeo.mapsuite.core.bitmaptilecache.1442909722.txt.gz ยท Last modified: 2015/09/22 08:15 by admin
