thinkgeo.mapsuite.portablecore.pointshape
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.pointshape [2015/09/21 08:15] admin |
thinkgeo.mapsuite.portablecore.pointshape [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.PointShape ====== | ====== ThinkGeo.MapSuite.Core.PointShape ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents a single point. | This class represents a single point. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 10: | Line 13: | ||
| ** {{wiki:PublicMethod.gif|}} PointShape() ** | ** {{wiki:PublicMethod.gif|}} PointShape() ** | ||
| - | This constructor creates a PointShape. | + | * //This constructor creates a PointShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} PointShape(Double,Double) ** | ** {{wiki:PublicMethod.gif|}} PointShape(Double,Double) ** | ||
| - | This constructor create a PointShape. | + | * //This constructor create a PointShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //x// | * //x// | ||
| Line 32: | Line 35: | ||
| ** {{wiki:PublicMethod.gif|}} PointShape(Double,Double,Double) ** | ** {{wiki:PublicMethod.gif|}} PointShape(Double,Double,Double) ** | ||
| - | This constructor create a PointShape. | + | * //This constructor create a PointShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //x// | * //x// | ||
| Line 51: | Line 54: | ||
| ** {{wiki:PublicMethod.gif|}} PointShape(Vertex) ** | ** {{wiki:PublicMethod.gif|}} PointShape(Vertex) ** | ||
| - | This overload creates a PointShape by specifying the vertex. | + | * //This overload creates a PointShape by specifying the vertex.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Parameters == | == Parameters == | ||
| * //vertex// | * //vertex// | ||
| Line 62: | Line 65: | ||
| ** {{wiki:PublicMethod.gif|}} PointShape(String) ** | ** {{wiki:PublicMethod.gif|}} PointShape(String) ** | ||
| - | This constructor creates the PointShape. | + | * //This constructor creates the PointShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //wellKnownText// | * //wellKnownText// | ||
| Line 73: | Line 76: | ||
| ** {{wiki:PublicMethod.gif|}} PointShape(Byte[]) ** | ** {{wiki:PublicMethod.gif|}} PointShape(Byte[]) ** | ||
| - | This constructor creates the PointShape. | + | * //This constructor creates the PointShape.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //wellKnownBinary// | * //wellKnownBinary// | ||
| Line 86: | Line 89: | ||
| ** {{wiki:PublicMethod.gif|}} Equal2D(PointShape) ** | ** {{wiki:PublicMethod.gif|}} Equal2D(PointShape) ** | ||
| - | Compare the current PointShape with the target PointShape. | + | * //Compare the current PointShape with the target PointShape.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 102: | Line 105: | ||
| ** {{wiki:PublicMethod.gif|}} Equal2D(Feature) ** | ** {{wiki:PublicMethod.gif|}} Equal2D(Feature) ** | ||
| - | Compare the current PointShape with the target Point Feature. | + | * //Compare the current PointShape with the target Point Feature.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 118: | Line 121: | ||
| ** {{wiki:PublicMethod.gif|}} GreatCircle(PointShape) ** | ** {{wiki:PublicMethod.gif|}} GreatCircle(PointShape) ** | ||
| - | This method returns a MultilineShape that represents the shortest line between two points on the globe. | + | * //This method returns a MultilineShape that represents the shortest line between two points on the globe.// |
| == Remarks == | == Remarks == | ||
| - | This method is useful when you want to display on the map the shortest line between two points in decimal degrees. The line will be curved, and possibly disconnected if it is close to travel from the end of the map. | + | * //This method is useful when you want to display on the map the shortest line between two points in decimal degrees. The line will be curved, and possibly disconnected if it is close to travel from the end of the map.// |
| == Return Value == | == Return Value == | ||
| Line 134: | Line 137: | ||
| ** {{wiki:PublicMethod.gif|}} GreatCircle(Feature) ** | ** {{wiki:PublicMethod.gif|}} GreatCircle(Feature) ** | ||
| - | This method returns a MultilineShape which represents the shortest line between the current point and the specified feature on the globe. | + | * //This method returns a MultilineShape which represents the shortest line between the current point and the specified feature on the globe.// |
| == Remarks == | == Remarks == | ||
| - | This method is useful when you want to display on the map the shortest line between two points in decimal degrees. The line will be curved, and possibly disconnected if it is close to travel from the end of the map. | + | * //This method is useful when you want to display on the map the shortest line between two points in decimal degrees. The line will be curved, and possibly disconnected if it is close to travel from the end of the map.// |
| == Return Value == | == Return Value == | ||
| Line 150: | Line 153: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | Override the ToString() API by returning the X, Y , Z | + | * //Override the ToString() API by returning the X, Y , Z// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 159: | Line 162: | ||
| == Parameters == | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Touches(BaseShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Touches(Feature) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Crosses(BaseShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Crosses(Feature) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} IsWithin(BaseShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} IsWithin(Feature) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Contains(BaseShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Contains(Feature) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Overlaps(BaseShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Overlaps(Feature) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(BaseShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(Feature) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeature(IDictionary<String,String>) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //columnValues// | ||
| + | * Type:IDictionary<String,String> | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetCrossing(BaseShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.MultipointShape|MultipointShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ScaleTo(Double) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //scale// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| ** {{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 178: | Line 433: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 190: | Line 445: | ||
| ** {{wiki:PublicMethod.gif|}} GetGeoJson() ** | ** {{wiki:PublicMethod.gif|}} GetGeoJson() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 202: | Line 457: | ||
| ** {{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 218: | Line 473: | ||
| ** {{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 234: | Line 489: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 246: | Line 501: | ||
| ** {{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 262: | Line 517: | ||
| ** {{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 278: | Line 533: | ||
| ** {{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 298: | Line 553: | ||
| ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 310: | Line 565: | ||
| ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 322: | Line 577: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 334: | Line 589: | ||
| ** {{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 362: | Line 617: | ||
| ** {{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 382: | Line 637: | ||
| ** {{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 410: | Line 665: | ||
| ** {{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 430: | Line 685: | ||
| ** {{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 450: | Line 705: | ||
| ** {{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 470: | Line 725: | ||
| ** {{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 490: | Line 745: | ||
| ** {{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 510: | Line 765: | ||
| ** {{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 530: | Line 785: | ||
| ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ** {{wiki:PublicMethod.gif|}} GetCenterPoint() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 542: | Line 797: | ||
| ** {{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 566: | Line 821: | ||
| ** {{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 594: | Line 849: | ||
| ** {{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 626: | Line 881: | ||
| ** {{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 650: | Line 905: | ||
| ** {{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 674: | Line 929: | ||
| ** {{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 702: | Line 957: | ||
| ** {{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 730: | Line 985: | ||
| ** {{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 746: | Line 1001: | ||
| ** {{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 762: | Line 1017: | ||
| ** {{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 778: | Line 1033: | ||
| ** {{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 794: | Line 1049: | ||
| ** {{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 805: | Line 1060: | ||
| * //targetFeature// | * //targetFeature// | ||
| * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Touches(BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Touches(Feature) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetFeature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Crosses(BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Crosses(Feature) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetFeature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} IsWithin(BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} IsWithin(Feature) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetFeature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Contains(BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Contains(Feature) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetFeature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Overlaps(BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Overlaps(Feature) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetFeature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} IsTopologicallyEqual(Feature) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetFeature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetFeature() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetFeature(IDictionary<String,String>) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //columnValues// | ||
| - | * Type:IDictionary<String,String> | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetCrossing(BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.MultipointShape|MultipointShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ScaleTo(Double) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //scale// | ||
| - | * Type:Double | ||
| * Description:N/A | * Description:N/A | ||
| Line 1062: | Line 1065: | ||
| ** {{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 1078: | Line 1081: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1090: | Line 1093: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1103: | Line 1106: | ||
| ** {{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 1115: | Line 1118: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1127: | Line 1130: | ||
| ** {{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 1155: | Line 1158: | ||
| ** {{wiki:ProtectedMethod.gif|}} TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) ** | ** {{wiki:ProtectedMethod.gif|}} TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) ** | ||
| - | This method moves the base shape from one location to another based on an X and Y offset distance. | + | * //This method moves the base shape from one location to another based on an X and Y offset distance.// |
| == Remarks == | == Remarks == | ||
| - | This method moves the base shape from one location to another, based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape 1 unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles to on the X axis and 3 miles on the Y axis. | + | * //This method moves the base shape from one location to another, based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape 1 unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles to on the X axis and 3 miles on the Y axis.// |
| == Return Value == | == Return Value == | ||
| Line 1183: | Line 1186: | ||
| ** {{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 1211: | Line 1214: | ||
| ** {{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 1231: | Line 1234: | ||
| ** {{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 1251: | Line 1254: | ||
| ** {{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 1267: | Line 1270: | ||
| ** {{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 1279: | Line 1282: | ||
| ** {{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 1295: | Line 1298: | ||
| ** {{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 1311: | Line 1314: | ||
| ** {{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 1327: | Line 1330: | ||
| ** {{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 1351: | Line 1354: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetCenterPointCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1363: | Line 1366: | ||
| ** {{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 1379: | Line 1382: | ||
| ** {{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 1393: | Line 1396: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} c0M=(Double,Double,Double,Double) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetDistanceFromLineSegment(Double,Double,Double,Double) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1421: | Line 1424: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} dEM=(Double,Double,Double,Double) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetNearestPointShapeFromLineSegment(Double,Double,Double,Double) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1449: | Line 1452: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetGeoJsonCore() ** | + | ** {{wiki:ProtectedMethod.gif|}} IntersectsCore(BaseShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:String | + | * Type:Boolean |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownBinaryCore(RingOrder,WkbByteOrder) ** | + | ** {{wiki:ProtectedMethod.gif|}} TouchesCore(BaseShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Byte[] | + | * Type:Boolean |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //outerRingOrder// | + | * //targetShape// |
| - | * Type:[[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]] | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | * Description:N/A | + | |
| - | + | ||
| - | * //byteOrder// | + | |
| - | * Type:[[ThinkGeo.MapSuite.Core.WkbByteOrder|WkbByteOrder]] | + | |
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetShortestLineToCore(BaseShape,GeographyUnit) ** | + | ** {{wiki:ProtectedMethod.gif|}} CrossesCore(BaseShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]] | + | * Type:Boolean |
| * Description:N/A | * Description:N/A | ||
| Line 1494: | Line 1497: | ||
| * //targetShape// | * //targetShape// | ||
| * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //shapeUnit// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** | + | ** {{wiki:ProtectedMethod.gif|}} ContainsCore(BaseShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.MultipolygonShape|MultipolygonShape]] | + | * Type:Boolean |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //distance// | + | * //targetShape// |
| - | * Type:Double | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | * Description:N/A | + | |
| - | + | ||
| - | * //quadrantSegments// | + | |
| - | * Type:Int32 | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | * //bufferCapType// | + | |
| - | * Type:[[ThinkGeo.MapSuite.Core.BufferCapType|BufferCapType]] | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | * //shapeUnit// | + | |
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | * //distanceUnit// | + | |
| - | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | + | |
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} IsDisjointedCore(BaseShape) ** | + | ** {{wiki:ProtectedMethod.gif|}} OverlapsCore(BaseShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1549: | Line 1532: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} IntersectsCore(BaseShape) ** | + | ** {{wiki:ProtectedMethod.gif|}} IsTopologicallyEqualCore(BaseShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1565: | Line 1548: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} TouchesCore(BaseShape) ** | + | ** {{wiki:ProtectedMethod.gif|}} ScaleToCore(Double) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:Void |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //targetShape// | + | * //scale// |
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | + | * Type:Double |
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} CrossesCore(BaseShape) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetGeoJsonCore() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:String |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //targetShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} ContainsCore(BaseShape) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetWellKnownBinaryCore(RingOrder,WkbByteOrder) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:Byte[] |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //targetShape// | + | * //outerRingOrder// |
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RingOrder|RingOrder]] |
| + | * Description:N/A | ||
| + | |||
| + | * //byteOrder// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.WkbByteOrder|WkbByteOrder]] | ||
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OverlapsCore(BaseShape) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetShortestLineToCore(BaseShape,GeographyUnit) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]] |
| * Description:N/A | * Description:N/A | ||
| Line 1626: | Line 1609: | ||
| * //targetShape// | * //targetShape// | ||
| * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //shapeUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} IsTopologicallyEqualCore(BaseShape) ** | + | ** {{wiki:ProtectedMethod.gif|}} BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.MultipolygonShape|MultipolygonShape]] |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //targetShape// | + | * //distance// |
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | + | * Type:Double |
| + | * Description:N/A | ||
| + | |||
| + | * //quadrantSegments// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //bufferCapType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BufferCapType|BufferCapType]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //shapeUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //distanceUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} ScaleToCore(Double) ** | + | ** {{wiki:ProtectedMethod.gif|}} IsDisjointedCore(BaseShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:Boolean |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //scale// | + | * //targetShape// |
| - | * Type:Double | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| * Description:N/A | * Description:N/A | ||
| Line 1663: | Line 1666: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1675: | Line 1678: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 1688: | Line 1691: | ||
| ** {{wiki:PublicProperty.gif|}} X ** | ** {{wiki:PublicProperty.gif|}} X ** | ||
| - | This property represents the X (horizontal) axis. | + | * //This property represents the X (horizontal) axis.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 1696: | Line 1699: | ||
| ** {{wiki:PublicProperty.gif|}} Y ** | ** {{wiki:PublicProperty.gif|}} Y ** | ||
| - | This property represents the Y (vertical) axis. | + | * //This property represents the Y (vertical) axis.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 1704: | Line 1707: | ||
| ** {{wiki:PublicProperty.gif|}} Z ** | ** {{wiki:PublicProperty.gif|}} Z ** | ||
| - | This property represents the Z (depth) axis. | + | * //This property represents the Z (depth) axis.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 1712: | Line 1715: | ||
| ** {{wiki:PublicProperty.gif|}} CanRotate ** | ** {{wiki:PublicProperty.gif|}} CanRotate ** | ||
| - | This property specifies whether the shape can be rotated. | + | * //This property specifies whether the shape can be rotated.// |
| == Remarks == | == Remarks == | ||
| - | If this property returns false and you attempt call the rotate method, it will throw a NotImplementedException. | + | * //If this property returns false and you attempt call the rotate method, it will throw a NotImplementedException.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 1720: | Line 1723: | ||
| ** {{wiki:PublicProperty.gif|}} Id ** | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 1728: | Line 1731: | ||
| ** {{wiki:PublicProperty.gif|}} Tag ** | ** {{wiki:PublicProperty.gif|}} Tag ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Object | * Type:Object | ||
thinkgeo.mapsuite.portablecore.pointshape.1442823347.txt.gz · Last modified: 2015/09/21 08:15 by admin