====== ThinkGeo.MapSuite.Core.EcwRasterSource ====== {{section>upgrade_map_suite_to_10.0}} This class represents the ECW raster source. ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.Core.RasterSource ***ThinkGeo.MapSuite.Core.EcwRasterSource** *[[ThinkGeo.MapSuite.Core.Jpeg2000RasterSource]] ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} EcwRasterSource() ** * //This is the constructor for the class.// == Remarks == * //N/A// == Parameters ==
** {{wiki:PublicMethod.gif|}} EcwRasterSource(String) ** * //This is the constructor for the class.// == 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.// == Parameters == * //imagePathFilename// * Type:String * Description:This parameter represents the path and file name of the ECW file you want to load into the class for display.
** {{wiki:PublicMethod.gif|}} EcwRasterSource(String,String) ** * //This is the constructor for the class.// == 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.// == Parameters == * //imagePathFilename// * Type:String * Description:This parameter represents the path and file name of the ECW file you want to load into the class for display. * //worldfilePathFilename// * Type:String * Description:The corresponding world file name that contains the world file information.
** {{wiki:PublicMethod.gif|}} EcwRasterSource(String,RectangleShape) ** * //This is the constructor for the class.// == 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.// == Parameters == * //imagePathFilename// * Type:String * Description:This parameter represents the path and file name of the ECW file you want to load into the class for display. * //imageExtent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:The corresponding world extent, which can calculate out the world information with the help of width and height from the ECW file.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} CloneDeep() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetImageWidth() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetImageHeight() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetProjectionText() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Open() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Close() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] * Description:N/A == Parameters == * //worldExtent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A * //canvasWidth// * Type:Int32 * Description:N/A * //canvasHeight// * Type:Int32 * Description:N/A
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** * //This method returns the projection text in proj4 format.// == 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.// == Return Value == * Type:String * Description:Projection text string. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** * //This method returns the width of the raster image in screen coordinates.// == Remarks == * //This method returns the width of the raster image in screen coordinates.// == Return Value == * Type:Int32 * Description:This method returns the width of the raster image in screen coordinates. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** * //This method returns the height of the raster image in screen coordinates.// == Remarks == * //This method returns the height of the raster image in screen coordinates.// == Return Value == * Type:Int32 * Description:This method returns the height of the raster image in screen coordinates. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** * //This method opens the ImageSource so that it is initialized and ready to use.// == 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.// == Return Value == * Type:Void * Description:None == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** * //This method opens the ImageSource so that it is initialized and ready to use.// == 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.// == Return Value == * Type:Void * Description:None == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** * //This method returns an image based on the worldExtent and raster image width and height.// == Remarks == * //This method is responsible for returning the image based on the parameters passed in.// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] * Description:This method returns an image based on the worldExtent and raster image width and height. == Parameters == * //worldExtent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:This parameter represents the worldExtent you want to draw. * //canvasWidth// * Type:Int32 * Description:This parameter represents the width of the raster image you want to draw. * //canvasHeight// * Type:Int32 * Description:This parameter represents the height of the raster image you want to draw.
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** * //This method returns the bounding box of the RasterSource.// == Remarks == * //This method returns the bounding box of the RasterSource.// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:This method returns the bounding box of the RasterSource. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] * Description:N/A == Parameters ==
** {{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
** {{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
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} PathFilename ** This property gets or sets the file name and path of the ECW raster image you are working with. == Remarks == If you wish to change the file the class is working with, you would change it here. You cannot change the file you are working with while the class is in an open state. == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Projection ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.Projection|Projection]] ** {{wiki:PublicProperty.gif|}} Transparency ** N/A == Remarks == N/A == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} BlueTranslation ** N/A == Remarks == N/A == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} RedTranslation ** N/A == Remarks == N/A == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} GreenTranslation ** N/A == Remarks == N/A == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} IsNegative ** N/A == Remarks == N/A == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsGrayscale ** N/A == Remarks == N/A == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsOpen ** N/A == Remarks == N/A == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} HasProjectionText ** N/A == Remarks == N/A == Return Value == * Type:Boolean ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} HasProjectionTextCore ** This property returns true if the RasterSource has projection text, false if it does not. == Remarks == This protected virtual method is called from the concrete public property HasProjectionText. Thus, if you inherit RasterSource, please ensure that you override this virtual property to return the correct projection status of your raster source.We will check the HasProjectionText status before you call the GetProjectionText method. It will throw an exception if the HasProjectionText property returns false. == Return Value == * Type:Boolean ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} OpeningRasterSource ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} OpenedRasterSource ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} ClosingRasterSource ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} ClosedRasterSource ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]