ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== 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 ===
<div class_table>
**{{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 ===
<div class_table>
**{{wiki:PublicMethod.gif|}}[[#ClearCache()|ClearCache]]**
  * **Parameters**:N/A
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#DeleteTile(Tile)|DeleteTile]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#DeleteTiles(RectangleShape)|DeleteTiles]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]**
  * **Parameters**:Object
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
  * **Parameters**:N/A
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GetHigherScaleTile(RectangleShape,Double)|GetHigherScaleTile]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double
  * **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>
**{{wiki:PublicMethod.gif|}}[[#GetTile(RectangleShape)|GetTile]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * **DeclaringType**:N/A
  * **Summary**:This method returns the BitmapTile corresponding to the tile bounding box passed in.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GetTile(Int64,Int64)|GetTile]]**
  * **Parameters**:Int64,Int64
  * **DeclaringType**:N/A
  * **Summary**:This method returns the BitmapTile corresponding to passed in row and column.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GetTiles(RectangleShape)|GetTiles]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * **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>
**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
  * **Parameters**:N/A
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#SaveTile(Tile)|SaveTile]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#SaveTiles(Bitmap,RectangleShape,Boolean)|SaveTiles]]**
  * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Boolean
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#SaveTiles(Bitmap,RectangleShape)|SaveTiles]]**
  * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
  * **Parameters**:N/A
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

=== Protected Methods ===
<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#ClearCacheCore()|ClearCacheCore]]**
  * **Parameters**:N/A
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#DeleteTileCore(Tile)|DeleteTileCore]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
  * **Parameters**:N/A
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#GetHigherScaleTileCore(RectangleShape,Double)|GetHigherScaleTileCore]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double
  * **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>
**{{wiki:ProtectedMethod.gif|}}[[#GetTileCore(Int64,Int64)|GetTileCore]]**
  * **Parameters**:Int64,Int64
  * **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>
**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
  * **Parameters**:N/A
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#MergeBitmaps(IEnumerable<BitmapTile>,Double)|MergeBitmaps]]**
  * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]>,Double
  * **DeclaringType**:N/A
  * **Summary**:This method will merege the passed in bitmap tiles into a larege bitmap tile.
</div>

<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs)|OnGettingCacheImage]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]]
  * **DeclaringType**:N/A
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs)|OnGottenCacheImage]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]]
  * **DeclaringType**:N/A
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#SaveTileCore(Tile)|SaveTileCore]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.TileCache|TileCache]]
  * **Summary**:N/A
</div>

=== Public Properties ===
**{{wiki:PublicProperty.gif|}}[[#CacheId|CacheId]]**
  * **Return**:String
  * **Summary**:N/A

**{{wiki:PublicProperty.gif|}}[[#ImageFormat|ImageFormat]]**
  * **Return**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]
  * **Summary**:N/A

**{{wiki:PublicProperty.gif|}}[[#JpegQuality|JpegQuality]]**
  * **Return**:Int16
  * **Summary**:N/A

**{{wiki:PublicProperty.gif|}}[[#LoadingTileImage|LoadingTileImage]]**
  * **Return**:Bitmap
  * **Summary**:N/A

**{{wiki:PublicProperty.gif|}}[[#NoDataTileImage|NoDataTileImage]]**
  * **Return**:Bitmap
  * **Summary**:N/A

**{{wiki:PublicProperty.gif|}}[[#TileAccessMode|TileAccessMode]]**
  * **Return**:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]]
  * **Summary**:N/A

**{{wiki:PublicProperty.gif|}}[[#TileMatrix|TileMatrix]]**
  * **Return**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]
  * **Summary**:N/A

=== Protected Properties ===
=== Public Events ===
**{{wiki:PublicEvent.gif|}}[[#GettingCacheImage|GettingCacheImage]]**
  * **Event Arguments**:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]]
  * **Summary**:N/A

**{{wiki:PublicEvent.gif|}}[[#GottenCacheImage|GottenCacheImage]]**
  * **Event Arguments**:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]]
  * **Summary**:N/A

===== Public Constructors =====
===== Protected Constructors =====
=== 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.

[[#Protected Constructors|Go Back]]
===== Public Methods =====
=== ClearCache() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
[[#Public Methods|Go Back]]
=== DeleteTile(Tile) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
**tile**
  * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
  * **Description**:N/A

[[#Public Methods|Go Back]]
=== DeleteTiles(RectangleShape) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
**worldExtent**
  * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * **Description**:N/A

[[#Public Methods|Go Back]]
=== Equals(Object) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Boolean
  * **Description**:N/A

==== Parameters ====
**obj**
  * **Type**:Object
  * **Description**:N/A

[[#Public Methods|Go Back]]
=== GetHashCode() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Int32
  * **Description**:N/A

==== Parameters ====
[[#Public Methods|Go Back]]
=== 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**
  * **Return 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.

[[#Public Methods|Go Back]]
=== GetTile(RectangleShape) ===
This method returns the BitmapTile corresponding to the tile bounding box passed in.
==== Remarks ====
N/A

**Return Value**
  * **Return 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.

[[#Public Methods|Go Back]]
=== GetTile(Int64,Int64) ===
This method returns the BitmapTile corresponding to passed in row and column.
==== Remarks ====
N/A

**Return Value**
  * **Return 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.

[[#Public Methods|Go Back]]
=== 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**
  * **Return 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.

[[#Public Methods|Go Back]]
=== GetType() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Type
  * **Description**:N/A

==== Parameters ====
[[#Public Methods|Go Back]]
=== SaveTile(Tile) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
**tile**
  * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
  * **Description**:N/A

[[#Public Methods|Go Back]]
=== SaveTiles(Bitmap,RectangleShape,Boolean) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return 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

[[#Public Methods|Go Back]]
=== SaveTiles(Bitmap,RectangleShape) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
**bitmap**
  * **Type**:Bitmap
  * **Description**:N/A

**bitmapExtent**
  * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * **Description**:N/A

[[#Public Methods|Go Back]]
=== ToString() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:String
  * **Description**:N/A

==== Parameters ====
[[#Public Methods|Go Back]]
===== Protected Methods =====
=== ClearCacheCore() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
[[#Protected Methods|Go Back]]
=== DeleteTileCore(Tile) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
**tile**
  * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
  * **Description**:N/A

[[#Protected Methods|Go Back]]
=== Finalize() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
[[#Protected Methods|Go Back]]
=== 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**
  * **Return 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.

[[#Protected Methods|Go Back]]
=== 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**
  * **Return 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.

[[#Protected Methods|Go Back]]
=== MemberwiseClone() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Object
  * **Description**:N/A

==== Parameters ====
[[#Protected Methods|Go Back]]
=== MergeBitmaps(IEnumerable<BitmapTile>,Double) ===
This method will merege the passed in bitmap tiles into a larege bitmap tile.
==== Remarks ====
N/A

**Return Value**
  * **Return 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.

[[#Protected Methods|Go Back]]
=== OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **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
==== Remarks ====
N/A

**Return Value**
  * **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
==== Remarks ====
N/A

**Return Value**
  * **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
==== Remarks ====
N/A
==== Return Value ====
**Return Type**:String

[[#Public Properties|Go Back]]
=== ImageFormat ===
N/A
==== Remarks ====
N/A
==== Return Value ====
**Return Type**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]

[[#Public Properties|Go Back]]
=== JpegQuality ===
N/A
==== Remarks ====
N/A
==== Return Value ====
**Return Type**:Int16

[[#Public Properties|Go Back]]
=== LoadingTileImage ===
N/A
==== Remarks ====
N/A
==== Return Value ====
**Return Type**:Bitmap

[[#Public Properties|Go Back]]
=== NoDataTileImage ===
N/A
==== Remarks ====
N/A
==== Return Value ====
**Return Type**:Bitmap

[[#Public Properties|Go Back]]
=== TileAccessMode ===
N/A
==== Remarks ====
N/A
==== Return Value ====
**Return Type**:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]]

[[#Public Properties|Go Back]]
=== TileMatrix ===
N/A
==== Remarks ====
N/A
==== Return Value ====
**Return Type**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]

[[#Public Properties|Go Back]]
===== Protected Properties =====
===== Public Events =====
=== GettingCacheImage ===
N/A
==== Remarks ====
N/A

**Event Arguments**:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]]

[[#Public Events|Go Back]]
=== GottenCacheImage ===
N/A
==== Remarks ====
N/A

**Event Arguments**:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]]

[[#Public Events|Go Back]]
User Tools

Site Tools

Page Tools
