User Tools

Site Tools

Trace: • thinkgeo.mapsuite.portablecore.ellipseshape

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

thinkgeo.mapsuite.portablecore.ellipseshape

Table of Contents

ThinkGeo.MapSuite.Core.EllipseShape

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This class represents an ellipse that is defined with a center point, a height and a width.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.BaseShape
      • ThinkGeo.MapSuite.Core.AreaBaseShape
        • ThinkGeo.MapSuite.Core.EllipseShape

Members Summary

Public Constructors

EllipseShape()

  • This constructor creates the EllipseShape.
Remarks
  • None
Parameters

EllipseShape(PointShape,Double)

  • This constructor creates the EllipseShape.
Remarks
  • Using this overload will create a circle.
Parameters
  • center
    • Type:PointShape
    • Description:This parameter is the center PointShape for the EllipseShape.
  • radius
    • Type:Double
    • Description:This parameter allows you to set the radius of the EllipseShape.

EllipseShape(Feature,Double)

  • This constructor creates the EllipseShape.
Remarks
  • Using this overload will create a circle.
Parameters
  • centerPointFeature
    • Type:Feature
    • Description:This parameter is the center PointFeature for the EllipseShape.
  • radius
    • Type:Double
    • Description:This parameter allows you to set the radius of the EllipseShape.

EllipseShape(PointShape,Double,Double)

  • This constructor creates the EllipseShape.
Remarks
  • None
Parameters
  • center
    • Type:PointShape
    • Description:This parameter is the center PointShape for the EllipseShape.
  • horizontalRadius
    • Type:Double
    • Description:This parameter allows you to set the horizontal radius of the EllipseShape in the unit of the shape.
  • verticalRadius
    • Type:Double
    • Description:This parameter allows you to set the vertical radius of the EllipseShape in the unit of the shape.

EllipseShape(Feature,Double,Double)

  • This constructor creates the EllipseShape.
Remarks
  • None
Parameters
  • centerPointFeature
    • Type:Feature
    • Description:This parameter is the center PointFeature for the EllipseShape.
  • horizontalRadius
    • Type:Double
    • Description:This parameter allows you to set the horizontal radius of the EllipseShape in the unit of the shape.
  • verticalRadius
    • Type:Double
    • Description:This parameter allows you to set the vertical radius of the EllipseShape in the unit of the shape.

EllipseShape(String)

  • This constructor creates the EllipseShape.
Remarks
  • None
Parameters
  • wellKnownText
    • Type:String
    • Description:This parameter is the well-known text used to create the shape.

EllipseShape(Byte[])

  • This constructor creates the EllipseShape.
Remarks
  • None
Parameters
  • wellKnownBinary
    • Type:Byte[]
    • Description:This parameter is the well-known binary used to create the shape.

EllipseShape(PointShape,Double,GeographyUnit,DistanceUnit)

  • This constructor creates the EllipseShape.
Remarks
  • This overload will create a circle.
Parameters
  • center
    • Type:PointShape
    • Description:This parameter is the center PointShape for the EllipseShape.
  • radius
    • Type:Double
    • Description:This parameter allows you to set the radius of the EllipseShape in the unit specified by the unitOfRadius parameter.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographyUnit of the shape you are performing the operation on.
  • unitOfRadius
    • Type:DistanceUnit
    • Description:This is the DistanceUnit you would like to use for the radius value. For example, if you select miles as your unitOfRadius, then it will use miles.

EllipseShape(Feature,Double,GeographyUnit,DistanceUnit)

  • This constructor creates the EllipseShape.
Remarks
  • This overload will create a circle.
Parameters
  • centerPointFeature
    • Type:Feature
    • Description:This parameter is the center Point Feature for the EllipseShape.
  • radius
    • Type:Double
    • Description:This parameter allows you to set the radius of the EllipseShape in the unit specified by the unitOfRadius parameter.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographyUnit of the shape you are performing the operation on.
  • unitOfRadius
    • Type:DistanceUnit
    • Description:This is the DistanceUnit you would like to use for the radius value. For example, if you select miles as your unitOfRadius, then it will use miles.

EllipseShape(PointShape,Double,Double,GeographyUnit,DistanceUnit)

  • This constructor creates the EllipseShape.
Remarks
  • None
Parameters
  • center
    • Type:PointShape
    • Description:This parameter is the center PointShape for the EllipseShape.
  • horizontalRadius
    • Type:Double
    • Description:This parameter allows you to set the horizontal radius of the EllipseShape in the unit specified by the unitOfRadius parameter.
  • verticalRadius
    • Type:Double
    • Description:This parameter allows you to set the vertical radius of the EllipseShape in the unit specified by the unitOfRadius parameter.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographyUnit of the shape you are performing the operation on.
  • unitOfRadius
    • Type:DistanceUnit
    • Description:This is the DistanceUnit you would like to use for the radius value. For example, if you select miles as your unitOfRadius, then it will use miles.

EllipseShape(Feature,Double,Double,GeographyUnit,DistanceUnit)

  • This constructor creates the EllipseShape.
Remarks
  • None
Parameters
  • centerPointFeature
    • Type:Feature
    • Description:This parameter is the center Point Feature for the EllipseShape.
  • horizontalRadius
    • Type:Double
    • Description:This parameter allows you to set the horizontal radius of the EllipseShape in the unit specified by the unitOfRadius parameter.
  • verticalRadius
    • Type:Double
    • Description:This parameter allows you to set the vertical radius of the EllipseShape in the unit specified by the unitOfRadius parameter.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographyUnit of the shape you are performing the operation on.
  • unitOfRadius
    • Type:DistanceUnit
    • Description:This is the DistanceUnit you would like to use for the radius value. For example, if you select miles as your unitOfRadius, then it will use miles.

Protected Constructors

Public Methods

SetWidthByUnit(Double,GeographyUnit,DistanceUnit)

  • This method allows you to set the width of the EllipseShape in the unit specified in the unitOfWidth parameter.
Remarks
  • None
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • newWidth
    • Type:Double
    • Description:This parameter is the newWidth of the ellipse shape.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This parameter is the unit of the current shape.
  • unitOfWidth
    • Type:DistanceUnit
    • Description:This is the unit you would like to use as the setting value. For example, if you select miles as your unitOfWidth, then the distance will be set in miles.

GetWidthByUnit(GeographyUnit,DistanceUnit)

  • This method returns the width of the EllipseShape in the unit specified in the returningUnit parameter.
Remarks
  • None
Return Value
  • Type:Double
  • Description:This method returns the width of the EllipseShape in the unit specified in the returningUnit parameter.
Parameters
  • shapeUnit
    • Type:GeographyUnit
    • Description:This parameter is the unit of the current shape.
  • returningUnit
    • Type:DistanceUnit
    • Description:This is the unit you would like to use for the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles.

SetHeightByUnit(Double,GeographyUnit,DistanceUnit)

  • This method allows you to set the height of the EllipseShape in the unit specified in the unitOfWidth.
Remarks
  • None
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • newHeight
    • Type:Double
    • Description:This parameter is the newHeight of the ellipse shape.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This parameter is the unit of the current shape.
  • unitOfHeight
    • Type:DistanceUnit
    • Description:This is the unit you would like to use for the setting value. For example, if you select miles as your unitOfHeight, then the distance will be set in miles.

GetHeightByUnit(GeographyUnit,DistanceUnit)

  • This method returns the height of the EllipseShape in the unit specified in the returningUnit parameter.
Remarks
  • None
Return Value
  • Type:Double
  • Description:This method returns the height of the EllipseShape in the unit specified in the returningUnit parameter.
Parameters
  • shapeUnit
    • Type:GeographyUnit
    • Description:This parameter is the unit of the current shape.
  • returningUnit
    • Type:DistanceUnit
    • Description:This is the unit you would like to use for the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles.

ToPolygon()

  • This method returns the current shape as a PolygonShape.
Remarks
  • This method is mainly used to convert this non GIS standard shape to a GIS standard shape.
Return Value
  • Type:PolygonShape
  • Description:This method returns the current shape as a PolygonShape.
Parameters

ToPolygon(Int32)

  • This method returns the current shape as a PolygonShape.
Remarks
  • This method is mainly used to convert a GIS non-standard shape to a GIS standard shape.
Return Value
  • Type:PolygonShape
  • Description:This method returns the current shape as a PolygonShape.
Parameters
  • vertexCountInQuarter
    • Type:Int32
    • Description:This parameter specifies how many points will make up each quarter of the ellipse.

GetTangents(EllipseShape)

  • This method returns the tangent points of the current ellipse in relation to the target ellipse you specify.
Remarks
  • This operation is useful for finding the corridor between two ellipses. It would be handy in a buffering type of scenario.
Return Value
  • Type:Collection<PointShape>
  • Description:This method returns the tangent points of the current ellipse in relation to the target ellipse you specify.
Parameters
  • targetEllipse
    • Type:EllipseShape
    • Description:This parameter represents the other ellipse you wish to find the tangent points to.

GetPerimeter(GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double
  • Description:N/A
Parameters

GetArea(GeographyUnit,AreaUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double
  • Description:N/A
Parameters
  • returningUnit

ScaleUp(Double)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • percentage
    • Type:Double
    • Description:N/A

ScaleDown(Double)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • percentage
    • Type:Double
    • Description:N/A

GetConvexHull()

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetIntersection(AreaBaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetIntersection(Feature)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • targetFeature

Union(AreaBaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

Union(Feature)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • targetFeature

GetDifference(AreaBaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetDifference(Feature)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • targetFeature

GetSymmetricalDifference(AreaBaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetSymmetricalDifference(Feature)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • targetFeature

Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • tolerance
    • Type:Double
    • Description:N/A

Simplify(Double,SimplificationType)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • tolerance
    • Type:Double
    • Description:N/A

Touches(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

Touches(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • targetFeature

Crosses(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

Crosses(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • targetFeature

IsWithin(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

IsWithin(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • targetFeature

Contains(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

Contains(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • targetFeature

Overlaps(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

Overlaps(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • targetFeature

IsTopologicallyEqual(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

IsTopologicallyEqual(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • targetFeature

GetFeature()

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetFeature(IDictionary<String,String>)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • columnValues
    • Type:IDictionary<String,String>
    • Description:N/A

GetCrossing(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ScaleTo(Double)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • scale
    • Type:Double
    • Description:N/A

LoadFromWellKnownData(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • wellKnownText
    • Type:String
    • Description:N/A

GetWellKnownText()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

GetGeoJson()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

GetWellKnownText(RingOrder)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • outerRingOrder

LoadFromWellKnownData(Byte[])

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • wellKnownBinary
    • Type:Byte[]
    • Description:N/A

GetWellKnownBinary()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Byte[]
  • Description:N/A
Parameters

GetWellKnownBinary(WkbByteOrder)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Byte[]
  • Description:N/A
Parameters

GetWellKnownBinary(RingOrder)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Byte[]
  • Description:N/A
Parameters
  • outerRingOrder

GetWellKnownBinary(RingOrder,WkbByteOrder)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Byte[]
  • Description:N/A
Parameters
  • outerRingOrder

GetBoundingBox()

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetWellKnownType()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
Parameters

TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • xOffsetDistance
    • Type:Double
    • Description:N/A
  • yOffsetDistance
    • Type:Double
    • Description:N/A

TranslateByOffset(Double,Double)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • xOffsetDistance
    • Type:Double
    • Description:N/A
  • yOffsetDistance
    • Type:Double
    • Description:N/A

TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • angleInDegrees
    • Type:Double
    • Description:N/A

TranslateByDegree(Double,Double)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • angleInDegrees
    • Type:Double
    • Description:N/A

Rotate(PointShape,Single)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • degreeAngle
    • Type:Single
    • Description:N/A

GetShortestLineTo(BaseShape,GeographyUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetShortestLineTo(Feature,GeographyUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • targetFeature

GetClosestPointTo(BaseShape,GeographyUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetClosestPointTo(Feature,GeographyUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • targetFeature

GetCenterPoint()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Buffer(Double,GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • distance
    • Type:Double
    • Description:N/A

Buffer(Double,Int32,GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • quadrantSegments
    • Type:Int32
    • Description:N/A

Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • quadrantSegments
    • Type:Int32
    • Description:N/A

GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double
  • Description:N/A
Parameters

GetDistanceTo(Feature,GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double
  • Description:N/A
Parameters
  • targetFeature

Register(PointShape,PointShape,DistanceUnit,GeographyUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters

Register(Feature,Feature,DistanceUnit,GeographyUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • fromPoint
  • toPoint

Validate(ShapeValidationMode)

  • N/A
Remarks
  • N/A
Return Value
Parameters

IsDisjointed(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

IsDisjointed(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • targetFeature

Intersects(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

Intersects(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • targetFeature

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

GeShortestPointFromOutsidePoint(PointShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeepCore()

  • 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 copy.
Return Value
  • Type:BaseShape
  • Description:This method returns a complete copy of the shape without any references in common.
Parameters

GetWellKnownTypeCore()

  • This method returns the well-known type for the shape.
Remarks
  • None
Return Value
  • Type:WellKnownType
  • Description:This method returns the well-known type for the shape.
Parameters

GetPerimeterCore(GeographyUnit,DistanceUnit)

  • This method returns the perimeter of the shape, which is defined as the sum of the lengths of all its sides.
Remarks
  • You would use this method to find the distance around the area shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Double
  • Description:The return unit is based on the LengthUnit you specify in the returningUnit parameter, regardless of the shape's GeographyUnit.
Parameters
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographyUnit of the shape you are performing the operation on.
  • returningUnit
    • Type:DistanceUnit
    • Description:This is the DistanceUnit you would like to use for the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles.

GetAreaCore(GeographyUnit,AreaUnit)

  • This method returns the area of the shape, which is defined as the size of the region enclosed by the figure.
Remarks
  • You would use this method to find the area inside of a shape.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Double
  • Description:The return unit is based on the AreaUnit you specify in the returningUnit parameter, regardless of the shape's GeographyUnit.
Parameters
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographyUnit of the shape you are performing the operation on.
  • returningUnit
    • Type:AreaUnit
    • Description:This is the AreaUnit you would like to use for the return value. For example, if you select square miles as your returningUnit, then the distance will be returned in square miles.

ScaleUpCore(Double)

  • This method increases the size of the area shape by the percentage given in the percentage parameter.
Remarks
  • This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster, as you are applying the operation multiple times. There is also a ScaleDown method that will shrink the shape.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • percentage
    • Type:Double
    • Description:This is the percentage by which to increase the shape's size.

ScaleDownCore(Double)

  • This method decreases the size of the area shape by the percentage given in the percentage parameter.
Remarks
  • Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Void
  • Description:This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster, as you are applying the operation multiple times. There is also a ScaleUp method that will enlarge the shape.
Parameters
  • percentage
    • Type:Double
    • Description:This is the percentage by which to decrease the shape's size.

GetBoundingBoxCore()

  • This method calculates the smallest RectangleShape that encompasses the entire geometry.
Remarks
  • The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. Depending on the number of PointShapes and complexity of the geometry, this operation can take a significant amount of time (the larger the objects, the more time the operation will take). If the shape is a PointShape, then the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:RectangleShape
  • Description:The RectangleShape returned is the smallest RectangleShape that can encompass the entire geometry.
Parameters

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.
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.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:BaseShape
  • Description:This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.
Parameters
  • fromPoint
    • Type:PointShape
    • Description:This parameter is the anchor PointShape in the coordinate of origin.
  • toPoint
    • Type:PointShape
    • Description:This parameter is the anchor PointShape in the coordinate of destination.
  • fromUnit
    • Type:DistanceUnit
    • Description:This parameter is the DistanceUnit of the coordinate of origin.
  • toUnit
    • Type:GeographyUnit
    • Description:This parameter is the GeographyUnit of the coordinate of destination.

TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit)

  • 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. It is important to note that with this overload 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 one and a Y offset of one, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles to on the X axis and 3 miles on the Y axis.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • xOffsetDistance
    • Type:Double
    • Description:This is the number of horizontal units of movement in the DistanceUnit specified by the distanceUnit parameter.
  • yOffsetDistance
    • Type:Double
    • Description:This is the number of horizontal units of movement in the DistanceUnit specified by the distanceUnit parameter.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographicUnit of the shape you are performing the operation on.
  • distanceUnit
    • Type:DistanceUnit
    • Description:This is the DistanceUnit you would like to use as the measurement for the move. For example, if you select miles as your distanceUnit, then the xOffsetDistance and yOffsetDistance will be calculated in miles.

TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit)

  • This method moves the base shape from one location to another based on a direction in degrees and distance.
Remarks
  • This method moves the base shape from one location to another based on angleInDegrees and distance parameter. It is important to note that with this overload the distance units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit in miles, you're going to move this shape a number of miles based on the distance and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:The distance is the number of units to move the shape using the angle specified. The distance unit will be the DistanceUnit specified in the distanceUnit parameter. The distance must be greater than or equal to 0.
  • angleInDegrees
    • Type:Double
    • Description:A number between 0 and 360 degrees that represents the direction you wish to move the shape with zero being up.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographicUnit of the shape you are performing the operation on.
  • distanceUnit
    • Type:DistanceUnit
    • Description:This is the DistanceUnit you would like to use as the measurement for the move. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles.

RotateCore(PointShape,Single)

  • 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 acheive 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 away from the center will make the circular area larger.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • pivotPoint
    • Type:PointShape
    • Description:The pivotPoint represents the center of rotation.
  • degreeAngle
    • Type:Single
    • Description:The number of degrees of rotation required from 0 to 360.

GetClosestPointToCore(BaseShape,GeographyUnit)

  • This method returns the point of the current shape that is closest to the target shape.
Remarks
  • This method returns 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, the method would return a point that is on the line, but not one of the two points that make up the line.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:PointShape
  • Description:A PointShape representing the point of the current shape that is closest to the targetShape.
Parameters
  • targetShape
    • Type:BaseShape
    • Description:The shape you are trying to find the closest point to.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographicUnit of the shape you are performing the operation on.

GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)

  • This method computes the distance between the current shape and the targetShape.
Remarks
  • In this method, we compute the closest distance between two shapes. The returned unit will be in the unit of distance specified in the distanceUnit parameter.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Double
  • Description:The return type is the distance between this shape and the targetShape in the GeographyUnit of the shape.
Parameters
  • targetShape
    • Type:BaseShape
    • Description:The shape you are trying to find the distance to.
  • shapeUnit
    • Type:GeographyUnit
    • Description:This is the GeographicUnit of the shape you are performing the operation on.
  • distanceUnit
    • Type:DistanceUnit
    • Description:This is the DistanceUnit you would like to use as the return value. For example, if you select miles as your distanceUnit, then the distance will be returned in miles.

GetWellKnownTextCore(Int32)

  • 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 geometries 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 also have methods that work with well-known binary. Below are some samples of what well-known text might look like for various kinds of geometries.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON1)MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING2)MULTIPOLYGON3),4))Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:String
  • Description:This method returns a stringthat represents the shape in well-known text.
Parameters
  • vertexCountInQuarter
    • Type:Int32
    • Description:This parameter specifies how many points will make up each quarter of the ellipse.

GetWellKnownTextCore(RingOrder)

  • 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 geometries 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 also have methods that work with well-known binary. Below are some samples of what well-known text might look like for various kinds of geometries.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON5)MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING6)MULTIPOLYGON7),8))Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:String
  • Description:This method returns a string that represents the shape in well-known text.
Parameters
  • outerRingOrder

GetWellKnownTextCore(RingOrder,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • outerRingOrder
  • vertexCountInQuarter
    • Type:Int32
    • Description:N/A

GetWellKnownBinaryCore(WkbByteOrder,Int32)

  • This method returns a byte array that represents the shape in well-known binary.
Remarks
  • This method returns a byte array that represents the shape in well known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We also have methods that work with well-known text.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Byte[]
  • Description:This method returns a byte array that represents the shape in well-known binary.
Parameters
  • byteOrder
    • Type:WkbByteOrder
    • Description:This parameter specifies whether the byte order is big- or little-endian.
  • vertexCountInQuarter
    • Type:Int32
    • Description:This parameter specifies how many points will make up each quarter of the ellipse.

GetWellKnownBinaryCore(RingOrder,WkbByteOrder)

  • This method returns a byte array that represents the shape in well-known binary.
Remarks
  • This method returns a byte array that represents the shape in well known binary. Well-known binary allows you to describe geometries as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We also have methods that work with well-known text.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Byte[]
  • Description:This method returns a byte array that represents the shape in well-known binary.
Parameters
  • outerRingOrder
  • byteOrder
    • Type:WkbByteOrder
    • Description:This parameter specifies whether the byte order is big- or little-endian.

GetWellKnownBinaryCore(RingOrder,WkbByteOrder,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Byte[]
  • Description:N/A
Parameters
  • outerRingOrder
  • vertexCountInQuarter
    • Type:Int32
    • Description:N/A

LoadFromWellKnownDataCore(String)

  • This method hydrates the current shape with its data from well-known text.
Remarks
  • None
Return Value
  • Type:Void
  • Description:None
Parameters
  • wellKnownText
    • Type:String
    • Description:This parameter is the well-known text you will use to hydrate your object.

LoadFromWellKnownDataCore(Byte[])

  • 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:Void
  • Description:None
Parameters
  • wellKnownBinary
    • Type:Byte[]
    • Description:This parameter is the well-known binary used to populate the shape.

ValidateCore(ShapeValidationMode)

  • 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.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:ShapeValidationResult
  • Description:This method returns a ShapeValidationResult based on a series of tests.
Parameters
  • validationMode
    • Type:ShapeValidationMode
    • Description: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.

ContainsCore(BaseShape)

  • This method returns whether the targetShape lies within the interior of the current shape.
Remarks
  • Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Boolean
  • Description:This method returns whether the targetShape lies within the interior of the current shape.
Parameters
  • targetShape
    • Type:BaseShape
    • Description:The shape you wish to compare the current one to.

IntersectsCore(BaseShape)

  • This method returns whether the current shape and the targetShape have at least one point in common.
Remarks
  • Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
  • Type:Boolean
  • Description:This method returns whether the current shape and the targetShape have at least one point in common.
Parameters
  • targetShape
    • Type:BaseShape
    • Description:The shape you wish to compare the current one to.

GetCrossingCore(BaseShape)

  • This method returns the crossing points of 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:MultipointShape
  • Description:This method returns the crossing points of the current shape and the passed-in target shape.
Parameters
  • targetShape
    • Type:BaseShape
    • Description:The target shape you wish to get crossing with.

GetConvexHullCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetIntersectionCore(AreaBaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

UnionCore(AreaBaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetDifferenceCore(AreaBaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetSymmetricalDifferenceCore(AreaBaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

SimplifyCore(Double,SimplificationType)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • tolerance
    • Type:Double
    • Description:N/A

TouchesCore(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

CrossesCore(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

IsWithinCore(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

OverlapsCore(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

IsTopologicallyEqualCore(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

ScaleToCore(Double)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • scale
    • Type:Double
    • Description:N/A

GetGeoJsonCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

GetShortestLineToCore(BaseShape,GeographyUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetCenterPointCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • quadrantSegments
    • Type:Int32
    • Description:N/A

IsDisjointedCore(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

Width

  • This property returns the width of the EllipseShape in the unit of the shape.
Remarks
  • None
Return Value
  • Type:Double

Height

  • This property returns the height of the EllipseShape in the unit of the shape.
Remarks
  • None
Return Value
  • Type:Double

Center

  • This property allows you to get or set the center PointShape of the EllipseShape.
Remarks
  • None
Return Value

CanRotate

  • This property specifies whether the shape can be rotated.
Remarks
  • If this property returns false and you attempt call the rotate method, it will throw a NotImplementedException.
Return Value
  • Type:Boolean

Id

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

Tag

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object

Protected Properties

Public Events

1) , 5) 2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3
2) , 6) 4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3
3) , 7) (2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3
4) , 8) 4 4,7 3,7 5,4 4
thinkgeo.mapsuite.portablecore.ellipseshape.txt · Last modified: 2017/03/16 21:59 (external edit)

Page Tools