thinkgeo.mapsuite.core.tilecache
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.tilecache [2015/09/17 10:40] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.TileCache ====== | ||
| - | 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 === | ||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#TileCache(String,TileImageFormat,TileMatrix)|TileCache]]** | ||
| - | * **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**:N/A | ||
| - | * **Summary**:This method will clear all the tiles in the tileCache. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#DeleteTile(Tile)|DeleteTile]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method will delete the target tile passed in. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#DeleteTiles(RectangleShape)|DeleteTiles]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method will delete the tiles within the passed in worldExtent. | ||
| - | </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|}}[[#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**:N/A | ||
| - | * **Summary**:This method will save the target tile passed in. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#SaveTiles(Bitmap,RectangleShape,Boolean)|SaveTiles]]** | ||
| - | * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Boolean | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#SaveTiles(Bitmap,RectangleShape)|SaveTiles]]** | ||
| - | * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method will save the bitmap with its extent attached into tiles. | ||
| - | </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**:N/A | ||
| - | * **Summary**:This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#DeleteTileCore(Tile)|DeleteTileCore]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#SaveTileCore(Tile)|SaveTileCore]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This abstract method will save the target tile passed in, for each sub TileCache class must implement this method. | ||
| - | </div> | ||
| - | |||
| - | === Public Properties === | ||
| - | **{{wiki:PublicProperty.gif|}}[[#CacheId|CacheId]]** | ||
| - | * **Return**:String | ||
| - | * **Summary**:Gets or sets the id of the TileCache. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#ImageFormat|ImageFormat]]** | ||
| - | * **Return**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] | ||
| - | * **Summary**:Gets or sets the tile image format. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#JpegQuality|JpegQuality]]** | ||
| - | * **Return**:Int16 | ||
| - | * **Summary**:Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#LoadingTileImage|LoadingTileImage]]** | ||
| - | * **Return**:Bitmap | ||
| - | * **Summary**:This property returns back a preset image showing the Tile is loading. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#NoDataTileImage|NoDataTileImage]]** | ||
| - | * **Return**:Bitmap | ||
| - | * **Summary**:This property returns back a preset image showing the tile data is missing. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#TileAccessMode|TileAccessMode]]** | ||
| - | * **Return**:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] | ||
| - | * **Summary**:Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#TileMatrix|TileMatrix]]** | ||
| - | * **Return**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | ||
| - | * **Summary**:Gets or sets the TileMatrix which is used in caculation for tiles. | ||
| - | |||
| - | === Protected Properties === | ||
| - | === Public Events === | ||
| - | ===== Public Constructors ===== | ||
| - | ===== Protected Constructors ===== | ||
| - | === 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. | ||
| - | |||
| - | [[#Protected Constructors|Go Back]] | ||
| - | ===== Public Methods ===== | ||
| - | === 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** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === 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** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **tile** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * **Description**:The target tile to be deleted. | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === DeleteTiles(RectangleShape) === | ||
| - | This method will delete the tiles within the passed in worldExtent. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **worldExtent** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * **Description**:The target extent to delete all tiles within it. | ||
| - | |||
| - | [[#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]] | ||
| - | === GetType() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Type | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === 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** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **tile** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * **Description**:The target tile to be saved. | ||
| - | |||
| - | [[#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) === | ||
| - | This method will save the bitmap with its extent attached into tiles. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **bitmap** | ||
| - | * **Type**:Bitmap | ||
| - | * **Description**:The target bitmap to be saved into tiles. | ||
| - | |||
| - | **bitmapExtent** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * **Description**:The target extent for the bitmap. | ||
| - | |||
| - | [[#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() === | ||
| - | 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** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === 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** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **tile** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * **Description**:The target tile to be deleted. | ||
| - | |||
| - | [[#Protected Methods|Go Back]] | ||
| - | === Finalize() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === MemberwiseClone() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Object | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === 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** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **tile** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]] | ||
| - | * **Description**:The target tile to be saved. | ||
| - | |||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | === CacheId === | ||
| - | Gets or sets the id of the TileCache. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:String | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === ImageFormat === | ||
| - | Gets or sets the tile image format. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === JpegQuality === | ||
| - | Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Int16 | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === LoadingTileImage === | ||
| - | This property returns back a preset image showing the Tile is loading. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Bitmap | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === NoDataTileImage === | ||
| - | This property returns back a preset image showing the tile data is missing. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Bitmap | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === 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 ==== | ||
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === TileMatrix === | ||
| - | Gets or sets the TileMatrix which is used in caculation for tiles. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
thinkgeo.mapsuite.core.tilecache.1442486459.txt.gz ยท Last modified: 2015/09/17 10:40 by admin
