Differences

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

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

User Tools

Site Tools

Differences

Page Tools