====== ThinkGeo.MapSuite.Layers.Jpeg2000RasterSource ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.Layers.RasterSource ***ThinkGeo.MapSuite.Layers.Jpeg2000RasterSource** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} Jpeg2000RasterSource() ** * //This is the constructor for the class.// == Remarks == * //N/A// == Parameters ==
** {{wiki:PublicMethod.gif|}} Jpeg2000RasterSource(String) ** * //This is a constructor for the class.// == Remarks == * //This constructor gets the RasterSource ready to use.// == Parameters == * //imagePathFilename// * Type:String * Description:This parameter is the path and file name of the file you want to use.
** {{wiki:PublicMethod.gif|}} Jpeg2000RasterSource(String,String) ** * //This is a constructor for the class.// == Remarks == * //This constructor gets the RasterSource ready to use.// == Parameters == * //imagePathFilename// * Type:String * Description:This parameter is the path and file name of the file you want to use. * //worldFilePathFilename// * Type:String * Description:This parameter is the path and file name of the world file you want to use.
** {{wiki:PublicMethod.gif|}} Jpeg2000RasterSource(String,RectangleShape) ** * //This is a constructor for the class.// == Remarks == * //This constructor gets the RasterSource ready to use.// == Parameters == * //imagePathFilename// * Type:String * Description:This parameter is the path and file name of the ECW file you want to use. * //imageExtent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:This parameter is the image extent of ECW file you want to use.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} CloneDeep() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.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.Shapes.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.Drawing.GeoImage|GeoImage]] * Description:N/A == Parameters == * //worldExtent// * Type:[[ThinkGeo.MapSuite.Shapes.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|}} GetImageWidthCore() ** * //N/A// == 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() ** * //N/A// == 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() ** * //N/A// == 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() ** * //N/A// == 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) ** * //N/A// == Remarks == * //This method is responsible for returning the image based on the parameters passed in.// == Return Value == * Type:[[ThinkGeo.MapSuite.Drawing.GeoImage|GeoImage]] * Description:This method returns an image based on the worldExtent and raster image width and height. == Parameters == * //worldExtent// * Type:[[ThinkGeo.MapSuite.Shapes.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() ** * //N/A// == Remarks == * //This method returns the bounding box of the RasterSource.// == Return Value == * Type:[[ThinkGeo.MapSuite.Shapes.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.Layers.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnChangedSourceStatus(ChangedSourceStatusEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Layers.ChangedSourceStatusEventArgs|ChangedSourceStatusEventArgs]] * 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.Layers.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.Layers.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.Layers.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.RasterSource|RasterSource]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Drawing.GeoImage|GeoImage]] * Description:N/A == Parameters == * //boundingBox// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A * //screenWidth// * Type:Double * Description:N/A * //screenHeight// * Type:Double * Description:N/A * //wrappingExtent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Drawing.GeoImage|GeoImage]] * Description:N/A == Parameters == * //boundingBox// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A * //screenWidth// * Type:Double * Description:N/A * //screenHeight// * Type:Double * Description:N/A * //wrappingExtent// * Type:[[ThinkGeo.MapSuite.Shapes.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 ** * //N/A// == 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.Shapes.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|}} ScaleFactor ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Double ** {{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 ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} OpeningRasterSource ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} OpenedRasterSource ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} ClosingRasterSource ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} ClosedRasterSource ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]