PointShape¶
Inheritance Hierarchy¶
ObjectBaseShapePointBaseShapePointShape
Members Summary¶
Public Constructors Summary¶
| Name |
|---|
PointShape() |
PointShape(Double,Double) |
PointShape(Double,Double,Double) |
PointShape(Vertex) |
PointShape(String) |
PointShape(Byte[]) |
Protected Constructors Summary¶
| Name |
|---|
| N/A |
Public Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
Id | String | N/A |
Tag | Object | N/A |
X | Double | This property represents the X (horizontal) axis. |
Y | Double | This property represents the Y (vertical) axis. |
Z | Double | This property represents the Z (depth) axis. |
Protected Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Public Methods Summary¶
Protected Methods Summary¶
Public Events Summary¶
| Name | Event Arguments | Description |
|---|---|---|
| N/A | N/A | N/A |
Members Detail¶
Public Constructors¶
| Name |
|---|
PointShape() |
PointShape(Double,Double) |
PointShape(Double,Double,Double) |
PointShape(Vertex) |
PointShape(String) |
PointShape(Byte[]) |
Protected Constructors¶
Public Properties¶
Id¶
Summary
N/A
Remarks
N/A
Return Value
String
Tag¶
Summary
N/A
Remarks
N/A
Return Value
Object
X¶
Summary
This property represents the X (horizontal) axis.
Remarks
None
Return Value
Double
Y¶
Summary
This property represents the Y (vertical) axis.
Remarks
None
Return Value
Double
Z¶
Summary
This property represents the Z (depth) axis.
Remarks
None
Return Value
Double
Protected Properties¶
Public Methods¶
Buffer(Double,GeographyUnit,DistanceUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
MultipolygonShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| distance | Double | N/A |
| shapeUnit | GeographyUnit | N/A |
| distanceUnit | DistanceUnit | N/A |
Buffer(Double,Int32,GeographyUnit,DistanceUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
MultipolygonShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| distance | Double | N/A |
| quadrantSegments | Int32 | N/A |
| shapeUnit | GeographyUnit | N/A |
| distanceUnit | DistanceUnit | N/A |
Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
MultipolygonShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| distance | Double | N/A |
| quadrantSegments | Int32 | N/A |
| bufferCapType | BufferCapType | N/A |
| shapeUnit | GeographyUnit | N/A |
| distanceUnit | DistanceUnit | N/A |
CloneDeep()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
BaseShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Contains(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
Contains(Feature)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
Crosses(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
Crosses(Feature)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
Equal2D(PointShape)¶
Summary
Compare the current PointShape with the target PointShape.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | True if both X and Y coordinates of the current shape are equal to those of the target shape. |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | PointShape | The targetPointShape to be compared with. |
Equal2D(Feature)¶
Summary
Compare the current PointShape with the target Point Feature.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | True if both X and Y coordinates of the current shape are equal to those of the PointShape contained in the target PointFeature. |
Parameters
| Name | Type | Description |
|---|---|---|
| targetPointFeature | Feature | The targetPointFeature to be compared with. |
Equals(Object)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | N/A |
GetBoundingBox()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
RectangleShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetCenterPoint()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
PointShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetClosestPointTo(BaseShape,GeographyUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
PointShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
| shapeUnit | GeographyUnit | N/A |
GetClosestPointTo(Feature,GeographyUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
PointShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
| shapeUnit | GeographyUnit | N/A |
GetCrossing(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
MultipointShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Double | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
| shapeUnit | GeographyUnit | N/A |
| distanceUnit | DistanceUnit | N/A |
GetDistanceTo(Feature,GeographyUnit,DistanceUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Double | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
| shapeUnit | GeographyUnit | N/A |
| distanceUnit | DistanceUnit | N/A |
GetFeature()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Feature | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetFeature(IDictionary<String,String>)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Feature | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| columnValues | IDictionary<String,String> | N/A |
GetGeoJson()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetHashCode()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Int32 | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetShortestLineTo(BaseShape,GeographyUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
MultilineShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
| shapeUnit | GeographyUnit | N/A |
GetShortestLineTo(Feature,GeographyUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
MultilineShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
| shapeUnit | GeographyUnit | N/A |
GetType()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Type | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetWellKnownBinary()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Byte[] | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetWellKnownBinary(WkbByteOrder)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Byte[] | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| byteOrder | WkbByteOrder | N/A |
GetWellKnownBinary(RingOrder)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Byte[] | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| outerRingOrder | RingOrder | N/A |
GetWellKnownBinary(RingOrder,WkbByteOrder)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Byte[] | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| outerRingOrder | RingOrder | N/A |
| byteOrder | WkbByteOrder | N/A |
GetWellKnownText()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetWellKnownText(RingOrder)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| outerRingOrder | RingOrder | N/A |
GetWellKnownType()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
WellKnownType | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GreatCircle(PointShape)¶
Summary
This method returns a MultilineShape that represents the shortest line between two points on the globe.
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.
Return Value
| Type | Description |
|---|---|
MultilineShape | This method returns a MultilineShape that represents the shortest line between two points on the globe. |
Parameters
| Name | Type | Description |
|---|---|---|
| pointShape | PointShape | This parameter is the target point to be measured to. |
GreatCircle(Feature)¶
Summary
This method returns a MultilineShape which represents the shortest line between the current point and the specified feature on the globe.
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.
Return Value
| Type | Description |
|---|---|
MultilineShape | This method returns a MultilineShape which represents the shortest line between the current point and the specified feature on the globe. |
Parameters
| Name | Type | Description |
|---|---|---|
| pointFeature | Feature | This parameter is the target feature to be measured to. |
Intersects(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
Intersects(Feature)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
IsDisjointed(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
IsDisjointed(Feature)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
IsTopologicallyEqual(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
IsTopologicallyEqual(Feature)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
IsWithin(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
IsWithin(Feature)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
LoadFromWellKnownData(String)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| wellKnownText | String | N/A |
LoadFromWellKnownData(Byte[])¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| wellKnownBinary | Byte[] | N/A |
Overlaps(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
Overlaps(Feature)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
Register(PointShape,PointShape,DistanceUnit,GeographyUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
BaseShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| fromPoint | PointShape | N/A |
| toPoint | PointShape | N/A |
| fromUnit | DistanceUnit | N/A |
| toUnit | GeographyUnit | N/A |
Register(Feature,Feature,DistanceUnit,GeographyUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
BaseShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| fromPoint | Feature | N/A |
| toPoint | Feature | N/A |
| fromUnit | DistanceUnit | N/A |
| toUnit | GeographyUnit | N/A |
Rotate(PointShape,Single)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| pivotPoint | PointShape | N/A |
| degreeAngle | Single | N/A |
ScaleTo(Double)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| scale | Double | N/A |
ToString()¶
Summary
Override the ToString() API by returning the X, Y , Z
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | The returned string shows the X, Y , Z values. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Touches(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
Touches(Feature)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature | N/A |
TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| distance | Double | N/A |
| angleInDegrees | Double | N/A |
| shapeUnit | GeographyUnit | N/A |
| distanceUnit | DistanceUnit | N/A |
TranslateByDegree(Double,Double)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| distance | Double | N/A |
| angleInDegrees | Double | N/A |
TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| xOffsetDistance | Double | N/A |
| yOffsetDistance | Double | N/A |
| shapeUnit | GeographyUnit | N/A |
| distanceUnit | DistanceUnit | N/A |
TranslateByOffset(Double,Double)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| xOffsetDistance | Double | N/A |
| yOffsetDistance | Double | N/A |
Validate(ShapeValidationMode)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
ShapeValidationResult | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| validationMode | ShapeValidationMode | N/A |
Protected Methods¶
BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
MultipolygonShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| distance | Double | N/A |
| quadrantSegments | Int32 | N/A |
| bufferCapType | BufferCapType | N/A |
| shapeUnit | GeographyUnit | N/A |
| distanceUnit | DistanceUnit | N/A |
CloneDeepCore()¶
Summary
This method returns a complete copy of the shape without any references in common.
Remarks
When you override this method, you need to ensure that there are no references in common between the original and the copy.
Return Value
| Type | Description |
|---|---|
BaseShape | This method returns a complete copy of the shape without any references in common. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
ContainsCore(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
CrossesCore(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
Finalize()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetBoundingBoxCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
RectangleShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetCenterPointCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
PointShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetClosestPointToCore(BaseShape,GeographyUnit)¶
Summary
This method returns the point of the current shape that is closest to the target shape.
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.
Return Value
| Type | Description |
|---|---|
PointShape | A PointShape representing the closest point of the current shape to the targetShape. |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | The shape you are trying to find the closest point to. |
| shapeUnit | GeographyUnit | This is the GeographicUnit of the shape you are performing the operation on. |
GetCrossingCore(BaseShape)¶
Summary
This method returns the crossing points between the current shape and the passed-in target shape.
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.
Return Value
| Type | Description |
|---|---|
MultipointShape | This method returns the crossing points between the current shape and the passed-in target shape. |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | The target shape you wish to get crossing with. |
GetDistanceFromLineSegment(Double,Double,Double,Double)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Double | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| fromPointX | Double | N/A |
| fromPointY | Double | N/A |
| toPointX | Double | N/A |
| toPointY | Double | N/A |
GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)¶
Summary
This method computes the distance between the current shape and the targetShape.
Remarks
None
Return Value
| Type | Description |
|---|---|
Double | This method returns the distance between the current shape and the targetShape. |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | The shape you are trying to find the distance to. |
| shapeUnit | GeographyUnit | This is the GeographyUnit of the shape you are performing the operation on. |
| distanceUnit | DistanceUnit | This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. |
GetGeoJsonCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetNearestPointShapeFromLineSegment(Double,Double,Double,Double)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
PointShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| fromX | Double | N/A |
| fromY | Double | N/A |
| toX | Double | N/A |
| toY | Double | N/A |
GetShortestLineToCore(BaseShape,GeographyUnit)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
MultilineShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
| shapeUnit | GeographyUnit | N/A |
GetWellKnownBinaryCore(RingOrder,WkbByteOrder)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Byte[] | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| outerRingOrder | RingOrder | N/A |
| byteOrder | WkbByteOrder | N/A |
GetWellKnownTextCore(RingOrder)¶
Summary
This method returns the well-known text representation of this shape.
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)))
Return Value
| Type | Description |
|---|---|
String | This method returns a string that represents the shape in well-known text. |
Parameters
| Name | Type | Description |
|---|---|---|
| outerRingOrder | RingOrder | N/A |
GetWellKnownTypeCore()¶
Summary
This method returns the well-known type for the shape.
Remarks
None
Return Value
| Type | Description |
|---|---|
WellKnownType | This method returns the well-known type for the shape. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
IntersectsCore(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
IsDisjointedCore(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
IsTopologicallyEqualCore(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
IsWithinCore(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
LoadFromWellKnownDataCore(String)¶
Summary
This method hydrates the current shape with its data from well-known text.
Remarks
None
Return Value
| Type | Description |
|---|---|
Void | None |
Parameters
| Name | Type | Description |
|---|---|---|
| wellKnownText | String | This parameter is the well-known text you will use to hydrate your object. |
LoadFromWellKnownDataCore(Byte[])¶
Summary
This method hydrates the current shape with its data from well-known binary.
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.
Return Value
| Type | Description |
|---|---|
Void | None |
Parameters
| Name | Type | Description |
|---|---|---|
| wellKnownBinary | Byte[] | This parameter is the well-known binary used to populate the shape. |
MemberwiseClone()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Object | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
OverlapsCore(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit)¶
Summary
This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.
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.
Return Value
| Type | Description |
|---|---|
BaseShape | This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes. |
Parameters
| Name | Type | Description |
|---|---|---|
| fromPoint | PointShape | This parameter is the anchor PointShape in the coordinate of origin. |
| toPoint | PointShape | This parameter is the anchor PointShape in the coordinate of destination. |
| fromUnit | DistanceUnit | This parameter is the DistanceUnit of the coordinate of origin. |
| toUnit | GeographyUnit | This parameter is the GeographyUnit of the coordinate of destination. |
RotateCore(PointShape,Single)¶
Summary
This method rotates the shape a number of degrees based on a pivot point.
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.
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| pivotPoint | PointShape | The pivotPoint represents the center of rotation. |
| degreeAngle | Single | The number of degrees of rotation required from 0 to 360. |
ScaleToCore(Double)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| scale | Double | N/A |
TouchesCore(BaseShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape | N/A |
TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit)¶
Summary
This method moves the base shape from one location to another, based on a distance and a direction in degrees.
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.
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| distance | Double | The distance is the number of units to move the shape in the angle specified. The distance unit will be the same as the GeographyUnit for the shape. The distance must be greater than or equal to 0. |
| angleInDegrees | Double | A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up. |
| shapeUnit | GeographyUnit | This is the GeographicUnit of the shape you are performing the operation on. |
| distanceUnit | DistanceUnit | This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. |
TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit)¶
Summary
This method moves the base shape from one location to another based on an X and Y offset distance.
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.
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| xOffsetDistance | Double | This is the number of horizontal units of movement in the DistanceUnit specified as the distanceUnit. |
| yOffsetDistance | Double | This is the number of horizontal units of movement in the DistanceUnit specified as the distanceUnit. |
| shapeUnit | GeographyUnit | This is the GeographicUnit of the shape you are performing the operation on. |
| distanceUnit | DistanceUnit | This is the DistanceUnit you would like to use as the measure for the move. For example, if you select miles as your distanceUnit, then the xOffsetDistance and yOffsetDistance will be calculated in miles. |
ValidateCore(ShapeValidationMode)¶
Summary
This method returns a ShapeValidationResult based on a series of tests.
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.
Return Value
| Type | Description |
|---|---|
ShapeValidationResult | This method returns a ShapeValidationResult based on a series of tests. |
Parameters
| Name | Type | Description |
|---|---|---|
| validationMode | ShapeValidationMode | This parameter determines whether the test is simple or advanced. In some cases, the advanced tests can take some time. The simple test is designed to always be fast. |