thinkgeo.mapsuite.core.ecwrastersource
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.ecwrastersource [2015/09/18 05:40] admin |
thinkgeo.mapsuite.core.ecwrastersource [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.EcwRasterSource ====== | ====== ThinkGeo.MapSuite.Core.EcwRasterSource ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents the ECW raster source. | This class represents the ECW raster source. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 10: | Line 13: | ||
| ** {{wiki:PublicMethod.gif|}} EcwRasterSource() ** | ** {{wiki:PublicMethod.gif|}} EcwRasterSource() ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} EcwRasterSource(String) ** | ** {{wiki:PublicMethod.gif|}} EcwRasterSource(String) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | This is typically the constructor you want to use for this class. It allows you to pass in the ECW file you wish to work with. Note that the ECW file is not accessed or opened until you call the open command of the class. | + | * //This is typically the constructor you want to use for this class. It allows you to pass in the ECW file you wish to work with. Note that the ECW file is not accessed or opened until you call the open command of the class.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 28: | Line 31: | ||
| ** {{wiki:PublicMethod.gif|}} EcwRasterSource(String,String) ** | ** {{wiki:PublicMethod.gif|}} EcwRasterSource(String,String) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | It allows you to pass in the ECW file you wish to work with, as well as its corresponding world file. Note that the ECW file is not accessed or opened until you call the open command of the class. | + | * //It allows you to pass in the ECW file you wish to work with, as well as its corresponding world file. Note that the ECW file is not accessed or opened until you call the open command of the class.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 43: | Line 46: | ||
| ** {{wiki:PublicMethod.gif|}} EcwRasterSource(String,RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} EcwRasterSource(String,RectangleShape) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | It allows you to pass in the ECW file you wish to work with and its corresponding extent. Note that the ECW file is not accessed or opened until you call the open command of the class. | + | * //It allows you to pass in the ECW file you wish to work with and its corresponding extent. Note that the ECW file is not accessed or opened until you call the open command of the class.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 60: | Line 63: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 72: | Line 75: | ||
| ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** | ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 84: | Line 87: | ||
| ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** | ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 96: | Line 99: | ||
| ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** | ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 108: | Line 111: | ||
| ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 120: | Line 123: | ||
| ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 132: | Line 135: | ||
| ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 144: | Line 147: | ||
| ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 156: | Line 159: | ||
| ** {{wiki:PublicMethod.gif|}} Open() ** | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 168: | Line 171: | ||
| ** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 180: | Line 183: | ||
| ** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** | ** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 204: | Line 207: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 216: | Line 219: | ||
| ** {{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 232: | Line 235: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 244: | Line 247: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 257: | Line 260: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** | ||
| - | This method returns the projection text in proj4 format. | + | * //This method returns the projection text in proj4 format.// |
| == Remarks == | == Remarks == | ||
| - | This protected virtual method is called from the concrete public method GetProjectionText.The default implementation of this core method is to load the projection information from the ECW file and return the projection information in proj4 projection string format. | + | * //This protected virtual method is called from the concrete public method GetProjectionText.The default implementation of this core method is to load the projection information from the ECW file and return the projection information in proj4 projection string format.// |
| == Return Value == | == Return Value == | ||
| Line 269: | Line 272: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** | ||
| - | This method returns the width of the raster image in screen coordinates. | + | * //This method returns the width of the raster image in screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the width of the raster image in screen coordinates. | + | * //This method returns the width of the raster image in screen coordinates.// |
| == Return Value == | == Return Value == | ||
| Line 281: | Line 284: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** | ||
| - | This method returns the height of the raster image in screen coordinates. | + | * //This method returns the height of the raster image in screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the height of the raster image in screen coordinates. | + | * //This method returns the height of the raster image in screen coordinates.// |
| == Return Value == | == Return Value == | ||
| Line 293: | Line 296: | ||
| ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
| - | This method opens the ImageSource so that it is initialized and ready to use. | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| == Remarks == | == Remarks == | ||
| - | This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the ImageSource. Most methods on the ImageSource will throw an exception if the state of the ImageSource is not opened. When the map draws each layer, it will open the ImageSource 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 ImageSource. When implementing this abstract method, consider opening files for file based-sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the ImageSource. | + | * //This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the ImageSource. Most methods on the ImageSource will throw an exception if the state of the ImageSource is not opened. When the map draws each layer, it will open the ImageSource 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 ImageSource. When implementing this abstract method, consider opening files for file based-sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the ImageSource.// |
| == Return Value == | == Return Value == | ||
| Line 305: | Line 308: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | This method opens the ImageSource so that it is initialized and ready to use. | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| == Remarks == | == Remarks == | ||
| - | This protected virtual method is called from the concrete public method Close. The Close method plays an important role in the life cycle of the ImageSource. 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 FeatureSource 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. | + | * //This protected virtual method is called from the concrete public method Close. The Close method plays an important role in the life cycle of the ImageSource. 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 FeatureSource 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 317: | Line 320: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** | ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** | ||
| - | This method returns an image based on the worldExtent and raster image width and height. | + | * //This method returns an image based on the worldExtent and raster image width and height.// |
| == Remarks == | == Remarks == | ||
| - | This method is responsible for returning the image based on the parameters passed in. | + | * //This method is responsible for returning the image based on the parameters passed in.// |
| == Return Value == | == Return Value == | ||
| Line 341: | Line 344: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
| - | This method returns the bounding box of the RasterSource. | + | * //This method returns the bounding box of the RasterSource.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the bounding box of the RasterSource. | + | * //This method returns the bounding box of the RasterSource.// |
| == Return Value == | == Return Value == | ||
| Line 353: | Line 356: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 369: | Line 372: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 385: | Line 388: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 401: | Line 404: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 417: | Line 420: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 426: | Line 429: | ||
| == Parameters == | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //boundingBox// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //screenWidth// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //screenHeight// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //wrappingExtent// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //boundingBox// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //screenWidth// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //screenHeight// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //wrappingExtent// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 441: | Line 500: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
thinkgeo.mapsuite.core.ecwrastersource.1442554857.txt.gz ยท Last modified: 2015/09/18 05:40 by admin