thinkgeo.mapsuite.core.rectangleshape
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.rectangleshape [2015/09/21 01:09] admin |
thinkgeo.mapsuite.core.rectangleshape [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.RectangleShape ====== | ====== ThinkGeo.MapSuite.Core.RectangleShape ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents a rectangle, which is defined as an upper left point and a lower right point. | This class represents a rectangle, which is defined as an upper left point and a lower right point. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 10: | Line 13: | ||
| ** {{wiki:PublicMethod.gif|}} RectangleShape() ** | ** {{wiki:PublicMethod.gif|}} RectangleShape() ** | ||
| - | This constructor creates a RectangleShape. | + | * //This constructor creates a RectangleShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} RectangleShape(PointShape,PointShape) ** | ** {{wiki:PublicMethod.gif|}} RectangleShape(PointShape,PointShape) ** | ||
| - | This constructor creates a RectangleShape. | + | * //This constructor creates a RectangleShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //upperLeftPoint// | * //upperLeftPoint// | ||
| Line 32: | Line 35: | ||
| ** {{wiki:PublicMethod.gif|}} RectangleShape(Double,Double,Double,Double) ** | ** {{wiki:PublicMethod.gif|}} RectangleShape(Double,Double,Double,Double) ** | ||
| - | This constructor creates a RectangleShape. | + | * //This constructor creates a RectangleShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //minX// | * //minX// | ||
| Line 55: | Line 58: | ||
| ** {{wiki:PublicMethod.gif|}} RectangleShape(String) ** | ** {{wiki:PublicMethod.gif|}} RectangleShape(String) ** | ||
| - | This constructor creates a RectangleShape. | + | * //This constructor creates a RectangleShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //wellKnownText// | * //wellKnownText// | ||
| Line 66: | Line 69: | ||
| ** {{wiki:PublicMethod.gif|}} RectangleShape(Byte[]) ** | ** {{wiki:PublicMethod.gif|}} RectangleShape(Byte[]) ** | ||
| - | This constructor creates a RectangleShape. | + | * //This constructor creates a RectangleShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //wellKnownBinary// | * //wellKnownBinary// | ||
| Line 79: | Line 82: | ||
| ** {{wiki:PublicMethod.gif|}} GetIntersection(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} GetIntersection(RectangleShape) ** | ||
| - | This method returns the intersection of the current RectangleShape and the target shape, defined as the set of all points which lie in both the current shape and the target shape. | + | * //This method returns the intersection of the current RectangleShape and the target shape, defined as the set of all points which lie in both the current shape and the target shape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 95: | Line 98: | ||
| ** {{wiki:PublicMethod.gif|}} ToPolygon() ** | ** {{wiki:PublicMethod.gif|}} ToPolygon() ** | ||
| - | This method returns the current shape as a PolygonShape. | + | * //This method returns the current shape as a PolygonShape.// |
| == Remarks == | == Remarks == | ||
| - | This method is mainly used to convert this GIS non-standard shape to a GIS standard shape. | + | * //This method is mainly used to convert this GIS non-standard shape to a GIS standard shape.// |
| == Return Value == | == Return Value == | ||
| Line 107: | Line 110: | ||
| ** {{wiki:PublicMethod.gif|}} ExpandToInclude(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} ExpandToInclude(BaseShape) ** | ||
| - | This method will expand the current RectangleShape to include the targetShape parameter. | + | * //This method will expand the current RectangleShape to include the targetShape parameter.// |
| == Remarks == | == Remarks == | ||
| - | There is also an overload that can expand the RectangleShape using a list of multiple shapes. | + | * //There is also an overload that can expand the RectangleShape using a list of multiple shapes.// |
| == Return Value == | == Return Value == | ||
| Line 123: | Line 126: | ||
| ** {{wiki:PublicMethod.gif|}} ExpandToInclude(Feature) ** | ** {{wiki:PublicMethod.gif|}} ExpandToInclude(Feature) ** | ||
| - | This method will expand the current RectangleShape to include the target feature parameter. | + | * //This method will expand the current RectangleShape to include the target feature parameter.// |
| == Remarks == | == Remarks == | ||
| - | There is also an overload that can expand the RectangleShape using a collection of features. | + | * //There is also an overload that can expand the RectangleShape using a collection of features.// |
| == Return Value == | == Return Value == | ||
| Line 139: | Line 142: | ||
| ** {{wiki:PublicMethod.gif|}} ExpandToInclude(IEnumerable<BaseShape>) ** | ** {{wiki:PublicMethod.gif|}} ExpandToInclude(IEnumerable<BaseShape>) ** | ||
| - | This method will expand the current RectangleShape to include the shapes in the targetShapes parameter. | + | * //This method will expand the current RectangleShape to include the shapes in the targetShapes parameter.// |
| == Remarks == | == Remarks == | ||
| - | There is also an overload that can expand the RectangleShape using a single shape. | + | * //There is also an overload that can expand the RectangleShape using a single shape.// |
| == Return Value == | == Return Value == | ||
| Line 155: | Line 158: | ||
| ** {{wiki:PublicMethod.gif|}} ExpandToInclude(IEnumerable<Feature>) ** | ** {{wiki:PublicMethod.gif|}} ExpandToInclude(IEnumerable<Feature>) ** | ||
| - | This method will expand the current RectangleShape to include the features in the targetFeatures parameter. | + | * //This method will expand the current RectangleShape to include the features in the targetFeatures parameter.// |
| == Remarks == | == Remarks == | ||
| - | There also is an overload that can expand the RectangleShape using a single feature. | + | * //There also is an overload that can expand the RectangleShape using a single feature.// |
| == Return Value == | == Return Value == | ||
| Line 171: | Line 174: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | This method returns a formatted representation of the UpperLeftPoint.X, UpperLeftPoint.Y, LowerRightPoint.X and LowerRightPoint.Y value. | + | * //This method returns a formatted representation of the UpperLeftPoint.X, UpperLeftPoint.Y, LowerRightPoint.X and LowerRightPoint.Y value.// |
| == Remarks == | == Remarks == | ||
| - | The value will be formatted in the standard string format: -180,90,180,-90" | + | * //The value will be formatted in the standard string format: -180,90,180,-90"// |
| == Return Value == | == Return Value == | ||
| Line 180: | Line 183: | ||
| == Parameters == | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetAccuratePerimeter(Int32,DistanceUnit,DistanceCalculationMode) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //shapeSrid// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //returningUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //distanceCalculationMode// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetAccuratePerimeter(String,DistanceUnit,DistanceCalculationMode) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //shapeProj4ProjectionParameters// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //returningUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //distanceCalculationMode// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} GetPerimeter(GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} GetPerimeter(GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 198: | Line 249: | ||
| * //returningUnit// | * //returningUnit// | ||
| * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetAccurateArea(Int32,AreaUnit,DistanceCalculationMode) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //shapeSrid// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //returningUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //distanceCalculationMode// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetAccurateArea(String,AreaUnit,DistanceCalculationMode) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //shapeProj4ProjectionParameters// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //returningUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //distanceCalculationMode// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | ||
| * Description:N/A | * Description:N/A | ||
| Line 203: | Line 302: | ||
| ** {{wiki:PublicMethod.gif|}} GetArea(GeographyUnit,AreaUnit) ** | ** {{wiki:PublicMethod.gif|}} GetArea(GeographyUnit,AreaUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 223: | Line 322: | ||
| ** {{wiki:PublicMethod.gif|}} ScaleUp(Double) ** | ** {{wiki:PublicMethod.gif|}} ScaleUp(Double) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 239: | Line 338: | ||
| ** {{wiki:PublicMethod.gif|}} ScaleDown(Double) ** | ** {{wiki:PublicMethod.gif|}} ScaleDown(Double) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 255: | Line 354: | ||
| ** {{wiki:PublicMethod.gif|}} GetConvexHull() ** | ** {{wiki:PublicMethod.gif|}} GetConvexHull() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 267: | Line 366: | ||
| ** {{wiki:PublicMethod.gif|}} GetIntersection(AreaBaseShape) ** | ** {{wiki:PublicMethod.gif|}} GetIntersection(AreaBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 283: | Line 382: | ||
| ** {{wiki:PublicMethod.gif|}} GetIntersection(Feature) ** | ** {{wiki:PublicMethod.gif|}} GetIntersection(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 299: | Line 398: | ||
| ** {{wiki:PublicMethod.gif|}} Union(AreaBaseShape) ** | ** {{wiki:PublicMethod.gif|}} Union(AreaBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 315: | Line 414: | ||
| ** {{wiki:PublicMethod.gif|}} Union(Feature) ** | ** {{wiki:PublicMethod.gif|}} Union(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 331: | Line 430: | ||
| ** {{wiki:PublicMethod.gif|}} GetDifference(AreaBaseShape) ** | ** {{wiki:PublicMethod.gif|}} GetDifference(AreaBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 347: | Line 446: | ||
| ** {{wiki:PublicMethod.gif|}} GetDifference(Feature) ** | ** {{wiki:PublicMethod.gif|}} GetDifference(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 363: | Line 462: | ||
| ** {{wiki:PublicMethod.gif|}} GetSymmetricalDifference(AreaBaseShape) ** | ** {{wiki:PublicMethod.gif|}} GetSymmetricalDifference(AreaBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 379: | Line 478: | ||
| ** {{wiki:PublicMethod.gif|}} GetSymmetricalDifference(Feature) ** | ** {{wiki:PublicMethod.gif|}} GetSymmetricalDifference(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 395: | Line 494: | ||
| ** {{wiki:PublicMethod.gif|}} Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType) ** | ** {{wiki:PublicMethod.gif|}} Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 423: | Line 522: | ||
| ** {{wiki:PublicMethod.gif|}} Simplify(Double,SimplificationType) ** | ** {{wiki:PublicMethod.gif|}} Simplify(Double,SimplificationType) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 443: | Line 542: | ||
| ** {{wiki:PublicMethod.gif|}} LoadFromWellKnownData(String) ** | ** {{wiki:PublicMethod.gif|}} LoadFromWellKnownData(String) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 459: | Line 558: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 471: | Line 570: | ||
| ** {{wiki:PublicMethod.gif|}} GetGeoJson() ** | ** {{wiki:PublicMethod.gif|}} GetGeoJson() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 483: | Line 582: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownText(RingOrder) ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownText(RingOrder) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 499: | Line 598: | ||
| ** {{wiki:PublicMethod.gif|}} LoadFromWellKnownData(Byte[]) ** | ** {{wiki:PublicMethod.gif|}} LoadFromWellKnownData(Byte[]) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 515: | Line 614: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 527: | Line 626: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary(WkbByteOrder) ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary(WkbByteOrder) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 543: | Line 642: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary(RingOrder) ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary(RingOrder) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 559: | Line 658: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary(RingOrder,WkbByteOrder) ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary(RingOrder,WkbByteOrder) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 579: | Line 678: | ||
| ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 591: | Line 690: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 603: | Line 702: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 615: | Line 714: | ||
| ** {{wiki:PublicMethod.gif|}} TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 643: | Line 742: | ||
| ** {{wiki:PublicMethod.gif|}} TranslateByOffset(Double,Double) ** | ** {{wiki:PublicMethod.gif|}} TranslateByOffset(Double,Double) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 663: | Line 762: | ||
| ** {{wiki:PublicMethod.gif|}} TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 691: | Line 790: | ||
| ** {{wiki:PublicMethod.gif|}} TranslateByDegree(Double,Double) ** | ** {{wiki:PublicMethod.gif|}} TranslateByDegree(Double,Double) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 711: | Line 810: | ||
| ** {{wiki:PublicMethod.gif|}} Rotate(PointShape,Single) ** | ** {{wiki:PublicMethod.gif|}} Rotate(PointShape,Single) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 731: | Line 830: | ||
| ** {{wiki:PublicMethod.gif|}} GetShortestLineTo(BaseShape,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetShortestLineTo(BaseShape,GeographyUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 751: | Line 850: | ||
| ** {{wiki:PublicMethod.gif|}} GetShortestLineTo(Feature,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetShortestLineTo(Feature,GeographyUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 771: | Line 870: | ||
| ** {{wiki:PublicMethod.gif|}} GetClosestPointTo(BaseShape,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetClosestPointTo(BaseShape,GeographyUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 791: | Line 890: | ||
| ** {{wiki:PublicMethod.gif|}} GetClosestPointTo(Feature,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetClosestPointTo(Feature,GeographyUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 811: | Line 910: | ||
| ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 823: | Line 922: | ||
| ** {{wiki:PublicMethod.gif|}} Buffer(Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} Buffer(Double,GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 847: | Line 946: | ||
| ** {{wiki:PublicMethod.gif|}} Buffer(Double,Int32,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} Buffer(Double,Int32,GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 875: | Line 974: | ||
| ** {{wiki:PublicMethod.gif|}} Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 907: | Line 1006: | ||
| ** {{wiki:PublicMethod.gif|}} GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 931: | Line 1030: | ||
| ** {{wiki:PublicMethod.gif|}} GetDistanceTo(Feature,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} GetDistanceTo(Feature,GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 955: | Line 1054: | ||
| ** {{wiki:PublicMethod.gif|}} Register(PointShape,PointShape,DistanceUnit,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} Register(PointShape,PointShape,DistanceUnit,GeographyUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 983: | Line 1082: | ||
| ** {{wiki:PublicMethod.gif|}} Register(Feature,Feature,DistanceUnit,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} Register(Feature,Feature,DistanceUnit,GeographyUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1011: | Line 1110: | ||
| ** {{wiki:PublicMethod.gif|}} Validate(ShapeValidationMode) ** | ** {{wiki:PublicMethod.gif|}} Validate(ShapeValidationMode) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1027: | Line 1126: | ||
| ** {{wiki:PublicMethod.gif|}} IsDisjointed(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} IsDisjointed(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1043: | Line 1142: | ||
| ** {{wiki:PublicMethod.gif|}} IsDisjointed(Feature) ** | ** {{wiki:PublicMethod.gif|}} IsDisjointed(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1059: | Line 1158: | ||
| ** {{wiki:PublicMethod.gif|}} Intersects(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Intersects(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1075: | Line 1174: | ||
| ** {{wiki:PublicMethod.gif|}} Intersects(Feature) ** | ** {{wiki:PublicMethod.gif|}} Intersects(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1091: | Line 1190: | ||
| ** {{wiki:PublicMethod.gif|}} Touches(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Touches(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1107: | Line 1206: | ||
| ** {{wiki:PublicMethod.gif|}} Touches(Feature) ** | ** {{wiki:PublicMethod.gif|}} Touches(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1123: | Line 1222: | ||
| ** {{wiki:PublicMethod.gif|}} Crosses(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Crosses(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1139: | Line 1238: | ||
| ** {{wiki:PublicMethod.gif|}} Crosses(Feature) ** | ** {{wiki:PublicMethod.gif|}} Crosses(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1155: | Line 1254: | ||
| ** {{wiki:PublicMethod.gif|}} IsWithin(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} IsWithin(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1171: | Line 1270: | ||
| ** {{wiki:PublicMethod.gif|}} IsWithin(Feature) ** | ** {{wiki:PublicMethod.gif|}} IsWithin(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1187: | Line 1286: | ||
| ** {{wiki:PublicMethod.gif|}} Contains(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Contains(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1203: | Line 1302: | ||
| ** {{wiki:PublicMethod.gif|}} Contains(Feature) ** | ** {{wiki:PublicMethod.gif|}} Contains(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1219: | Line 1318: | ||
| ** {{wiki:PublicMethod.gif|}} Overlaps(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Overlaps(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1235: | Line 1334: | ||
| ** {{wiki:PublicMethod.gif|}} Overlaps(Feature) ** | ** {{wiki:PublicMethod.gif|}} Overlaps(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1251: | Line 1350: | ||
| ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1267: | Line 1366: | ||
| ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(Feature) ** | ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(Feature) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1283: | Line 1382: | ||
| ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1295: | Line 1394: | ||
| ** {{wiki:PublicMethod.gif|}} GetFeature(IDictionary<String,String>) ** | ** {{wiki:PublicMethod.gif|}} GetFeature(IDictionary<String,String>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1311: | Line 1410: | ||
| ** {{wiki:PublicMethod.gif|}} GetCrossing(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} GetCrossing(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1327: | Line 1426: | ||
| ** {{wiki:PublicMethod.gif|}} ScaleTo(Double) ** | ** {{wiki:PublicMethod.gif|}} ScaleTo(Double) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1343: | Line 1442: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1359: | Line 1458: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1371: | Line 1470: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1384: | Line 1483: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetWellKnownTypeCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownTypeCore() ** | ||
| - | This method returns the well-known type for the shape. | + | * //This method returns the well-known type for the shape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 1396: | Line 1495: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | This method returns a complete copy of the shape without any references in common. | + | * //This method returns a complete copy of the shape without any references in common.// |
| == Remarks == | == Remarks == | ||
| - | When you override this method, you need to ensure that there are no references in common between the original and copy. | + | * //When you override this method, you need to ensure that there are no references in common between the original and copy.// |
| == Return Value == | == Return Value == | ||
| Line 1408: | Line 1507: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ||
| - | This method returns the center point of the current shape's bounding box. | + | * //This method returns the center point of the current shape's bounding box.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the center point of the current shape's bounding box. It is important to note that this is the center point of the bounding box. There are numerous ways to calculate the "center" of a geometry such, as its weighted center, etc. You can find other centers by examining the various methods of the shape itself. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //This method returns the center point of the current shape's bounding box. It is important to note that this is the center point of the bounding box. There are numerous ways to calculate the "center" of a geometry such, as its weighted center, etc. You can find other centers by examining the various methods of the shape itself. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
| == Return Value == | == Return Value == | ||
| Line 1420: | Line 1519: | ||
| ** {{wiki:ProtectedMethod.gif|}} ExpandToIncludeCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} ExpandToIncludeCore(BaseShape) ** | ||
| - | This method will expand the current RectangleShape to include the shape in the targetShape parameter. | + | * //This method will expand the current RectangleShape to include the shape in the targetShape parameter.// |
| == Remarks == | == Remarks == | ||
| - | There is also an overload that can expand the RectangleShape using a list of shapes. | + | * //There is also an overload that can expand the RectangleShape using a list of shapes.// |
| == Return Value == | == Return Value == | ||
| Line 1436: | Line 1535: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetPerimeterCore(GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetPerimeterCore(GeographyUnit,DistanceUnit) ** | ||
| - | This method returns the perimeter of the shape (defined as the sum of the lengths of all its sides). | + | * //This method returns the perimeter of the shape (defined as the sum of the lengths of all its sides).// |
| == Remarks == | == Remarks == | ||
| - | You would use this method to find the distance around the area shape. | + | * //You would use this method to find the distance around the area shape.// |
| == Return Value == | == Return Value == | ||
| Line 1456: | Line 1555: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetAreaCore(GeographyUnit,AreaUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetAreaCore(GeographyUnit,AreaUnit) ** | ||
| - | This method returns the area of the shape (defined as the size of the region enclosed by the figure). | + | * //This method returns the area of the shape (defined as the size of the region enclosed by the figure).// |
| == Remarks == | == Remarks == | ||
| - | You would use this method to find the area inside the shape. | + | * //You would use this method to find the area inside the shape.// |
| == Return Value == | == Return Value == | ||
| Line 1476: | Line 1575: | ||
| ** {{wiki:ProtectedMethod.gif|}} ScaleUpCore(Double) ** | ** {{wiki:ProtectedMethod.gif|}} ScaleUpCore(Double) ** | ||
| - | This method increases the size of the area shape by the percentage given in the percentage parameter. | + | * //This method increases the size of the area shape by the percentage given in the percentage parameter.// |
| == Remarks == | == Remarks == | ||
| - | This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster, as you are applying the operation multiple times. There is also a ScaleDown method that will shrink the shape. | + | * //This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster, as you are applying the operation multiple times. There is also a ScaleDown method that will shrink the shape.// |
| == Return Value == | == Return Value == | ||
| Line 1492: | Line 1591: | ||
| ** {{wiki:ProtectedMethod.gif|}} ScaleDownCore(Double) ** | ** {{wiki:ProtectedMethod.gif|}} ScaleDownCore(Double) ** | ||
| - | This method decreases the size of the area shape by the percentage given in the percentage parameter. | + | * //This method decreases the size of the area shape by the percentage given in the percentage parameter.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 1508: | Line 1607: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
| - | This method calculates the smallest RectangleShape that encompasses the entire geometry. | + | * //This method calculates the smallest RectangleShape that encompasses the entire geometry.// |
| == Remarks == | == Remarks == | ||
| - | The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. Depending on the number of PointShapes and complexity of the geometry, this operation can take longer for larger objects. If the shape is a PointShape, then the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area. | + | * //The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. Depending on the number of PointShapes and complexity of the geometry, this operation can take longer for larger objects. If the shape is a PointShape, then the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area.// |
| == Return Value == | == Return Value == | ||
| Line 1520: | Line 1619: | ||
| ** {{wiki:ProtectedMethod.gif|}} RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}} RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit) ** | ||
| - | This method returns a MultipointShape which has been registered from its original coordinate system to another based on two anchor PointShapes. | + | * //This method returns a MultipointShape which has been registered from its original coordinate system to another based on two anchor PointShapes.// |
| == Remarks == | == Remarks == | ||
| - | The register method is useful, for example, when a group of points represented by a MultipointShape has been generated in a non-geographic coordinate in meters, and you want to plot the points on a map that is in decimal degrees. | + | * //The register method is useful, for example, when a group of points represented by a MultipointShape has been generated in a non-geographic coordinate in meters, and you want to plot the points on a map that is in decimal degrees.// |
| == Return Value == | == Return Value == | ||
| Line 1548: | Line 1647: | ||
| ** {{wiki:ProtectedMethod.gif|}} TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method moves the base shape from one location to another, based on an X and Y offset distance. | + | * //This method moves the base shape from one location to another, based on an X and Y offset distance.// |
| == Remarks == | == Remarks == | ||
| - | This method moves the base shape from one location to another, based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape 1 unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles to on the X axis and 3 miles on the Y axis. | + | * //This method moves the base shape from one location to another, based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape 1 unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles to on the X axis and 3 miles on the Y axis.// |
| == Return Value == | == Return Value == | ||
| Line 1576: | Line 1675: | ||
| ** {{wiki:ProtectedMethod.gif|}} TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method moves the shape from one location to another, based on a direction in degrees and distance. | + | * //This method moves the shape from one location to another, based on a direction in degrees and distance.// |
| == Remarks == | == Remarks == | ||
| - | This method moves the base shape from one location to another, based on an angleInDegrees and distance parameter. With this overload, it is important to note that the distance units are the same GeographicUnit as the shape. For example, if your shape is in decimal degrees and you call this method with a distance of 1, you're going to move this shape 1 decimal degree in direction of the angleInDegrees. In many cases it is more useful to specify the DistanceUnit of movement, such as in miles or yards, so for these scenarios there is another overload you may want to use instead.If you pass a distance of 0, then the operation is ignored. | + | * //This method moves the base shape from one location to another, based on an angleInDegrees and distance parameter. With this overload, it is important to note that the distance units are the same GeographicUnit as the shape. For example, if your shape is in decimal degrees and you call this method with a distance of 1, you're going to move this shape 1 decimal degree in direction of the angleInDegrees. In many cases it is more useful to specify the DistanceUnit of movement, such as in miles or yards, so for these scenarios there is another overload you may want to use instead.If you pass a distance of 0, then the operation is ignored.// |
| == Return Value == | == Return Value == | ||
| Line 1604: | Line 1703: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetClosestPointToCore(BaseShape,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetClosestPointToCore(BaseShape,GeographyUnit) ** | ||
| - | This method returns the point of the current shape that is closest to the target shape. | + | * //This method returns the point of the current shape that is closest to the target shape.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the point of the current shape that is closest to the target shape. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetShape to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line. | + | * //This method returns the point of the current shape that is closest to the target shape. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetShape to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line.// |
| == Return Value == | == Return Value == | ||
| Line 1624: | Line 1723: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit) ** | ||
| - | This method computes the distance between the current shape and the targetShape. | + | * //This method computes the distance between the current shape and the targetShape.// |
| == Remarks == | == Remarks == | ||
| - | In this method, we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified. | + | * //In this method, we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified.// |
| == Return Value == | == Return Value == | ||
| Line 1648: | Line 1747: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetWellKnownTextCore(RingOrder) ** | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownTextCore(RingOrder) ** | ||
| - | This method returns the well-known text representation of this shape. | + | * //This method returns the well-known text representation of this shape.// |
| == Remarks == | == Remarks == | ||
| - | This method returns a string that represents the shape in well-known text. Well-known text allows you to describe a geometry as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometric shapes.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3))MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3))MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4))) | + | * //This method returns a string that represents the shape in well-known text. Well-known text allows you to describe a geometry as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometric shapes.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3))MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3))MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4)))// |
| == Return Value == | == Return Value == | ||
| Line 1664: | Line 1763: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetWellKnownBinaryCore(RingOrder,WkbByteOrder) ** | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownBinaryCore(RingOrder,WkbByteOrder) ** | ||
| - | This method returns a byte array that represents the shape in well-known binary. | + | * //This method returns a byte array that represents the shape in well-known binary.// |
| == Remarks == | == Remarks == | ||
| - | This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe a geometry as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well-known text as well. | + | * //This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe a geometry as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well-known text as well.// |
| == Return Value == | == Return Value == | ||
| Line 1684: | Line 1783: | ||
| ** {{wiki:ProtectedMethod.gif|}} LoadFromWellKnownDataCore(String) ** | ** {{wiki:ProtectedMethod.gif|}} LoadFromWellKnownDataCore(String) ** | ||
| - | This method hydrates the current shape with its data from well-known text. | + | * //This method hydrates the current shape with its data from well-known text.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 1700: | Line 1799: | ||
| ** {{wiki:ProtectedMethod.gif|}} LoadFromWellKnownDataCore(Byte[]) ** | ** {{wiki:ProtectedMethod.gif|}} LoadFromWellKnownDataCore(Byte[]) ** | ||
| - | This method hydrates the current shape with its data from well-known binary. | + | * //This method hydrates the current shape with its data from well-known binary.// |
| == Remarks == | == Remarks == | ||
| - | This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method. | + | * //This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method.// |
| == Return Value == | == Return Value == | ||
| Line 1716: | Line 1815: | ||
| ** {{wiki:ProtectedMethod.gif|}} IsDisjointedCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IsDisjointedCore(BaseShape) ** | ||
| - | This method returns whether the current shape and the targetShape have no points in common. | + | * //This method returns whether the current shape and the targetShape have no points in common.// |
| == Remarks == | == Remarks == | ||
| - | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
| == Return Value == | == Return Value == | ||
| Line 1732: | Line 1831: | ||
| ** {{wiki:ProtectedMethod.gif|}} ValidateCore(ShapeValidationMode) ** | ** {{wiki:ProtectedMethod.gif|}} ValidateCore(ShapeValidationMode) ** | ||
| - | This method returns a ShapeValidationResult based on a series of tests. | + | * //This method returns a ShapeValidationResult based on a series of tests.// |
| == Remarks == | == Remarks == | ||
| - | We use this method, with the simple enumeration, internally before doing any kind of other methods on the shape. In this way, we are able to verify the integrity of the shape itself. If you wish to test things such as whether a polygon self-intersects, we invite you to call this method with the advanced ShapeValidationMode. One thing to consider is that for complex polygon shapes this operation could take some time, which is why we only run the basic, faster test. If you are dealing with polygon shapes that are suspect, we suggest you run the advanced test. | + | * //We use this method, with the simple enumeration, internally before doing any kind of other methods on the shape. In this way, we are able to verify the integrity of the shape itself. If you wish to test things such as whether a polygon self-intersects, we invite you to call this method with the advanced ShapeValidationMode. One thing to consider is that for complex polygon shapes this operation could take some time, which is why we only run the basic, faster test. If you are dealing with polygon shapes that are suspect, we suggest you run the advanced test.// |
| == Return Value == | == Return Value == | ||
| Line 1748: | Line 1847: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetCrossingCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} GetCrossingCore(BaseShape) ** | ||
| - | This method returns the crossing points between the current shape and the passed-in target shape. | + | * //This method returns the crossing points between the current shape and the passed-in target shape.// |
| == Remarks == | == Remarks == | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
| == Return Value == | == Return Value == | ||
| Line 1764: | Line 1863: | ||
| ** {{wiki:ProtectedMethod.gif|}} ContainsCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} ContainsCore(BaseShape) ** | ||
| - | This method returns if the targetShape lies within the interior of the current shape. | + | * //This method returns if the targetShape lies within the interior of the current shape.// |
| == Remarks == | == Remarks == | ||
| - | Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
| == Return Value == | == Return Value == | ||
| Line 1776: | Line 1875: | ||
| * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| * Description:The shape you wish to compare the current one to. | * Description:The shape you wish to compare the current one to. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetAccuratePerimeterCore(String,DistanceUnit,DistanceCalculationMode) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //shapeProj4ProjectionParameters// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //returningUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //distanceCalculationMode// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetAccurateAreaCore(String,AreaUnit,DistanceCalculationMode) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //shapeProj4ProjectionParameters// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //returningUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.AreaUnit|AreaUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //distanceCalculationMode// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceCalculationMode|DistanceCalculationMode]] | ||
| + | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} GetConvexHullCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetConvexHullCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1792: | Line 1939: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetIntersectionCore(AreaBaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} GetIntersectionCore(AreaBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1808: | Line 1955: | ||
| ** {{wiki:ProtectedMethod.gif|}} UnionCore(AreaBaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} UnionCore(AreaBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1824: | Line 1971: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetDifferenceCore(AreaBaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} GetDifferenceCore(AreaBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1840: | Line 1987: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetSymmetricalDifferenceCore(AreaBaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} GetSymmetricalDifferenceCore(AreaBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1856: | Line 2003: | ||
| ** {{wiki:ProtectedMethod.gif|}} SimplifyCore(Double,SimplificationType) ** | ** {{wiki:ProtectedMethod.gif|}} SimplifyCore(Double,SimplificationType) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1876: | Line 2023: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetGeoJsonCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetGeoJsonCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1888: | Line 2035: | ||
| ** {{wiki:ProtectedMethod.gif|}} RotateCore(PointShape,Single) ** | ** {{wiki:ProtectedMethod.gif|}} RotateCore(PointShape,Single) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1908: | Line 2055: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetShortestLineToCore(BaseShape,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetShortestLineToCore(BaseShape,GeographyUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1928: | Line 2075: | ||
| ** {{wiki:ProtectedMethod.gif|}} BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1960: | Line 2107: | ||
| ** {{wiki:ProtectedMethod.gif|}} IntersectsCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IntersectsCore(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1976: | Line 2123: | ||
| ** {{wiki:ProtectedMethod.gif|}} TouchesCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} TouchesCore(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1992: | Line 2139: | ||
| ** {{wiki:ProtectedMethod.gif|}} CrossesCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} CrossesCore(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2008: | Line 2155: | ||
| ** {{wiki:ProtectedMethod.gif|}} IsWithinCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IsWithinCore(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2024: | Line 2171: | ||
| ** {{wiki:ProtectedMethod.gif|}} OverlapsCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} OverlapsCore(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2040: | Line 2187: | ||
| ** {{wiki:ProtectedMethod.gif|}} IsTopologicallyEqualCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IsTopologicallyEqualCore(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2056: | Line 2203: | ||
| ** {{wiki:ProtectedMethod.gif|}} ScaleToCore(Double) ** | ** {{wiki:ProtectedMethod.gif|}} ScaleToCore(Double) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2072: | Line 2219: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2084: | Line 2231: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
thinkgeo.mapsuite.core.rectangleshape.1442797757.txt.gz · Last modified: 2015/09/21 01:09 by admin