thinkgeo.mapsuite.core.mrsidrastersource
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.mrsidrastersource [2015/09/18 05:47] admin |
thinkgeo.mapsuite.core.mrsidrastersource [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.MrSidRasterSource ====== | ====== ThinkGeo.MapSuite.Core.MrSidRasterSource ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents the MrSid raster source. | This class represents the MrSid raster source. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} MrSidRasterSource() ** | ** {{wiki:PublicMethod.gif|}} MrSidRasterSource() ** | ||
| - | 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|}} MrSidRasterSource(String) ** | ** {{wiki:PublicMethod.gif|}} MrSidRasterSource(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 MrSid file you wish to work with. Note that the MrSid 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 MrSid file you wish to work with. Note that the MrSid file is not accessed or opened until you call the open command of the class.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 27: | Line 30: | ||
| ** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String,String) ** | ** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String,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 MrSid file and world file path and filename you wish to work with. Note that the MrSid 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 MrSid file and world file path and filename you wish to work with. Note that the MrSid file is not accessed or opened until you call the open command of the class.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 42: | Line 45: | ||
| ** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String,RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String,RectangleShape) ** | ||
| - | This is a constructor for the class. | + | * //This is a constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | This constructor gets the RasterSource ready to use. | + | * //This constructor gets the RasterSource ready to use.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 59: | Line 62: | ||
| ** {{wiki:PublicMethod.gif|}} Dispose() ** | ** {{wiki:PublicMethod.gif|}} Dispose() ** | ||
| - | Release the unmanage resource by setting the rasterImage to null. | + | * //Release the unmanage resource by setting the rasterImage to null.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 71: | Line 74: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 83: | Line 86: | ||
| ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** | ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 95: | Line 98: | ||
| ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** | ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 107: | Line 110: | ||
| ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** | ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 119: | Line 122: | ||
| ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 131: | Line 134: | ||
| ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 143: | Line 146: | ||
| ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 155: | Line 158: | ||
| ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 167: | Line 170: | ||
| ** {{wiki:PublicMethod.gif|}} Open() ** | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 179: | Line 182: | ||
| ** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 191: | Line 194: | ||
| ** {{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 215: | Line 218: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 227: | Line 230: | ||
| ** {{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 243: | Line 246: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 255: | Line 258: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 268: | Line 271: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** | ||
| - | This method returns the width of the image in screen coordinates. | + | * //This method returns the width of the image in screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the width of the image in screen coordinates. | + | * //This method returns the width of the image in screen coordinates.// |
| == Return Value == | == Return Value == | ||
| Line 280: | Line 283: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** | ||
| - | This method returns the height of the image in screen coordinates. | + | * //This method returns the height of the image in screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the height of the image in screen coordinates. | + | * //This method returns the height of the image in screen coordinates.// |
| == Return Value == | == Return Value == | ||
| Line 292: | Line 295: | ||
| ** {{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 concreate public method Open. The open method play 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 source, 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 concreate public method Open. The open method play 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 source, 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 304: | Line 307: | ||
| ** {{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 concreate 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. It is recommended that if you override this method that you take the following things into account. This method may be called multiple times so we suggest you write the 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 API will only take effect when the suppressClose are set to false. | + | * //This protected virtual method is called from the concreate 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. It is recommended that if you override this method that you take the following things into account. This method may be called multiple times so we suggest you write the 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 API will only take effect when the suppressClose are set to false.// |
| == Return Value == | == Return Value == | ||
| Line 316: | Line 319: | ||
| ** {{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 328: | Line 331: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** | ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** | ||
| - | This method returns an image based on the worldExtent and image width and height. | + | * //This method returns an image based on the worldExtent and 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 352: | Line 355: | ||
| ** {{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 364: | Line 367: | ||
| ** {{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 380: | Line 383: | ||
| ** {{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 396: | Line 399: | ||
| ** {{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 412: | Line 415: | ||
| ** {{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 428: | Line 431: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 437: | Line 440: | ||
| == 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 452: | Line 511: | ||
| ** {{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.mrsidrastersource.1442555238.txt.gz ยท Last modified: 2015/09/18 05:47 by admin