thinkgeo.mapsuite.core.unmanagedgeotiffrastersource
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.unmanagedgeotiffrastersource [2015/09/18 05:53] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.UnmanagedGeoTiffRasterSource ====== | ||
| - | This class allows you to view TIFF image types. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | *ThinkGeo.MapSuite.Core.RasterSource | ||
| - | ***ThinkGeo.MapSuite.Core.UnmanagedGeoTiffRasterSource** | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} UnmanagedGeoTiffRasterSource() ** | ||
| - | |||
| - | This is the constructor the for the class. If you use this constructor then you need to set the required properties manually. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} UnmanagedGeoTiffRasterSource(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 TIFF file you wish to work with. Note that the TIFF 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 TIFF file you want to load into the class for display. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} UnmanagedGeoTiffRasterSource(String,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 TIFF file you wish to work with and world file belongs to it. Note that the TIFF 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 TIFF file you want to load into the class for display. | ||
| - | |||
| - | * //worldfilePathFilename// | ||
| - | * Type:String | ||
| - | * Description:This parameter represents the path and file name of the world file you want to load into the class for display. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} UnmanagedGeoTiffRasterSource(String,RectangleShape) ** | ||
| - | |||
| - | 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 TIFF file you wish to work with and image extent belongs to it. Note that the TIFF 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 TIFF file you want to load into the class for display. | ||
| - | |||
| - | * //imageExtent// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:This parameter represents the extent of the world file you want to load into the class for display. | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== 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 == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** | ||
| - | |||
| - | This method returns the width of the image in screen coordinates. | ||
| - | == Remarks == | ||
| - | This virtual method is called from the concreate method GetImageWidth. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:This method returns the width of the image in screen coordinates. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** | ||
| - | |||
| - | This method returns the height of the image in screen coordinates. | ||
| - | == Remarks == | ||
| - | This virtual method is called from the concreate method GetImageHeight. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:This method returns the height of the image in screen coordinates. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
| - | |||
| - | This method opens the TIFFSource so that it is initialized and ready to use. | ||
| - | == 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 RasterSource. Most methods on the RasterSource will throw an exception if the state of the RasterSource is not opened. When the map draws each layer it will open the RasterSource 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 RasterSource. When implementing this virtual 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 == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | |||
| - | This method opens the RasterSource so that it is initialized and ready to use. | ||
| - | == 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 RasterSource. 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. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** | ||
| - | |||
| - | This method returns an image based on the worldExtent and image width and height. | ||
| - | == Remarks == | ||
| - | This method is responsible for returning the image based on the parameters passed in. As the core version of this method is abstract you will need to override it when creating our own RasterSource. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| - | * Description:This method returns an image based on the worldExtent and 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 image you want to draw. | ||
| - | |||
| - | * //canvasHeight// | ||
| - | * Type:Int32 | ||
| - | * Description:This parameter represents the height of the image you want to draw. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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 == | ||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} PathFilename ** | ||
| - | |||
| - | This property gets and sets the path and filename of the TIFF file you want to use. | ||
| - | == Remarks == | ||
| - | None. | ||
| - | == 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 ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == 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]] | ||
| - | |||
thinkgeo.mapsuite.core.unmanagedgeotiffrastersource.1442555633.txt.gz ยท Last modified: 2015/09/18 05:53 by admin
