thinkgeo.mapsuite.core.multilineshape
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.multilineshape [2015/09/18 05:47] admin |
thinkgeo.mapsuite.core.multilineshape [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.MultilineShape ====== | ====== ThinkGeo.MapSuite.Core.MultilineShape ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents a MultilineShape, which is defined as one or more lines, each with two or more points. | This class represents a MultilineShape, which is defined as one or more lines, each with two or more points. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 10: | Line 13: | ||
| ** {{wiki:PublicMethod.gif|}} MultilineShape() ** | ** {{wiki:PublicMethod.gif|}} MultilineShape() ** | ||
| - | This constructor creates the MultilineShape. | + | * //This constructor creates the MultilineShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} MultilineShape(IEnumerable<LineShape>) ** | ** {{wiki:PublicMethod.gif|}} MultilineShape(IEnumerable<LineShape>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Parameters == | == Parameters == | ||
| * //lineShapes// | * //lineShapes// | ||
| Line 28: | Line 31: | ||
| ** {{wiki:PublicMethod.gif|}} MultilineShape(String) ** | ** {{wiki:PublicMethod.gif|}} MultilineShape(String) ** | ||
| - | This constructor creates the MultilineShape. | + | * //This constructor creates the MultilineShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //wellKnownText// | * //wellKnownText// | ||
| Line 39: | Line 42: | ||
| ** {{wiki:PublicMethod.gif|}} MultilineShape(Byte[]) ** | ** {{wiki:PublicMethod.gif|}} MultilineShape(Byte[]) ** | ||
| - | This constructor creates the MultilineShape. | + | * //This constructor creates the MultilineShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //wellKnownBinary// | * //wellKnownBinary// | ||
| Line 52: | Line 55: | ||
| ** {{wiki:PublicMethod.gif|}} Reorder(PointShape,Double) ** | ** {{wiki:PublicMethod.gif|}} Reorder(PointShape,Double) ** | ||
| - | This API is used to make the lines within the Multiline ordered. | + | * //This API is used to make the lines within the Multiline ordered.// |
| == Remarks == | == Remarks == | ||
| - | An ordered Multiline means that we can walk though the MultiLine from the first point to the last point without any branches, and that each line's end points should be within the given tolerance. If using this overload, the unit of the Multiline and the tolerance are both defaulted to meters. Please use the other overload if you want to specify the units yourself. | + | * //An ordered Multiline means that we can walk though the MultiLine from the first point to the last point without any branches, and that each line's end points should be within the given tolerance. If using this overload, the unit of the Multiline and the tolerance are both defaulted to meters. Please use the other overload if you want to specify the units yourself.// |
| == Return Value == | == Return Value == | ||
| Line 72: | Line 75: | ||
| ** {{wiki:PublicMethod.gif|}} Reorder(PointShape,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} Reorder(PointShape,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This API is used to make the lines within the Multiline ordered. | + | * //This API is used to make the lines within the Multiline ordered.// |
| == Remarks == | == Remarks == | ||
| - | An ordered Multiline means that we can walk though the MultiLine from the first point to the last point without any branches, and that each line's end points should be within the given tolerance. When using this overload, you can specify the unit for the Multiline as well as the unit for the tolerance. | + | * //An ordered Multiline means that we can walk though the MultiLine from the first point to the last point without any branches, and that each line's end points should be within the given tolerance. When using this overload, you can specify the unit for the Multiline as well as the unit for the tolerance.// |
| == Return Value == | == Return Value == | ||
| Line 100: | Line 103: | ||
| ** {{wiki:PublicMethod.gif|}} GetPointOnALine(StartingPoint,Single) ** | ** {{wiki:PublicMethod.gif|}} GetPointOnALine(StartingPoint,Single) ** | ||
| - | This method returns a PointShape on the line, based on a percentage of the length of the line from either its first or last vertex (as defined by the startingPoint parameter). | + | * //This method returns a PointShape on the line, based on a percentage of the length of the line from either its first or last vertex (as defined by the startingPoint parameter).// |
| == Remarks == | == Remarks == | ||
| - | If you pass 100 or 0 as the percentage of the line, it will return either the first or last vertex, depending on the value of the startingPoint argument. | + | * //If you pass 100 or 0 as the percentage of the line, it will return either the first or last vertex, depending on the value of the startingPoint argument.// |
| == Return Value == | == Return Value == | ||
| Line 120: | Line 123: | ||
| ** {{wiki:PublicMethod.gif|}} GetPointOnALine(StartingPoint,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} GetPointOnALine(StartingPoint,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method returns a PointShape on the line, based on a distance on the line from the first or last vertex (as defined by the startingPoint parameter). | + | * //This method returns a PointShape on the line, based on a distance on the line from the first or last vertex (as defined by the startingPoint parameter).// |
| == Remarks == | == Remarks == | ||
| - | Passing in a distance of 0 will return either the first or last point on the line, depending on the value of the startingPoint parameter. | + | * //Passing in a distance of 0 will return either the first or last point on the line, depending on the value of the startingPoint parameter.// |
| == Return Value == | == Return Value == | ||
| Line 148: | Line 151: | ||
| ** {{wiki:PublicMethod.gif|}} GetLineOnALine(StartingPoint,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} GetLineOnALine(StartingPoint,Single,Single) ** | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | + | * //This method returns a BaseLineShape, based on a starting position and other factors.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 172: | Line 175: | ||
| ** {{wiki:PublicMethod.gif|}} GetLineOnALine(StartingPoint,Single) ** | ** {{wiki:PublicMethod.gif|}} GetLineOnALine(StartingPoint,Single) ** | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | + | * //This method returns a BaseLineShape, based on a starting position and other factors.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 192: | Line 195: | ||
| ** {{wiki:PublicMethod.gif|}} GetLineOnALine(StartingPoint,Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} GetLineOnALine(StartingPoint,Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | + | * //This method returns a BaseLineShape, based on a starting position and other factors.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 224: | Line 227: | ||
| ** {{wiki:PublicMethod.gif|}} GetLineOnALine(StartingPoint,PointShape) ** | ** {{wiki:PublicMethod.gif|}} GetLineOnALine(StartingPoint,PointShape) ** | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | + | * //This method returns a BaseLineShape, based on a starting position and other factors.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 244: | Line 247: | ||
| ** {{wiki:PublicMethod.gif|}} GetLineOnALine(PointShape,PointShape) ** | ** {{wiki:PublicMethod.gif|}} GetLineOnALine(PointShape,PointShape) ** | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | + | * //This method returns a BaseLineShape, based on a starting position and other factors.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 264: | Line 267: | ||
| ** {{wiki:PublicMethod.gif|}} RemoveVertex(Vertex) ** | ** {{wiki:PublicMethod.gif|}} RemoveVertex(Vertex) ** | ||
| - | This method removes the selected vertex from multiline shape. | + | * //This method removes the selected vertex from multiline shape.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 280: | Line 283: | ||
| ** {{wiki:PublicMethod.gif|}} ToMultiPolygonShape() ** | ** {{wiki:PublicMethod.gif|}} ToMultiPolygonShape() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 292: | Line 295: | ||
| ** {{wiki:PublicMethod.gif|}} GetAccurateLength(Int32,DistanceUnit,DistanceCalculationMode) ** | ** {{wiki:PublicMethod.gif|}} GetAccurateLength(Int32,DistanceUnit,DistanceCalculationMode) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 316: | Line 319: | ||
| ** {{wiki:PublicMethod.gif|}} GetAccurateLength(String,DistanceUnit,DistanceCalculationMode) ** | ** {{wiki:PublicMethod.gif|}} GetAccurateLength(String,DistanceUnit,DistanceCalculationMode) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 340: | Line 343: | ||
| ** {{wiki:PublicMethod.gif|}} GetLength(GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} GetLength(GeographyUnit,DistanceUnit) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 360: | Line 363: | ||
| ** {{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 376: | Line 379: | ||
| ** {{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 392: | Line 395: | ||
| ** {{wiki:PublicMethod.gif|}} ConvexHull() ** | ** {{wiki:PublicMethod.gif|}} ConvexHull() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 404: | Line 407: | ||
| ** {{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 432: | Line 435: | ||
| ** {{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 452: | Line 455: | ||
| ** {{wiki:PublicMethod.gif|}} Union(LineBaseShape) ** | ** {{wiki:PublicMethod.gif|}} Union(LineBaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 468: | Line 471: | ||
| ** {{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 484: | Line 487: | ||
| ** {{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 500: | Line 503: | ||
| ** {{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 516: | Line 519: | ||
| ** {{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 532: | Line 535: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 544: | Line 547: | ||
| ** {{wiki:PublicMethod.gif|}} GetGeoJson() ** | ** {{wiki:PublicMethod.gif|}} GetGeoJson() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 556: | Line 559: | ||
| ** {{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 572: | Line 575: | ||
| ** {{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 588: | Line 591: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 600: | Line 603: | ||
| ** {{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 616: | Line 619: | ||
| ** {{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 632: | Line 635: | ||
| ** {{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 652: | Line 655: | ||
| ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 664: | Line 667: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 676: | Line 679: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 688: | Line 691: | ||
| ** {{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 716: | Line 719: | ||
| ** {{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 736: | Line 739: | ||
| ** {{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 764: | Line 767: | ||
| ** {{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 784: | Line 787: | ||
| ** {{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 804: | Line 807: | ||
| ** {{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 824: | Line 827: | ||
| ** {{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 844: | Line 847: | ||
| ** {{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 864: | Line 867: | ||
| ** {{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 884: | Line 887: | ||
| ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 896: | Line 899: | ||
| ** {{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 920: | Line 923: | ||
| ** {{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 948: | Line 951: | ||
| ** {{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 980: | Line 983: | ||
| ** {{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 1004: | Line 1007: | ||
| ** {{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 1028: | Line 1031: | ||
| ** {{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 1056: | Line 1059: | ||
| ** {{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 1084: | Line 1087: | ||
| ** {{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 1100: | Line 1103: | ||
| ** {{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 1116: | Line 1119: | ||
| ** {{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 1132: | Line 1135: | ||
| ** {{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 1148: | Line 1151: | ||
| ** {{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 1164: | Line 1167: | ||
| ** {{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 1180: | Line 1183: | ||
| ** {{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 1196: | Line 1199: | ||
| ** {{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 1212: | Line 1215: | ||
| ** {{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 1228: | Line 1231: | ||
| ** {{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 1244: | Line 1247: | ||
| ** {{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 1260: | Line 1263: | ||
| ** {{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 1276: | Line 1279: | ||
| ** {{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 1292: | Line 1295: | ||
| ** {{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 1308: | Line 1311: | ||
| ** {{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 1324: | Line 1327: | ||
| ** {{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 1340: | Line 1343: | ||
| ** {{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 1356: | Line 1359: | ||
| ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1368: | Line 1371: | ||
| ** {{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 1384: | Line 1387: | ||
| ** {{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 1400: | Line 1403: | ||
| ** {{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 1416: | Line 1419: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1428: | Line 1431: | ||
| ** {{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 1444: | Line 1447: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1456: | Line 1459: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1468: | Line 1471: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} RemoveVertex(Vertex,MultilineShape) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} RemoveVertex(Vertex,MultilineShape) ** | ||
| - | This method removes the selected vertex from multiline shape. | + | * //This method removes the selected vertex from multiline shape.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1489: | Line 1492: | ||
| ** {{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. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //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. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
| == Return Value == | == Return Value == | ||
| Line 1501: | Line 1504: | ||
| ** {{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 the copy. | + | * //When you override this method, you need to ensure that there are no references in common between the original and the copy.// |
| == Return Value == | == Return Value == | ||
| Line 1513: | Line 1516: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1525: | Line 1528: | ||
| ** {{wiki:ProtectedMethod.gif|}} ReorderCore(PointShape,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} ReorderCore(PointShape,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This API is used to make the lines within the Multiline ordered. | + | * //This API is used to make the lines within the Multiline ordered.// |
| == Remarks == | == Remarks == | ||
| - | An ordered Multiline means that we can walk though the MultiLine from the first point to the last point without any branches, and that each line's end points should be within the given tolerance. When using this overload, you can specify the unit for the Multiline as well as the unit for the tolerance. | + | * //An ordered Multiline means that we can walk though the MultiLine from the first point to the last point without any branches, and that each line's end points should be within the given tolerance. When using this overload, you can specify the unit for the Multiline as well as the unit for the tolerance.// |
| == Return Value == | == Return Value == | ||
| Line 1553: | Line 1556: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetLengthCore(GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetLengthCore(GeographyUnit,DistanceUnit) ** | ||
| - | This method returns the length of the LineShape. | + | * //This method returns the length of the LineShape.// |
| == Remarks == | == Remarks == | ||
| - | This method is useful when you want to know the total length of a line-based shape. If the shape is a MultilineShape, then the length is the sum of all of its lines. There is also an overload which allows you to specify the returning length in the unit of your choice. | + | * //This method is useful when you want to know the total length of a line-based shape. If the shape is a MultilineShape, then the length is the sum of all of its lines. There is also an overload which allows you to specify the returning length in the unit of your choice.// |
| == Return Value == | == Return Value == | ||
| Line 1573: | Line 1576: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetPointOnALineCore(StartingPoint,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetPointOnALineCore(StartingPoint,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method returns a PointShape on the line, based on a distance on the line from the first or last vertex (as defined by the startingPoint parameter). | + | * //This method returns a PointShape on the line, based on a distance on the line from the first or last vertex (as defined by the startingPoint parameter).// |
| == Remarks == | == Remarks == | ||
| - | Passing in a distance of 0 will return either the first or last point on the line, depending on the value of the startingPoint parameter. | + | * //Passing in a distance of 0 will return either the first or last point on the line, depending on the value of the startingPoint parameter.// |
| == Return Value == | == Return Value == | ||
| Line 1601: | Line 1604: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetLineOnALineCore(StartingPoint,Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} GetLineOnALineCore(StartingPoint,Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | + | * //This method returns a BaseLineShape, based on a starting position and other factors.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 1633: | Line 1636: | ||
| ** {{wiki:ProtectedMethod.gif|}} ScaleUpCore(Double) ** | ** {{wiki:ProtectedMethod.gif|}} ScaleUpCore(Double) ** | ||
| - | This method increases the size of the LineShape by the percentage given in the percentage parameter. | + | * //This method increases the size of the LineShape 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 1649: | Line 1652: | ||
| ** {{wiki:ProtectedMethod.gif|}} ScaleDownCore(Double) ** | ** {{wiki:ProtectedMethod.gif|}} ScaleDownCore(Double) ** | ||
| - | This method decreases the size of the LineShape by the percentage given in the percentage parameter. | + | * //This method decreases the size of the LineShape by the percentage given in the percentage parameter.// |
| == Remarks == | == Remarks == | ||
| - | This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster, as you are applying the operation multiple times. There is also a ScaleUp method that will enlarge the shape. | + | * //This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster, as you are applying the operation multiple times. There is also a ScaleUp method that will enlarge the shape.// |
| == Return Value == | == Return Value == | ||
| Line 1665: | Line 1668: | ||
| ** {{wiki:ProtectedMethod.gif|}} RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}} RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit) ** | ||
| - | This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes. | + | * //This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.// |
| == Remarks == | == Remarks == | ||
| - | Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit.A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this.Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. | + | * //Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit.A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this.Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates.// |
| == Return Value == | == Return Value == | ||
| Line 1693: | Line 1696: | ||
| ** {{wiki:ProtectedMethod.gif|}} TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method returns a BaseLineShape, based on a starting position and other factors. | + | * //This method returns a BaseLineShape, based on a starting position and other factors.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 1721: | Line 1724: | ||
| ** {{wiki:ProtectedMethod.gif|}} TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method moves the base shape from one location to another based on a distance and a direction in degrees. | + | * //This method moves the base shape from one location to another based on a distance and a direction in degrees.// |
| == 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 1749: | Line 1752: | ||
| ** {{wiki:ProtectedMethod.gif|}} RotateCore(PointShape,Single) ** | ** {{wiki:ProtectedMethod.gif|}} RotateCore(PointShape,Single) ** | ||
| - | This method rotates the shape a number of degrees based on a pivot point. | + | * //This method rotates the shape a number of degrees based on a pivot point.// |
| == Remarks == | == Remarks == | ||
| - | This method rotates the shape by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape, you can achieve in-place rotation. By moving the pivot point outside of the center of the shape, you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. | + | * //This method rotates the shape by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape, you can achieve in-place rotation. By moving the pivot point outside of the center of the shape, you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger.// |
| == Return Value == | == Return Value == | ||
| Line 1769: | Line 1772: | ||
| ** {{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 1789: | Line 1792: | ||
| ** {{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 == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 1813: | Line 1816: | ||
| ** {{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 1829: | Line 1832: | ||
| ** {{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 1841: | Line 1844: | ||
| ** {{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 1857: | Line 1860: | ||
| ** {{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 1873: | Line 1876: | ||
| ** {{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 1889: | Line 1892: | ||
| ** {{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 1903: | Line 1906: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} RkE=(Double) ** | + | ** {{wiki:ProtectedMethod.gif|}} Scale(Double) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1921: | Line 1924: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetAccurateLengthCore(String,DistanceUnit,DistanceCalculationMode) ** | ** {{wiki:ProtectedMethod.gif|}} GetAccurateLengthCore(String,DistanceUnit,DistanceCalculationMode) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1945: | Line 1948: | ||
| ** {{wiki:ProtectedMethod.gif|}} ConvexHullCore() ** | ** {{wiki:ProtectedMethod.gif|}} ConvexHullCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1957: | Line 1960: | ||
| ** {{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 1977: | Line 1980: | ||
| ** {{wiki:ProtectedMethod.gif|}} UnionCore(IEnumerable<LineBaseShape>) ** | ** {{wiki:ProtectedMethod.gif|}} UnionCore(IEnumerable<LineBaseShape>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1993: | Line 1996: | ||
| ** {{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 2009: | Line 2012: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetGeoJsonCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetGeoJsonCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2021: | Line 2024: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetWellKnownBinaryCore(RingOrder,WkbByteOrder) ** | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownBinaryCore(RingOrder,WkbByteOrder) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2041: | Line 2044: | ||
| ** {{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 2061: | Line 2064: | ||
| ** {{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 2093: | Line 2096: | ||
| ** {{wiki:ProtectedMethod.gif|}} IsDisjointedCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} IsDisjointedCore(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2109: | Line 2112: | ||
| ** {{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 2125: | Line 2128: | ||
| ** {{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 2141: | Line 2144: | ||
| ** {{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 2157: | Line 2160: | ||
| ** {{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 2173: | Line 2176: | ||
| ** {{wiki:ProtectedMethod.gif|}} ContainsCore(BaseShape) ** | ** {{wiki:ProtectedMethod.gif|}} ContainsCore(BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2189: | Line 2192: | ||
| ** {{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 2205: | Line 2208: | ||
| ** {{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 2221: | Line 2224: | ||
| ** {{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 2237: | Line 2240: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2249: | Line 2252: | ||
| ** {{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.multilineshape.1442555248.txt.gz ยท Last modified: 2015/09/18 05:47 by admin