This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.bitmaptilecache [2015/09/17 10:25] admin |
thinkgeo.mapsuite.core.bitmaptilecache [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.BitmapTileCache ====== | ====== ThinkGeo.MapSuite.Core.BitmapTileCache ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This is the base class for BitmapTileCache system which inherits from TileCache class. | This is the base class for BitmapTileCache system which inherits from TileCache class. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 8: | Line 11: | ||
*[[ThinkGeo.MapSuite.Core.InMemoryBitmapTileCache]] | *[[ThinkGeo.MapSuite.Core.InMemoryBitmapTileCache]] | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
- | === Public Constructors === | + | ==== Public Constructors ==== |
- | === Protected Constructors === | + | ==== Protected Constructors ==== |
- | <div class_table> | + | ** {{wiki:ProtectedMethod.gif|}} BitmapTileCache(String,TileImageFormat,TileMatrix) ** |
- | **{{wiki:ProtectedMethod.gif|}}[[#BitmapTileCache(String,TileImageFormat,TileMatrix)|BitmapTileCache]]** | + | |
- | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]],[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This is the constructor of the class. | + | |
- | </div> | + | |
- | === Public Methods === | + | * //This is the constructor of the class.// |
- | <div class_table> | + | == Remarks == |
- | **{{wiki:PublicMethod.gif|}}[[#ClearCache()|ClearCache]]** | + | * //N/A// |
- | * **Parameters**:N/A | + | == Parameters == |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | * //cacheId// |
- | * **Summary**:N/A | + | * Type:String |
- | </div> | + | * Description:This is the cache identifier which marks its difference with other TileCache. |
- | <div class_table> | + | * //imageFormat// |
- | **{{wiki:PublicMethod.gif|}}[[#DeleteTile(Tile)|DeleteTile]]** | + | * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | + | * Description:This is the imageFormate showing what kind of image we are trying to save. |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //tileMatrix// |
- | **{{wiki:PublicMethod.gif|}}[[#DeleteTiles(RectangleShape)|DeleteTiles]]** | + | * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This is the tile matrix system which is used for caculating tiles. |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | ==== Public Methods ==== |
- | * **Parameters**:Object | + | ** {{wiki:PublicMethod.gif|}} GetTile(RectangleShape) ** |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //This method returns the BitmapTile corresponding to the tile bounding box passed in.// |
- | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //N/A// |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}[[#GetHigherScaleTile(RectangleShape,Double)|GetHigherScaleTile]]** | + | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double | + | * Description:Returns the BitmapTile corresponding to the passed in boundingBox. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut. | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:PublicMethod.gif|}}[[#GetTile(RectangleShape)|GetTile]]** | + | * //tileBoundingBox// |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **DeclaringType**:N/A | + | * Description:The target boundingBox for the tile to fetch. |
- | * **Summary**:This method returns the BitmapTile corresponding to the tile bounding box passed in. | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:PublicMethod.gif|}}[[#GetTile(Int64,Int64)|GetTile]]** | + | ** {{wiki:PublicMethod.gif|}} GetTile(Int64,Int64) ** |
- | * **Parameters**:Int64,Int64 | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns the BitmapTile corresponding to passed in row and column. | + | |
- | </div> | + | |
- | <div class_table> | + | * //This method returns the BitmapTile corresponding to passed in row and column.// |
- | **{{wiki:PublicMethod.gif|}}[[#GetTiles(RectangleShape)|GetTiles]]** | + | == Remarks == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //N/A// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method returns all the BitmapTiles within the passed in world extent, some of which may not has bitmap. | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] |
- | * **Parameters**:N/A | + | * Description:Returns the BitmapTile corresponding to the passed in row and column. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:PublicMethod.gif|}}[[#SaveTile(Tile)|SaveTile]]** | + | * //row// |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | + | * Type:Int64 |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | * Description:The target row for the tile to fetch. |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //column// |
- | **{{wiki:PublicMethod.gif|}}[[#SaveTiles(Bitmap,RectangleShape,Boolean)|SaveTiles]]** | + | * Type:Int64 |
- | * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Boolean | + | * Description:The target column for the tile to fetch. |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:PublicMethod.gif|}}[[#SaveTiles(Bitmap,RectangleShape)|SaveTiles]]** | + | ** {{wiki:PublicMethod.gif|}} GetTiles(RectangleShape) ** |
- | * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //This method returns all the BitmapTiles within the passed in world extent, some of which may not has bitmap.// |
- | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //N/A// |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Protected Methods === | + | == Return Value == |
- | <div class_table> | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]> |
- | **{{wiki:ProtectedMethod.gif|}}[[#ClearCacheCore()|ClearCacheCore]]** | + | * Description:Returns a collection of BitmapTiles within the passed in worldExtent. |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:ProtectedMethod.gif|}}[[#DeleteTileCore(Tile)|DeleteTileCore]]** | + | * //worldExtent// |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | * Description:The target worldExtent will be used to fetch all the BitmapTiles from. |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | ** {{wiki:PublicMethod.gif|}} GetHigherScaleTile(RectangleShape,Double) ** |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut.// |
- | **{{wiki:ProtectedMethod.gif|}}[[#GetHigherScaleTileCore(RectangleShape,Double)|GetHigherScaleTileCore]]** | + | == Remarks == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double | + | * //N/A// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**: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. | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:ProtectedMethod.gif|}}[[#GetTileCore(Int64,Int64)|GetTileCore]]** | + | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] |
- | * **Parameters**:Int64,Int64 | + | * Description:Returns the higher scale(higher zoomLevel) bitmap tile. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**: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. | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * //tileBoundingBox// |
- | * **Parameters**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **DeclaringType**:Object | + | * Description:The parameter specifies the current tile bounding box. |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //tileScale// |
- | **{{wiki:ProtectedMethod.gif|}}[[#MergeBitmaps(IEnumerable<BitmapTile>,Double)|MergeBitmaps]]** | + | * Type:Double |
- | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]>,Double | + | * Description:This parameter specifies the current tile scale. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method will merege the passed in bitmap tiles into a larege bitmap tile. | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:ProtectedMethod.gif|}}[[#OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs)|OnGettingCacheImage]]** | + | ** {{wiki:PublicMethod.gif|}} SaveTile(Tile) ** |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]] | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //N/A// |
- | **{{wiki:ProtectedMethod.gif|}}[[#OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs)|OnGottenCacheImage]]** | + | == Remarks == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]] | + | * //N/A// |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:ProtectedMethod.gif|}}[[#SaveTileCore(Tile)|SaveTileCore]]** | + | * Type:Void |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | + | * Description:N/A |
- | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]] | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Public Properties === | + | == Parameters == |
- | **{{wiki:PublicProperty.gif|}}[[#CacheId|CacheId]]** | + | * //tile// |
- | * **Return**:String | + | * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] |
- | * **Summary**:N/A | + | * Description:N/A |
- | **{{wiki:PublicProperty.gif|}}[[#ImageFormat|ImageFormat]]** | + | <div newline></div> |
- | * **Return**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] | + | ** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape,Boolean) ** |
- | * **Summary**:N/A | + | |
- | **{{wiki:PublicProperty.gif|}}[[#JpegQuality|JpegQuality]]** | + | * //N/A// |
- | * **Return**:Int16 | + | == Remarks == |
- | * **Summary**:N/A | + | * //N/A// |
- | **{{wiki:PublicProperty.gif|}}[[#LoadingTileImage|LoadingTileImage]]** | + | == Return Value == |
- | * **Return**:Bitmap | + | * Type:Void |
- | * **Summary**:N/A | + | * Description:N/A |
- | **{{wiki:PublicProperty.gif|}}[[#NoDataTileImage|NoDataTileImage]]** | + | == Parameters == |
- | * **Return**:Bitmap | + | * //bitmap// |
- | * **Summary**:N/A | + | * Type:Bitmap |
+ | * Description:N/A | ||
- | **{{wiki:PublicProperty.gif|}}[[#TileAccessMode|TileAccessMode]]** | + | * //bitmapExtent// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **Summary**:N/A | + | * Description:N/A |
- | **{{wiki:PublicProperty.gif|}}[[#TileMatrix|TileMatrix]]** | + | * //saveContainedCellsOnly// |
- | * **Return**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | + | * Type:Boolean |
- | * **Summary**:N/A | + | * Description:N/A |
- | === Protected Properties === | + | <div newline></div> |
- | === Public Events === | + | ** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape) ** |
- | **{{wiki:PublicEvent.gif|}}[[#GettingCacheImage|GettingCacheImage]]** | + | |
- | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]] | + | |
- | * **Summary**:N/A | + | |
- | **{{wiki:PublicEvent.gif|}}[[#GottenCacheImage|GottenCacheImage]]** | + | * //N/A// |
- | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]] | + | == Remarks == |
- | * **Summary**:N/A | + | * //N/A// |
- | ===== Public Constructors ===== | + | == Return Value == |
- | ===== Protected Constructors ===== | + | * Type:Void |
- | === BitmapTileCache(String,TileImageFormat,TileMatrix) === | + | * Description:N/A |
- | 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** | + | == Parameters == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] | + | * //bitmap// |
- | * **Description:This is the imageFormate showing what kind of image we are trying to save. | + | * Type:Bitmap |
+ | * Description:N/A | ||
- | **tileMatrix** | + | * //bitmapExtent// |
- | * **Type**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * **Description:This is the tile matrix system which is used for caculating tiles. | + | * Description:N/A |
- | [[#Protected Constructors|Go Back]] | + | <div newline></div> |
- | ===== Public Methods ===== | + | ** {{wiki:PublicMethod.gif|}} DeleteTiles(RectangleShape) ** |
- | === ClearCache() === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Void | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | === DeleteTile(Tile) === | + | * Description:N/A |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Void | + | * //worldExtent// |
- | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
+ | * Description:N/A | ||
- | ==== Parameters ==== | + | <div newline></div> |
- | **tile** | + | ** {{wiki:PublicMethod.gif|}} DeleteTile(Tile) ** |
- | * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | + | |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | * //N/A// |
- | === DeleteTiles(RectangleShape) === | + | == Remarks == |
- | N/A | + | * //N/A// |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Void | + | * Type:Void |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | **worldExtent** | + | * //tile// |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] |
- | * **Description**:N/A | + | * Description:N/A |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | === Equals(Object) === | + | ** {{wiki:PublicMethod.gif|}} ClearCache() ** |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Boolean | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **obj** | + | * Type:Void |
- | * **Type**:Object | + | * Description:N/A |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetHashCode() === | + | <div newline></div> |
- | N/A | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Int32 | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:String |
- | === GetHigherScaleTile(RectangleShape,Double) === | + | * Description:N/A |
- | This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut. | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | + | <div newline></div> |
- | * **Description**:Returns the higher scale(higher zoomLevel) bitmap tile. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | ==== Parameters ==== | + | * //N/A// |
- | **tileBoundingBox** | + | == Remarks == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //N/A// |
- | * **Description**:The parameter specifies the current tile bounding box. | + | |
- | **tileScale** | + | == Return Value == |
- | * **Type**:Double | + | * Type:Boolean |
- | * **Description**:This parameter specifies the current tile scale. | + | * Description:N/A |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetTile(RectangleShape) === | + | * //obj// |
- | This method returns the BitmapTile corresponding to the tile bounding box passed in. | + | * Type:Object |
- | ==== Remarks ==== | + | * Description:N/A |
- | N/A | + | |
- | **Return Value** | + | <div newline></div> |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | * **Description**:Returns the BitmapTile corresponding to the passed in boundingBox. | + | |
- | ==== Parameters ==== | + | * //N/A// |
- | **tileBoundingBox** | + | == Remarks == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //N/A// |
- | * **Description**:The target boundingBox for the tile to fetch. | + | |
- | [[#Public Methods|Go Back]] | + | == Return Value == |
- | === GetTile(Int64,Int64) === | + | * Type:Int32 |
- | This method returns the BitmapTile corresponding to passed in row and column. | + | * Description:N/A |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | + | <div newline></div> |
- | * **Description**:Returns the BitmapTile corresponding to the passed in row and column. | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | ==== Parameters ==== | + | * //N/A// |
- | **row** | + | == Remarks == |
- | * **Type**:Int64 | + | * //N/A// |
- | * **Description**:The target row for the tile to fetch. | + | |
- | **column** | + | == Return Value == |
- | * **Type**:Int64 | + | * Type:Type |
- | * **Description**:The target column for the tile to fetch. | + | * Description:N/A |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetTiles(RectangleShape) === | + | <div newline></div> |
- | This method returns all the BitmapTiles within the passed in world extent, some of which may not has bitmap. | + | ==== Protected Methods ==== |
- | ==== Remarks ==== | + | ** {{wiki:ProtectedMethod.gif|}} GetTileCore(Int64,Int64) ** |
- | N/A | + | |
- | **Return Value** | + | * //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.// |
- | * **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]> | + | == Remarks == |
- | * **Description**:Returns a collection of BitmapTiles within the passed in worldExtent. | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **worldExtent** | + | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:Returns the BitmapTile corresponding to the passed in row and column. |
- | * **Description**:The target worldExtent will be used to fetch all the BitmapTiles from. | + | |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetType() === | + | * //row// |
- | N/A | + | * Type:Int64 |
- | ==== Remarks ==== | + | * Description:The target row for the tile to fetch. |
- | N/A | + | |
- | **Return Value** | + | * //column// |
- | * **Return Type**:Type | + | * Type:Int64 |
- | * **Description**:N/A | + | * Description:The target column for the tile to fetch. |
- | ==== Parameters ==== | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} GetHigherScaleTileCore(RectangleShape,Double) ** |
- | === SaveTile(Tile) === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //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.// |
- | * **Return Type**:Void | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **tile** | + | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] |
- | * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | + | * Description:Returns the higher scale(higher zoomLevel) bitmap tile. |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === SaveTiles(Bitmap,RectangleShape,Boolean) === | + | * //tileBoundingBox// |
- | N/A | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | ==== Remarks ==== | + | * Description:The parameter specifies the current tile bounding box. |
- | N/A | + | |
- | **Return Value** | + | * //tileScale// |
- | * **Return Type**:Void | + | * Type:Double |
- | * **Description**:N/A | + | * Description:This parameter specifies the current tile scale. |
- | ==== Parameters ==== | + | <div newline></div> |
- | **bitmap** | + | ** {{wiki:ProtectedMethod.gif|}} MergeBitmaps(IEnumerable<BitmapTile>,Double) ** |
- | * **Type**:Bitmap | + | |
- | * **Description**:N/A | + | |
- | **bitmapExtent** | + | * //This method will merege the passed in bitmap tiles into a larege bitmap tile.// |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | **saveContainedCellsOnly** | + | == Return Value == |
- | * **Type**:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] |
- | * **Description**:N/A | + | * Description:Returns a merged bitmap tile. |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === SaveTiles(Bitmap,RectangleShape) === | + | * //tilesToMerge// |
- | N/A | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]> |
- | ==== Remarks ==== | + | * Description:The collection of tiles to be mereged. |
- | N/A | + | |
- | **Return Value** | + | * //scale// |
- | * **Return Type**:Void | + | * Type:Double |
- | * **Description**:N/A | + | * Description:The target scale for result mereged bitmap tile. |
- | ==== Parameters ==== | + | <div newline></div> |
- | **bitmap** | + | ** {{wiki:ProtectedMethod.gif|}} OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs) ** |
- | * **Type**:Bitmap | + | |
- | * **Description**:N/A | + | |
- | **bitmapExtent** | + | * //N/A// |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Return Value == |
- | === ToString() === | + | * Type:Void |
- | N/A | + | * Description:N/A |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:String | + | * //e// |
- | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]] |
+ | * Description:N/A | ||
- | ==== Parameters ==== | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs) ** |
- | ===== Protected Methods ===== | + | |
- | === ClearCacheCore() === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Void | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Void |
- | === DeleteTileCore(Tile) === | + | * Description:N/A |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Void | + | * //e// |
- | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]] |
+ | * Description:N/A | ||
- | ==== Parameters ==== | + | <div newline></div> |
- | **tile** | + | ** {{wiki:ProtectedMethod.gif|}} ClearCacheCore() ** |
- | * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | + | |
- | * **Description**:N/A | + | |
- | [[#Protected Methods|Go Back]] | + | * //N/A// |
- | === Finalize() === | + | == Remarks == |
- | N/A | + | * //N/A// |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Void | + | * Type:Void |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | <div newline></div> |
- | === GetHigherScaleTileCore(RectangleShape,Double) === | + | ** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) ** |
- | 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** | + | * //N/A// |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | + | == Remarks == |
- | * **Description**:Returns the higher scale(higher zoomLevel) bitmap tile. | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **tileBoundingBox** | + | * Type:Void |
- | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:N/A |
- | * **Description**:The parameter specifies the current tile bounding box. | + | |
- | **tileScale** | + | == Parameters == |
- | * **Type**:Double | + | * //tile// |
- | * **Description**:This parameter specifies the current tile scale. | + | * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] |
+ | * Description:N/A | ||
- | [[#Protected Methods|Go Back]] | + | <div newline></div> |
- | === GetTileCore(Int64,Int64) === | + | ** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) ** |
- | 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** | + | * //N/A// |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | + | == Remarks == |
- | * **Description**:Returns the BitmapTile corresponding to the passed in row and column. | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **row** | + | * Type:Void |
- | * **Type**:Int64 | + | * Description:N/A |
- | * **Description**:The target row for the tile to fetch. | + | |
- | **column** | + | == Parameters == |
- | * **Type**:Int64 | + | * //tile// |
- | * **Description**:The target column for the tile to fetch. | + | * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]] |
+ | * Description:N/A | ||
- | [[#Protected Methods|Go Back]] | + | <div newline></div> |
- | === MemberwiseClone() === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Object | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Void |
- | === MergeBitmaps(IEnumerable<BitmapTile>,Double) === | + | * Description:N/A |
- | This method will merege the passed in bitmap tiles into a larege bitmap tile. | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | + | <div newline></div> |
- | * **Description**:Returns a merged bitmap tile. | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | ==== Parameters ==== | + | * //N/A// |
- | **tilesToMerge** | + | == Remarks == |
- | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]> | + | * //N/A// |
- | * **Description**:The collection of tiles to be mereged. | + | |
- | **scale** | + | == Return Value == |
- | * **Type**:Double | + | * Type:Object |
- | * **Description**:The target scale for result mereged bitmap tile. | + | * Description:N/A |
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ==== Public Properties ==== | ||
+ | ** {{wiki:PublicProperty.gif|}} TileMatrix ** | ||
- | [[#Protected Methods|Go Back]] | ||
- | === OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs) === | ||
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | ||
- | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} TileAccessMode ** |
- | * **Return Type**:Void | + | |
- | * **Description**:N/A | + | |
- | + | ||
- | ==== Parameters ==== | + | |
- | **e** | + | |
- | * **Type**:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]] | + | |
- | * **Description**:N/A | + | |
- | [[#Protected Methods|Go Back]] | ||
- | === OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs) === | ||
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] | ||
- | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} NoDataTileImage ** |
- | * **Return Type**:Void | + | |
- | * **Description**:N/A | + | |
- | ==== Parameters ==== | ||
- | **e** | ||
- | * **Type**:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]] | ||
- | * **Description**:N/A | ||
- | |||
- | [[#Protected Methods|Go Back]] | ||
- | === SaveTileCore(Tile) === | ||
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
+ | == Return Value == | ||
+ | * Type:Bitmap | ||
- | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} LoadingTileImage ** |
- | * **Return Type**:Void | + | |
- | * **Description**:N/A | + | |
- | ==== Parameters ==== | ||
- | **tile** | ||
- | * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
- | * **Description**:N/A | ||
- | |||
- | [[#Protected Methods|Go Back]] | ||
- | ===== Public Properties ===== | ||
- | === CacheId === | ||
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:String | + | * Type:Bitmap |
- | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} ImageFormat ** |
- | === ImageFormat === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | ==== Return Value ==== | + | |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] | + | |
- | [[#Public Properties|Go Back]] | ||
- | === JpegQuality === | ||
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Int16 | + | * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] |
- | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} JpegQuality ** |
- | === LoadingTileImage === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | ==== Return Value ==== | + | |
- | **Return Type**:Bitmap | + | |
- | [[#Public Properties|Go Back]] | ||
- | === NoDataTileImage === | ||
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Bitmap | + | * Type:Int16 |
- | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} CacheId ** |
- | === TileAccessMode === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | ==== Return Value ==== | + | |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] | + | |
- | [[#Public Properties|Go Back]] | ||
- | === TileMatrix === | ||
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | + | * Type:String |
- | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
- | ===== Protected Properties ===== | + | ==== Public Events ==== |
- | ===== Public Events ===== | + | ** {{wiki:PublicEvent.gif|}} GottenCacheImage ** |
- | === GettingCacheImage === | + | |
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
- | **Event Arguments**:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]] |
- | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} GettingCacheImage ** |
- | === GottenCacheImage === | + | |
N/A | N/A | ||
- | ==== Remarks ==== | + | == Remarks == |
N/A | N/A | ||
- | **Event Arguments**:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]] |
- | [[#Public Events|Go Back]] | ||