User Tools

Site Tools

Trace:
thinkgeo.mapsuite.portablecore.worldfile

Differences

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

Link to this comparison view

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

Page Tools