User Tools

Site Tools

Trace: • thinkgeo.mapsuite.core.areabaseshape

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

thinkgeo.mapsuite.core.areabaseshape

Table of Contents

ThinkGeo.MapSuite.Core.AreaBaseShape

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 abstract class is the root of all area-based shapes, such as RectangleShape and PolygonShape.

Inheritance Hierarchy

Members Summary

Public Constructors

Protected Constructors

AreaBaseShape()

This is the default constructor for AreaBaseShape.

Remarks

This constructor simply calls the base constructor.

Parameters

Public Methods

GetAccuratePerimeter(Int32,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value
  • Type:Double
  • Description:N/A
Parameters
  • shapeSrid
    • Type:Int32
    • Description:N/A

GetAccuratePerimeter(String,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value
  • Type:Double
  • Description:N/A
Parameters
  • shapeProj4ProjectionParameters
    • Type:String
    • Description:N/A

GetPerimeter(GeographyUnit,DistanceUnit)

This method returns the perimeter of the shape, 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.

Return Value
  • Type:Double
  • Description:The return unit is based on a 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 as the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles.

GetAccurateArea(Int32,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

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

GetAccurateArea(String,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

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

GetArea(GeographyUnit,AreaUnit)

This method returns the area of the shape, defined as the size of the region enclosed by the figure.

Remarks

You would use this method to find the area inside the shape.

Return Value
  • Type:Double
  • Description:The return unit is based on a 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 as the return value. For example, if you select square miles as your returningUnit, then the distance will be returned in square miles.

ScaleUp(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, since you apply the operation multiple times. There is a ScaleDown method that will shrink the shape. as well.

Return Value
  • Type:Void
  • Description:N/A
Parameters
  • percentage
    • Type:Double
    • Description:This is the percentage by which to increase the shape's size.

ScaleDown(Double)

This method decreases the size of the area shape by the percentage given in the percentage parameter.

Remarks

This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

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, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.
Parameters
  • percentage
    • Type:Double
    • Description:This is the percentage by which to decrease the shape's size.

GetConvexHull()

This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.

Remarks

This method is useful when you want to create a perimeter around the shape. For example, if you had a MultiPolygon that represented buildings on a campus, you could easily get the convex hull of the buildings and determine the perimeter of all of the buildings together. This also works with MultiPoint shapes, where each point may represent a certain type of person you are doing statistics on. With convex hull, you can get an idea of the regions those points are located in.

Return Value
  • Type:RingShape
  • Description:This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.
Parameters

GetIntersection(AreaBaseShape)

This method returns the intersection of the current shape and the target shape, defined as the set of all points which lie in both the current shape and the target shape.

Remarks

None

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that contains the set of all points which lie in both the current shape and the target shape.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:The shape you are trying to find the intersection with.

GetIntersection(Feature)

This method returns the intersection of the current shape and the target feature, defined as the set of all points which lie in both the current shape and the target feature.

Remarks

None

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that contains the set of all points which lie in both the current shape and the target feature.
Parameters
  • targetFeature
    • Type:Feature
    • Description:The feature you are trying to find the intersection with.

Union(AreaBaseShape)

This method returns the union of the current shape and the target shape, defined as the set of all points in the current shape or the target shape.

Remarks

This is useful for adding area shapes together to form a larger area shape.

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that contains the set of all points which lie in the current shape or the target shape.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:The shape you are trying to find the union with.

Union(Feature)

This method returns the union of the current shape and the target feature, defined as the set of all points in the current shape or the target feature.

Remarks

This is useful for adding area shapes together to form a larger area shape.

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that contains the set of all points which lie in the current shape or the target feature.
Parameters
  • targetFeature
    • Type:Feature
    • Description:The feature you are trying to find the union with.

GetDifference(AreaBaseShape)

This method returns the difference between two shapes, defined as the set of all points which lie in the current shape but not in the targetShape.

Remarks

None

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that is the set of all points which lie in the current shape but not in the targetShape.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:The shape you are trying to find the difference with.

GetDifference(Feature)

This method returns the difference between current shape and the specified feature, defined as the set of all points which lie in the current shape but not in the targetShape.

Remarks

None

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that is the set of all points which lie in the current shape but not in the target feature.
Parameters
  • targetFeature
    • Type:Feature
    • Description:The feture you are trying to find the difference with.

GetSymmetricalDifference(AreaBaseShape)

This method returns the symmetrical difference between two shapes, defined as the set of all points which lie in the current shape or the targetShape but not both.

Remarks

None

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that is the set of all points which lie in the current shape or the targetShape but not both.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:The shape you are trying to find the symmetrical difference with.

GetSymmetricalDifference(Feature)

This method returns the symmetrical difference between current shape and the specified feature, defined as the set of all points which lie in the current shape or the targetFeature but not both.

Remarks

None

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that is the set of all points which lie in the current shape or the targetFeature but not both.
Parameters
  • targetFeature
    • Type:Feature
    • Description:The feature you are trying to find the symmetrical difference with.

Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType)

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value
  • Type:MultipolygonShape
  • Description:This method returns a simplification multipolgyon by the specified parameters.
Parameters
  • shapeUnit
    • Type:GeographyUnit
    • Description:This parameter specifies the geographic unit of this current shape you are performing the operation
  • tolerance
    • Type:Double
    • Description:This parameter specifes the tolerance to be used when simplification.
  • toleranceUnit
    • Type:DistanceUnit
    • Description:This parameter specifes the distance unit of the tolerance.
  • simplificationType
    • Type:SimplificationType
    • Description:This prameter specifies the type of simplification operation.

Simplify(Double,SimplificationType)

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value
  • Type:MultipolygonShape
  • Description:This method returns a simplification multipolgyon by the specified parameters.
Parameters
  • tolerance
    • Type:Double
    • Description:This parameter specifes the tolerance to be used when simplification.
  • simplificationType
    • Type:SimplificationType
    • Description:This prameter specifies the type of simplification operation.

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

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

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

ScaleUp(AreaBaseShape,Double)

This method returns a new area shape that has been scaled up 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, since you apply the operation multiple times. There is a ScaleDown method that will shrink the shape as well.

Return Value
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:This parameter is the shape to use as the base for the scaling.
  • percentage
    • Type:Double
    • Description:This is the percentage by which to increase the shape's size.

ScaleUp(Feature,Double)

This method returns a new area shape that has been scaled up 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, since you apply the operation multiple times. There is a ScaleDown method that will shrink the shape as well.

Return Value
Parameters
  • targetFeature
    • Type:Feature
    • Description:This parameter is the feature to use as the base for the scaling.
  • percentage
    • Type:Double
    • Description:This is the percentage by which to increase the shape's size.

ScaleDown(AreaBaseShape,Double)

This method returns a new area shape that has been scaled down by the percentage given in the percentage parameter.

Remarks

This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

Return Value
  • Type:AreaBaseShape
  • 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, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:This parameter is the shape to use as the base for the scaling.
  • percentage
    • Type:Double
    • Description:This is the percentage by which to decrease the shape's size.

ScaleDown(Feature,Double)

This method returns a new area feature that has been scaled down by the percentage given in the percentage parameter.

Remarks

This method is useful when you would like to decrease the size of the feature. Note that a larger percentage will scale the shape down faster, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

Return Value
  • Type:Feature
  • Description:This method is useful when you would like to decrease the size of the feature. Note that a larger percentage will scale the shape down faster, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.
Parameters
  • targetFeature
    • Type:Feature
    • Description:This parameter is the shape to use as the base for the scaling.
  • percentage
    • Type:Double
    • Description:This is the percentage by which to decrease the shape's size.

Union(IEnumerable<Feature>)

This method returns the union of the current shape and the target features, defined as the set of all points in the current shape or the target features.

Remarks

This is useful for adding area shapes together to form a larger area shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that contains the set of all points which lie in the current shape or the target features. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Parameters
  • targetFeatures
    • Type:IEnumerable<Feature>
    • Description:The target features you are trying to find the union with.

Union(IEnumerable<AreaBaseShape>)

This method returns the union of the specified area shapes.

Remarks

This is useful for adding area shapes together to form a larger area shape.

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that contains the set of all points that lie within the shapes you specified.
Parameters
  • areaShapes
    • Type:IEnumerable<AreaBaseShape>
    • Description:The shapes you are trying to find the union with.

Split(AreaBaseShape,AreaBaseShape)

This method returns a collection of MultiPolygonShapes split by the specified parameters.

Remarks

None.

Return Value
  • Type:Collection<MultipolygonShape>
  • Description:This method returns a collection of MultiPolygonShape split by the specified parameters.
Parameters
  • areaToSplit
    • Type:AreaBaseShape
    • Description:This parameter represents the shape to be split.
  • areaToSplitBy
    • Type:AreaBaseShape
    • Description:This parameter represents the shape that will be used to perform the split.

Split(Feature,Feature)

This method returns a collection of Features split by the specified parameters.

Remarks

None.

Return Value
  • Type:Collection<Feature>
  • Description:This method returns a collection of Features split by the specified parameters.
Parameters
  • areaToSplit
    • Type:Feature
    • Description:This parameter represents the feature to be split.
  • areaToSplitBy
    • Type:Feature
    • Description:This parameter represents the feature that will be used to perform the split.

Simplify(AreaBaseShape,GeographyUnit,Double,DistanceUnit,SimplificationType)

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value
  • Type:MultipolygonShape
  • Description:This method returns a simplification multipolgyon by the specified parameters.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:This parameter specifies the area shape to be simplfied.
  • targetShapeUnit
    • Type:GeographyUnit
    • Description:This parameter specifies the geographic unit of the shape you are performing the operation
  • tolerance
    • Type:Double
    • Description:This parameter specifes the tolerance to be used when simplification.
  • toleranceUnit
    • Type:DistanceUnit
    • Description:This parameter specifes the distance unit of the tolerance.
  • simplificationType
    • Type:SimplificationType
    • Description:This prameter specifies the type of simplification operation.

Simplify(AreaBaseShape,Double,SimplificationType)

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value
  • Type:MultipolygonShape
  • Description:This method returns a simplification multipolgyon by the specified parameters.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:This parameter specifies the area shape to be simplfied.
  • tolerance
    • Type:Double
    • Description:This parameter specifes the tolerance to be used when simplification.
  • simplificationType
    • Type:SimplificationType
    • Description:This prameter specifies the type of simplification operation.

Protected Methods

GetAccuratePerimeterCore(String,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value
  • Type:Double
  • Description:N/A
Parameters
  • shapeProj4ProjectionParameters
    • Type:String
    • Description:N/A

GetPerimeterCore(GeographyUnit,DistanceUnit)

This method returns the perimeter of the shape, 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 a 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 as the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles.

GetAccurateAreaCore(String,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

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

GetAreaCore(GeographyUnit,AreaUnit)

This method returns the area of the shape, defined as the size of the region enclosed by the figure.

Remarks

You would use this method to find the area inside the 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 a 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 as 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, since you apply the operation multiple times. There is a ScaleDown method that will shrink the shape as well. 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

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, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well. 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 decrease the shape's size.

GetConvexHullCore()

This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.

Remarks

This method is useful when you want to create a perimeter around the shape. For example, if you had a MultiPolygon that represented buildings on a campus, you could easily get the convex hull of the buildings and determine the perimeter of all of the buildings together. This also works with MultiPoint shapes, where each point may represent a certain type of person you are doing statistics on. With convex hull, you can get an idea of the regions those points are located in. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value
  • Type:RingShape
  • Description:This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.
Parameters

GetIntersectionCore(AreaBaseShape)

This method returns the intersection of the current shape and the target shape, defined as the set of all points which lie in both the current shape and the target shape.

Remarks

Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that contains the set of all points which lie in both the current shape and the target shape.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:The shape you are trying to find the intersection with.

UnionCore(AreaBaseShape)

This method returns the union of the current shape and the target shapes, defined as the set of all points in the current shape or the target shape.

Remarks

This is useful for adding area shapes together to form a larger area shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that contains the set of all points which lie in the current shape or the target shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:The shape you are trying to find the union with.

GetDifferenceCore(AreaBaseShape)

This method returns the difference between two shapes, defined as the set of all points which lie in the current shape but not in the targetShape.

Remarks

Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that is the set of all points which lie in the current shape but not in the targetShape.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:The shape you are trying to find the difference with.

GetSymmetricalDifferenceCore(AreaBaseShape)

This method returns the symmetrical difference between two shapes, defined as the set of all points which lie in the current shape or the targetShape but not both.

Remarks

Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value
  • Type:MultipolygonShape
  • Description:The return type is a MultiPolygonShape that is the set of all points which lie in the current shape or the targetShape but not both.
Parameters
  • targetShape
    • Type:AreaBaseShape
    • Description:The shape you are trying to find the symmetrical difference with.

SimplifyCore(Double,SimplificationType)

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value
  • Type:MultipolygonShape
  • Description:This method returns a simplification multipolgyon by the specified parameters.
Parameters
  • tolerance
    • Type:Double
    • Description:This parameter specifes the tolerance to be used when simplification.
  • simplificationType
    • Type:SimplificationType
    • Description:This prameter specifies the type of simplification operation.

LoadFromWellKnownDataCore(String)

N/A

Remarks

N/A

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

GetGeoJsonCore()

N/A

Remarks

N/A

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

GetWellKnownTextCore(RingOrder)

N/A

Remarks

N/A

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

LoadFromWellKnownDataCore(Byte[])

N/A

Remarks

N/A

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

GetWellKnownBinaryCore(RingOrder,WkbByteOrder)

N/A

Remarks

N/A

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

GetBoundingBoxCore()

N/A

Remarks

N/A

Return Value
Parameters

GetWellKnownTypeCore()

N/A

Remarks

N/A

Return Value
Parameters

CloneDeepCore()

N/A

Remarks

N/A

Return Value
Parameters

TranslateByOffsetCore(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

TranslateByDegreeCore(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

RotateCore(PointShape,Single)

N/A

Remarks

N/A

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

GetShortestLineToCore(BaseShape,GeographyUnit)

N/A

Remarks

N/A

Return Value
Parameters

GetClosestPointToCore(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

GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

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

RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit)

N/A

Remarks

N/A

Return Value
Parameters

ValidateCore(ShapeValidationMode)

N/A

Remarks

N/A

Return Value
Parameters

IsDisjointedCore(BaseShape)

N/A

Remarks

N/A

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

IntersectsCore(BaseShape)

N/A

Remarks

N/A

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

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

ContainsCore(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

GetCrossingCore(BaseShape)

N/A

Remarks

N/A

Return Value
Parameters

ScaleToCore(Double)

N/A

Remarks

N/A

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

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

Id

N/A

Remarks

N/A

Return Value
  • Type:String

Tag

N/A

Remarks

N/A

Return Value
  • Type:Object

CanRotate

N/A

Remarks

N/A

Return Value
  • Type:Boolean

Protected Properties

Public Events

thinkgeo.mapsuite.core.areabaseshape.txt · Last modified: 2017/03/16 21:59 (external edit)

Page Tools