This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.rasterlayer [2015/09/21 07:51] admin |
thinkgeo.mapsuite.core.rasterlayer [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.RasterLayer ====== | ====== ThinkGeo.MapSuite.Core.RasterLayer ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This abstract class is the basis for all image-based layers in the system. | This abstract class is the basis for all image-based layers in the system. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 17: | Line 20: | ||
** {{wiki:ProtectedMethod.gif|}} RasterLayer() ** | ** {{wiki:ProtectedMethod.gif|}} RasterLayer() ** | ||
- | This is a constructor for the class. If you use this constructor, you should set the properties you need manually. | + | * //This is a constructor for the class. If you use this constructor, you should set the properties you need manually.// |
== Remarks == | == Remarks == | ||
- | If you use this constructor, you should set the properties you need manually. | + | * //If you use this constructor, you should set the properties you need manually.// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
Line 25: | Line 28: | ||
** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ||
- | This method returns the projection parameters of the current layer. | + | * //This method returns the projection parameters of the current layer.// |
== Remarks == | == Remarks == | ||
- | This method returns the projection parameters of the current layer. | + | * //This method returns the projection parameters of the current layer.// |
== Return Value == | == Return Value == | ||
Line 37: | Line 40: | ||
** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ||
- | This method returns the horizontal resolution of the image. | + | * //This method returns the horizontal resolution of the image.// |
== Remarks == | == Remarks == | ||
- | This method returns the horizontal resolution of the image. | + | * //This method returns the horizontal resolution of the image.// |
== Return Value == | == Return Value == | ||
Line 49: | Line 52: | ||
** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ||
- | This method returns the vertical resolution of the image. | + | * //This method returns the vertical resolution of the image.// |
== Remarks == | == Remarks == | ||
- | This method returns the vertical resolution of the image. | + | * //This method returns the vertical resolution of the image.// |
== Return Value == | == Return Value == | ||
Line 61: | Line 64: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing() ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 73: | Line 76: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 89: | Line 92: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 105: | Line 108: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 121: | Line 124: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 141: | Line 144: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 161: | Line 164: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 185: | Line 188: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 205: | Line 208: | ||
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) ** | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 229: | Line 232: | ||
** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** | ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 241: | Line 244: | ||
** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 253: | Line 256: | ||
** {{wiki:PublicMethod.gif|}} Open() ** | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 265: | Line 268: | ||
** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 277: | Line 280: | ||
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 289: | Line 292: | ||
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 309: | Line 312: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 321: | Line 324: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 337: | Line 340: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 349: | Line 352: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 362: | Line 365: | ||
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
- | This method returns the bounding box of the RasterLayer. | + | * //This method returns the bounding box of the RasterLayer.// |
== Remarks == | == Remarks == | ||
- | This method returns the bounding box of the RasterLayer. | + | * //This method returns the bounding box of the RasterLayer.// |
== Return Value == | == Return Value == | ||
Line 374: | Line 377: | ||
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
- | This method opens the RasterLayer so that it is initialized and ready to use. | + | * //This method opens the RasterLayer so that it is initialized and ready to use.// |
== Remarks == | == Remarks == | ||
- | The open method plays an important rol,e as it is responsible for initializing the RasterLayer. Most methods on the RasterLayer will throw an exception if the state of the RasterLayer is not opened. When the map draws each layer, it will open the RasterLayer as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the RasterLayer. | + | * //The open method plays an important rol,e as it is responsible for initializing the RasterLayer. Most methods on the RasterLayer will throw an exception if the state of the RasterLayer is not opened. When the map draws each layer, it will open the RasterLayer as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the RasterLayer.// |
== Return Value == | == Return Value == | ||
Line 386: | Line 389: | ||
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
- | This method opens the RasterLayer so that it is initialized and ready to use. | + | * //This method opens the RasterLayer so that it is initialized and ready to use.// |
== Remarks == | == Remarks == | ||
- | The close method plays an important role in the life cycle of the RasterLayer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed RasterLayer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future. | + | * //The close method plays an important role in the life cycle of the RasterLayer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed RasterLayer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.// |
== Return Value == | == Return Value == | ||
Line 398: | Line 401: | ||
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ||
- | This method will draw the image from the GeoImage source based on the parameters provided. | + | * //This method will draw the image from the GeoImage source based on the parameters provided.// |
== Remarks == | == Remarks == | ||
- | The DrawCore method will be called when the layer is being drawn. It will determine if the image is within the extent and the threshold defined. If these parameters are met, it will query the RasterSource for an image and then apply the other various properties (such as transparency, etc.) on the image. Lastly, it will draw the image on the GeoImage or native image passed into the method. | + | * //The DrawCore method will be called when the layer is being drawn. It will determine if the image is within the extent and the threshold defined. If these parameters are met, it will query the RasterSource for an image and then apply the other various properties (such as transparency, etc.) on the image. Lastly, it will draw the image on the GeoImage or native image passed into the method.// |
== Return Value == | == Return Value == | ||
Line 418: | Line 421: | ||
** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 434: | Line 437: | ||
** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 450: | Line 453: | ||
** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 462: | Line 465: | ||
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 474: | Line 477: | ||
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 494: | Line 497: | ||
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 514: | Line 517: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 530: | Line 533: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 546: | Line 549: | ||
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** | ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 566: | Line 569: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 582: | Line 585: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 598: | Line 601: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 614: | Line 617: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 626: | Line 629: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 638: | Line 641: | ||
** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit) ** | ||
- | This method returns whether the current extent is within the upper and lower threshold properties. | + | * //This method returns whether the current extent is within the upper and lower threshold properties.// |
== Remarks == | == Remarks == | ||
- | This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided. | + | * //This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided.// |
== Return Value == | == Return Value == | ||
Line 670: | Line 673: | ||
** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit,Single) ** | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit,Single) ** | ||
- | This method returns whether the current extent is within the upper and lower threshold properties. | + | * //This method returns whether the current extent is within the upper and lower threshold properties.// |
== Remarks == | == Remarks == | ||
- | This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided. | + | * //This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided.// |
== Return Value == | == Return Value == | ||
Line 712: | Line 715: | ||
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} WrappingMode ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.WrappingMode|WrappingMode]] | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} WrappingExtent ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
** {{wiki:PublicProperty.gif|}} UpperThreshold ** | ** {{wiki:PublicProperty.gif|}} UpperThreshold ** |