User Tools

Site Tools


thinkgeo.mapsuite.core.worldfile

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.core.worldfile [2015/08/20 03:08]
127.0.0.1 external edit
— (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.Core.WorldFile ====== 
- 
- 
- 
-<!-- Class --> 
-This class represents the values of a world file. 
-=== Remarks === 
-A world file is an attribute file that is associated with a corresponding image file. Typically, the world file consists of 6 lines of numbers. 
-===== Inheritance Hierarchy ===== 
-*System.Object 
-**[[ThinkGeo.MapSuite.Core.WorldFile]] 
-===== Members Summary ===== 
-==== Public Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WorldFile()|WorldFile]] ​  ​| ​   |    | This is the default constructor for the WorldFile class. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WorldFile(String)|WorldFile]] ​  | String ​  ​| ​   | This is the constructor that passes the worldFile text.   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WorldFile(RectangleShape,​ Single, Single)|WorldFile]] ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],​ Single, Single ​  ​| ​   | This is the constructor that passes the WorldExtent of the image, the height of the image, and the width of the image. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WorldFile(Double,​ Double, Double, Double, Double, Double)|WorldFile]] ​  | Double, Double, Double, Double, Double, Double ​  ​| ​   | This is a constructor that passes 6 attributes in double associated with the corresponding image file.   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WorldFile(Single,​ Single, Single, Single, Single, Single)|WorldFile]] ​  | Single, Single, Single, Single, Single, Single ​  ​| ​   | This is a constructor that passes 6 attributes in float associated with the corresponding image file.   | 
- 
-==== Protected Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
-==== Public Methods ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetBoundingBox(Single,​ Single)|GetBoundingBox]] ​  | Single, Single ​  ​| ​   |    | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   | 
- 
-==== Protected Methods ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   | 
- 
-==== Public Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​HorizontalResolution|HorizontalResolution]] ​  | Single ​  ​| ​   | This property gets the horizontal resolution from the world file.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​RotationColumn|RotationColumn]] ​  | Single ​  ​| ​   | This property gets the rotation in column from the world file.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​RotationRow|RotationRow]] ​  | Single ​  ​| ​   | This property gets the rotation in row from the world file.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​UpperLeftX|UpperLeftX]] ​  | Single ​  ​| ​   | This property gets the upper left Y coordinate from the world file.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​UpperLeftY|UpperLeftY]] ​  | Single ​  ​| ​   | This property gets the upper left X coordinate from the world file.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​VerticalResolution|VerticalResolution]] ​  | Single ​  ​| ​   | This property gets the vertical resolution from the world file.   | 
- 
-==== Protected Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
- 
-==== Public Events ==== 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ 
- 
-===== Public Constructors ===== 
-==== WorldFile() ==== 
-This is the default constructor for the WorldFile class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-[[#Public Constructors|Go Back]] 
-==== WorldFile(String) ==== 
-This is the constructor that passes the worldFile text. 
-=== Remarks === 
-The worldFileText is typically read from a world file. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| worldFileText ​  | String<​!-- System.String --> ​  | The world file text containing the world file attribute information. ​  | 
- 
-[[#Public Constructors|Go Back]] 
-==== WorldFile(RectangleShape,​ Single, Single) ==== 
-This is the constructor that passes the WorldExtent of the image, the height of the image, and the width of the image. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| worldExtent ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<​!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  | This parameter specifies the World Coordinate Extent for the image. ​  | 
-| imageWidth ​  | Single<​!-- System.Single --> ​  | This parameter specifies the image width for the image. ​  | 
-| imageHeight ​  | Single<​!-- System.Single --> ​  | This parameter specifies the image height for the image. ​  | 
- 
-[[#Public Constructors|Go Back]] 
-==== WorldFile(Double,​ Double, Double, Double, Double, Double) ==== 
-This is a constructor that passes 6 attributes in double associated with the corresponding image file. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| horizontalResolution ​  | Double<​!-- System.Double --> ​  | This parameter specifies the size of pixels in the x direction. ​  | 
-| rotationRow ​  | Double<​!-- System.Double --> ​  | This parameter specifies the rotation term for row.   | 
-| rotationColumn ​  | Double<​!-- System.Double --> ​  | This parameter specifes the rotation term for column. ​  | 
-| verticalResolution ​  | Double<​!-- System.Double --> ​  | This parameter specifies the size of pixels in the y direction. ​  | 
-| upperLeftX ​  | Double<​!-- System.Double --> ​  | This parameter represents the x coordinate of the center of the upper-leftmost pixel in map units. ​  | 
-| upperLeftY ​  | Double<​!-- System.Double --> ​  | This parameter represents the y coordinate of the center of the upper-leftmost pixel in map units. ​  | 
- 
-[[#Public Constructors|Go Back]] 
-==== WorldFile(Single,​ Single, Single, Single, Single, Single) ==== 
-This is a constructor that passes 6 attributes in float associated with the corresponding image file. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| horizontalResolution ​  | Single<​!-- System.Single --> ​  | This parameter specifies the size of pixels in the x direction. ​  | 
-| rotationRow ​  | Single<​!-- System.Single --> ​  | This parameter specifies the rotation term for row.   | 
-| rotationColumn ​  | Single<​!-- System.Single --> ​  | This parameter specifes the rotation term for column. ​  | 
-| verticalResolution ​  | Single<​!-- System.Single --> ​  | This parameter specifies the size of pixels in the y direction. ​  | 
-| upperLeftX ​  | Single<​!-- System.Single --> ​  | This parameter represents the x coordinate of the center of the upper-leftmost pixel in map units. ​  | 
-| upperLeftY ​  | Single<​!-- System.Single --> ​  | This parameter represents the y coordinate of the center of the upper-leftmost pixel in map units. ​  | 
- 
-[[#Public Constructors|Go Back]] 
-===== Protected Constructors ===== 
-===== Public Methods ===== 
-==== Equals(Object) ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Boolean<​!-- System.Boolean --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   | 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== GetBoundingBox(Single,​ Single) ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<​!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| width   | Single<​!-- System.Single --> ​  ​| ​   | 
-| height ​  | Single<​!-- System.Single --> ​  ​| ​   | 
- 
-<!-- ThinkGeo.MapSuite.Core.WorldFile --> 
-[[#Public Methods|Go Back]] 
-==== GetHashCode() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Int32<​!-- System.Int32 --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== GetType() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Type<!-- System.Type --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== ToString() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| String<​!-- System.String --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-===== Protected Methods ===== 
-==== Finalize() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-==== MemberwiseClone() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Object<​!-- System.Object --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-===== Public Properties ===== 
-==== HorizontalResolution ==== 
-This property gets the horizontal resolution from the world file. 
-=== Return Value === 
-^ Return Type ^ 
-| Single<​!-- System.Single --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.WorldFile --> 
-[[#Public Properties|Go Back]] 
-==== RotationColumn ==== 
-This property gets the rotation in column from the world file. 
-=== Return Value === 
-^ Return Type ^ 
-| Single<​!-- System.Single --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.WorldFile --> 
-[[#Public Properties|Go Back]] 
-==== RotationRow ==== 
-This property gets the rotation in row from the world file. 
-=== Return Value === 
-^ Return Type ^ 
-| Single<​!-- System.Single --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.WorldFile --> 
-[[#Public Properties|Go Back]] 
-==== UpperLeftX ==== 
-This property gets the upper left Y coordinate from the world file. 
-=== Return Value === 
-^ Return Type ^ 
-| Single<​!-- System.Single --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.WorldFile --> 
-[[#Public Properties|Go Back]] 
-==== UpperLeftY ==== 
-This property gets the upper left X coordinate from the world file. 
-=== Return Value === 
-^ Return Type ^ 
-| Single<​!-- System.Single --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.WorldFile --> 
-[[#Public Properties|Go Back]] 
-==== VerticalResolution ==== 
-This property gets the vertical resolution from the world file. 
-=== Return Value === 
-^ Return Type ^ 
-| Single<​!-- System.Single --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.WorldFile --> 
-[[#Public Properties|Go Back]] 
-===== Protected Properties ===== 
-===== Public Events ===== 
-__NOTOC__ 
-[[Category:​MapSuiteCore]] 
-[[Category:​ThinkGeo.MapSuite.Core]] 
-[[Category:​UpdateDocumentation]] 
  
thinkgeo.mapsuite.core.worldfile.1440040130.txt.gz ยท Last modified: 2015/09/17 10:42 (external edit)