thinkgeo.mapsuite.core.lineshape
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.lineshape [2015/09/21 07:47] admin |
thinkgeo.mapsuite.core.lineshape [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.LineShape ====== | ====== ThinkGeo.MapSuite.Core.LineShape ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents a LineShape, which is defined as a single line with two or more points. | This class represents a LineShape, which is defined as a single line with two or more points. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 10: | Line 13: | ||
| ** {{wiki:PublicMethod.gif|}} LineShape() ** | ** {{wiki:PublicMethod.gif|}} LineShape() ** | ||
| - | This constructor creates the LineShape. | + | * //This constructor creates the LineShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} LineShape(IEnumerable<Vertex>) ** | ** {{wiki:PublicMethod.gif|}} LineShape(IEnumerable<Vertex>) ** | ||
| - | This constructor creates the LineShape. | + | * //This constructor creates the LineShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //points// | * //points// | ||
| Line 28: | Line 31: | ||
| ** {{wiki:PublicMethod.gif|}} LineShape(String) ** | ** {{wiki:PublicMethod.gif|}} LineShape(String) ** | ||
| - | This constructor creates the LineShape. | + | * //This constructor creates the LineShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //wellKnownText// | * //wellKnownText// | ||
| Line 39: | Line 42: | ||
| ** {{wiki:PublicMethod.gif|}} LineShape(Byte[]) ** | ** {{wiki:PublicMethod.gif|}} LineShape(Byte[]) ** | ||
| - | This constructor creates the LineShape. | + | * //This constructor creates the LineShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //wellKnownBinary// | * //wellKnownBinary// | ||
| Line 52: | Line 55: | ||
| ** {{wiki:PublicMethod.gif|}} ReversePoints() ** | ** {{wiki:PublicMethod.gif|}} ReversePoints() ** | ||
| - | This method reverses the order of the points in the line. | + | * //This method reverses the order of the points in the line.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 64: | Line 67: | ||
| ** {{wiki:PublicMethod.gif|}} IsClosed() ** | ** {{wiki:PublicMethod.gif|}} IsClosed() ** | ||
| - | This method determines whether the line is closed, meaning that the last point and first point are the same. | + | * //This method determines whether the line is closed, meaning that the last point and first point are the same.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 76: | Line 79: | ||
| ** {{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 the first or last vertex defined in the startingPoint parameter. | + | * //This method returns a PointShape on the line, based on a percentage of the length of the line from the first or last vertex defined in 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 96: | Line 99: | ||
| ** {{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 defined in the startingPoint parameter. | + | * //This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter.// |
| == Remarks == | == Remarks == | ||
| - | Passing in a 0 distance will return either the first or last point on the line, depending upon the value of the startingPoint parameter. | + | * //Passing in a 0 distance will return either the first or last point on the line, depending upon the value of the startingPoint parameter.// |
| == Return Value == | == Return Value == | ||
| Line 124: | Line 127: | ||
| ** {{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 148: | Line 151: | ||
| ** {{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 168: | Line 171: | ||
| ** {{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 200: | Line 203: | ||
| ** {{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 220: | Line 223: | ||
| ** {{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 240: | Line 243: | ||
| ** {{wiki:PublicMethod.gif|}} RemoveVertex(Vertex) ** | ** {{wiki:PublicMethod.gif|}} RemoveVertex(Vertex) ** | ||
| - | This method removes the selected vertex from line shape. | + | * //This method removes the selected vertex from line shape.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 256: | Line 259: | ||
| ** {{wiki:PublicMethod.gif|}} ToPolygonShape() ** | ** {{wiki:PublicMethod.gif|}} ToPolygonShape() ** | ||
| - | This method generates a PolygonShape based the vertexes of the line. | + | * //This method generates a PolygonShape based the vertexes of the line.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 268: | Line 271: | ||
| ** {{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 292: | Line 295: | ||
| ** {{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 316: | Line 319: | ||
| ** {{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 336: | Line 339: | ||
| ** {{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 352: | Line 355: | ||
| ** {{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 368: | Line 371: | ||
| ** {{wiki:PublicMethod.gif|}} ConvexHull() ** | ** {{wiki:PublicMethod.gif|}} ConvexHull() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 380: | Line 383: | ||
| ** {{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 408: | Line 411: | ||
| ** {{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 428: | Line 431: | ||
| ** {{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 444: | Line 447: | ||
| ** {{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 460: | Line 463: | ||
| ** {{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 476: | Line 479: | ||
| ** {{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 492: | Line 495: | ||
| ** {{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 508: | Line 511: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 520: | Line 523: | ||
| ** {{wiki:PublicMethod.gif|}} GetGeoJson() ** | ** {{wiki:PublicMethod.gif|}} GetGeoJson() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 532: | Line 535: | ||
| ** {{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 548: | Line 551: | ||
| ** {{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 564: | Line 567: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 576: | Line 579: | ||
| ** {{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 592: | Line 595: | ||
| ** {{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 608: | Line 611: | ||
| ** {{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 628: | Line 631: | ||
| ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 640: | Line 643: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 652: | Line 655: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 664: | Line 667: | ||
| ** {{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 692: | Line 695: | ||
| ** {{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 712: | Line 715: | ||
| ** {{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 740: | Line 743: | ||
| ** {{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 760: | Line 763: | ||
| ** {{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 780: | Line 783: | ||
| ** {{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 800: | Line 803: | ||
| ** {{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 820: | Line 823: | ||
| ** {{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 840: | Line 843: | ||
| ** {{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 860: | Line 863: | ||
| ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 872: | Line 875: | ||
| ** {{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 896: | Line 899: | ||
| ** {{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 924: | Line 927: | ||
| ** {{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 956: | Line 959: | ||
| ** {{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 980: | Line 983: | ||
| ** {{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 1004: | Line 1007: | ||
| ** {{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 1032: | Line 1035: | ||
| ** {{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 1060: | Line 1063: | ||
| ** {{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 1076: | Line 1079: | ||
| ** {{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 1092: | Line 1095: | ||
| ** {{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 1108: | Line 1111: | ||
| ** {{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 1124: | Line 1127: | ||
| ** {{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 1140: | Line 1143: | ||
| ** {{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 1156: | Line 1159: | ||
| ** {{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 1172: | Line 1175: | ||
| ** {{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 1188: | Line 1191: | ||
| ** {{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 1204: | Line 1207: | ||
| ** {{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 1220: | Line 1223: | ||
| ** {{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 1236: | Line 1239: | ||
| ** {{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 1252: | Line 1255: | ||
| ** {{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 1268: | Line 1271: | ||
| ** {{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 1284: | Line 1287: | ||
| ** {{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 1300: | Line 1303: | ||
| ** {{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 1316: | Line 1319: | ||
| ** {{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 1332: | Line 1335: | ||
| ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1344: | Line 1347: | ||
| ** {{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 1360: | Line 1363: | ||
| ** {{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 1376: | Line 1379: | ||
| ** {{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 1392: | Line 1395: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1404: | Line 1407: | ||
| ** {{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 1420: | Line 1423: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1432: | Line 1435: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1444: | Line 1447: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} RemoveVertex(Vertex,LineShape) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} RemoveVertex(Vertex,LineShape) ** | ||
| - | This method removes the selected vertex from line shape. | + | * //This method removes the selected vertex from line shape.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1465: | Line 1468: | ||
| ** {{wiki:ProtectedMethod.gif|}} ReversePointsCore() ** | ** {{wiki:ProtectedMethod.gif|}} ReversePointsCore() ** | ||
| - | This method reverses the order of the points in the line. | + | * //This method reverses the order of the points in the line.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 1477: | Line 1480: | ||
| ** {{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 1489: | Line 1492: | ||
| ** {{wiki:ProtectedMethod.gif|}} IsClosedCore() ** | ** {{wiki:ProtectedMethod.gif|}} IsClosedCore() ** | ||
| - | This method determines whether the line is closed, meaning that the last point and first point are the same. | + | * //This method determines whether the line is closed, meaning that the last point and first point are the same.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 1501: | Line 1504: | ||
| ** {{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 is a useful method 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. | + | * //This is a useful method 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.// |
| == Return Value == | == Return Value == | ||
| Line 1521: | Line 1524: | ||
| ** {{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 defined in the startingPoint parameter. | + | * //This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter.// |
| == Remarks == | == Remarks == | ||
| - | Passing in a 0 distance will return either the first or last point on the line, depending on the value of the startingPoint parameter. | + | * //Passing in a 0 distance will return either the first or last point on the line, depending on the value of the startingPoint parameter.// |
| == Return Value == | == Return Value == | ||
| Line 1549: | Line 1552: | ||
| ** {{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 1581: | Line 1584: | ||
| ** {{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.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above. | + | * //In this method, we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.// |
| == Return Value == | == Return Value == | ||
| Line 1605: | Line 1608: | ||
| ** {{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 1621: | Line 1624: | ||
| ** {{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 1637: | Line 1640: | ||
| ** {{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 1665: | Line 1668: | ||
| ** {{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 returns a shape repositioned 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 one 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 on the X axis and 3 miles on the Y axis. | + | * //This method returns a shape repositioned 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 one 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 on the X axis and 3 miles on the Y axis.// |
| == Return Value == | == Return Value == | ||
| Line 1693: | Line 1696: | ||
| ** {{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 returns a shape repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. | + | * //This method returns a shape repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored.// |
| == Return Value == | == Return Value == | ||
| Line 1721: | Line 1724: | ||
| ** {{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 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 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 1741: | Line 1744: | ||
| ** {{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, than 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, than 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 1753: | Line 1756: | ||
| ** {{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 1773: | Line 1776: | ||
| ** {{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 figures.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 figures.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 1789: | Line 1792: | ||
| ** {{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 1801: | Line 1804: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1813: | Line 1816: | ||
| ** {{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 1829: | Line 1832: | ||
| ** {{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 1845: | Line 1848: | ||
| ** {{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 1861: | Line 1864: | ||
| ** {{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 1875: | Line 1878: | ||
| <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 1893: | Line 1896: | ||
| ** {{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 1917: | Line 1920: | ||
| ** {{wiki:ProtectedMethod.gif|}} ConvexHullCore() ** | ** {{wiki:ProtectedMethod.gif|}} ConvexHullCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1929: | Line 1932: | ||
| ** {{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 1949: | Line 1952: | ||
| ** {{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 1965: | Line 1968: | ||
| ** {{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 1981: | Line 1984: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetGeoJsonCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetGeoJsonCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1993: | Line 1996: | ||
| ** {{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 2013: | Line 2016: | ||
| ** {{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 2033: | Line 2036: | ||
| ** {{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 2065: | Line 2068: | ||
| ** {{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 2081: | Line 2084: | ||
| ** {{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 2097: | Line 2100: | ||
| ** {{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 2113: | Line 2116: | ||
| ** {{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 2129: | Line 2132: | ||
| ** {{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 2145: | Line 2148: | ||
| ** {{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 2161: | Line 2164: | ||
| ** {{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 2177: | Line 2180: | ||
| ** {{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 2193: | Line 2196: | ||
| ** {{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 2209: | Line 2212: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 2221: | Line 2224: | ||
| ** {{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.lineshape.1442821668.txt.gz ยท Last modified: 2015/09/21 07:47 by admin