User Tools

Site Tools


thinkgeo.mapsuite.core.areabaseshape

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.Core.AreaBaseShape

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

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This is the default constructor for AreaBaseShape.

Public Methods

Buffer

Buffer

Buffer

CloneDeep

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

Contains

Contains

Crosses

Crosses

Equals

  • Parameters:Object
  • DeclaringType:Object
  • Summary:N/A

GetAccurateArea

GetAccurateArea

GetAccuratePerimeter

GetAccuratePerimeter

GetArea

  • DeclaringType:N/A
  • Summary:This method returns the area of the shape, defined as the size of the region enclosed by the figure.

GetBoundingBox

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetCenterPoint

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetClosestPointTo

GetClosestPointTo

GetConvexHull

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.

GetCrossing

GetDifference

  • Parameters:Feature
  • DeclaringType:N/A
  • Summary: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.

GetDifference

  • Parameters:AreaBaseShape
  • DeclaringType:N/A
  • Summary: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.

GetDistanceTo

GetDistanceTo

GetFeature

  • Parameters:IDictionary<String,String>
  • DeclaringType:BaseShape
  • Summary:N/A

GetFeature

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetGeoJson

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetHashCode

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetIntersection

  • Parameters:Feature
  • DeclaringType:N/A
  • Summary: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.

GetIntersection

  • Parameters:AreaBaseShape
  • DeclaringType:N/A
  • Summary: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.

GetPerimeter

  • DeclaringType:N/A
  • Summary:This method returns the perimeter of the shape, defined as the sum of the lengths of all its sides.

GetShortestLineTo

GetShortestLineTo

GetSymmetricalDifference

  • Parameters:Feature
  • DeclaringType:N/A
  • Summary: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.

GetSymmetricalDifference

  • Parameters:AreaBaseShape
  • DeclaringType:N/A
  • Summary: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.

GetType

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetWellKnownBinary

GetWellKnownBinary

GetWellKnownBinary

GetWellKnownBinary

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetWellKnownText

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetWellKnownText

GetWellKnownType

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

Intersects

Intersects

IsDisjointed

IsDisjointed

IsTopologicallyEqual

IsTopologicallyEqual

IsWithin

IsWithin

LoadFromWellKnownData

  • Parameters:Byte[]
  • DeclaringType:BaseShape
  • Summary:N/A

LoadFromWellKnownData

  • Parameters:String
  • DeclaringType:BaseShape
  • Summary:N/A

Overlaps

Overlaps

Register

Register

Rotate

ScaleDown

  • Parameters:Double
  • DeclaringType:N/A
  • Summary:This method decreases the size of the area shape by the percentage given in the percentage parameter.

ScaleDown

  • Parameters:AreaBaseShape,Double
  • DeclaringType:N/A
  • Summary:This method returns a new area shape that has been scaled down by the percentage given in the percentage parameter.

ScaleDown

  • Parameters:Feature,Double
  • DeclaringType:N/A
  • Summary:This method returns a new area feature that has been scaled down by the percentage given in the percentage parameter.

ScaleTo

  • Parameters:Double
  • DeclaringType:BaseShape
  • Summary:N/A

ScaleUp

  • Parameters:Feature,Double
  • DeclaringType:N/A
  • Summary:This method returns a new area shape that has been scaled up by the percentage given in the percentage parameter.

ScaleUp

  • Parameters:AreaBaseShape,Double
  • DeclaringType:N/A
  • Summary:This method returns a new area shape that has been scaled up by the percentage given in the percentage parameter.

ScaleUp

  • Parameters:Double
  • DeclaringType:N/A
  • Summary:This method increases the size of the area shape by the percentage given in the percentage parameter.

Simplify

  • DeclaringType:N/A
  • Summary: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.

Simplify

  • DeclaringType:N/A
  • Summary: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.

Simplify

  • DeclaringType:N/A
  • Summary: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.

Simplify

  • Parameters:Double,SimplificationType
  • DeclaringType:N/A
  • Summary: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.

Split

  • Parameters:Feature,Feature
  • DeclaringType:N/A
  • Summary:This method returns a collection of Features split by the specified parameters.

Split

  • DeclaringType:N/A
  • Summary:This method returns a collection of MultiPolygonShapes split by the specified parameters.

ToString

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Touches

Touches

TranslateByDegree

  • Parameters:Double,Double
  • DeclaringType:BaseShape
  • Summary:N/A

TranslateByDegree

TranslateByOffset

TranslateByOffset

  • Parameters:Double,Double
  • DeclaringType:BaseShape
  • Summary:N/A

Union

  • Parameters:IEnumerable<Feature>
  • DeclaringType:N/A
  • Summary: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.

Union

  • Parameters:IEnumerable<AreaBaseShape>
  • DeclaringType:N/A
  • Summary:This method returns the union of the specified area shapes.

Union

  • Parameters:AreaBaseShape
  • DeclaringType:N/A
  • Summary: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.

Union

  • Parameters:Feature
  • DeclaringType:N/A
  • Summary: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.

Validate

Protected Methods

BufferCore

CloneDeepCore

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

ContainsCore

CrossesCore

Finalize

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetAccurateAreaCore

GetAccuratePerimeterCore

GetAreaCore

  • DeclaringType:N/A
  • Summary:This method returns the area of the shape, defined as the size of the region enclosed by the figure.

GetBoundingBoxCore

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetCenterPointCore

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetClosestPointToCore

GetConvexHullCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.

GetCrossingCore

GetDifferenceCore

  • Parameters:AreaBaseShape
  • DeclaringType:N/A
  • Summary: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.

GetDistanceToCore

GetGeoJsonCore

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

GetIntersectionCore

  • Parameters:AreaBaseShape
  • DeclaringType:N/A
  • Summary: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.

GetPerimeterCore

  • DeclaringType:N/A
  • Summary:This method returns the perimeter of the shape, defined as the sum of the lengths of all its sides.

GetShortestLineToCore

GetSymmetricalDifferenceCore

  • Parameters:AreaBaseShape
  • DeclaringType:N/A
  • Summary: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.

GetWellKnownBinaryCore

GetWellKnownTextCore

GetWellKnownTypeCore

  • Parameters:N/A
  • DeclaringType:BaseShape
  • Summary:N/A

IntersectsCore

IsDisjointedCore

IsTopologicallyEqualCore

IsWithinCore

LoadFromWellKnownDataCore

  • Parameters:Byte[]
  • DeclaringType:BaseShape
  • Summary:N/A

LoadFromWellKnownDataCore

  • Parameters:String
  • DeclaringType:BaseShape
  • Summary:N/A

MemberwiseClone

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

OverlapsCore

RegisterCore

RotateCore

ScaleDownCore

  • Parameters:Double
  • DeclaringType:N/A
  • Summary:This method decreases the size of the area shape by the percentage given in the percentage parameter.

ScaleToCore

  • Parameters:Double
  • DeclaringType:BaseShape
  • Summary:N/A

ScaleUpCore

  • Parameters:Double
  • DeclaringType:N/A
  • Summary:This method increases the size of the area shape by the percentage given in the percentage parameter.

SimplifyCore

  • Parameters:Double,SimplificationType
  • DeclaringType:N/A
  • Summary: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.

TouchesCore

TranslateByDegreeCore

TranslateByOffsetCore

UnionCore

  • Parameters:AreaBaseShape
  • DeclaringType:N/A
  • Summary: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.

ValidateCore

Public Properties

CanRotate

  • Return:Boolean
  • Summary:N/A

Id

  • Return:String
  • Summary:N/A

Tag

  • Return:Object
  • Summary:N/A

Protected Properties

Public Events

Public Constructors

Protected Constructors

AreaBaseShape()

This is the default constructor for AreaBaseShape.

Remarks

This constructor simply calls the base constructor.

Parameters

Public Methods

Buffer(Double,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

Parameters

distance

  • Type:Double
  • Description:N/A

shapeUnit

distanceUnit

Go Back

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

bufferCapType

shapeUnit

distanceUnit

Go Back

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

shapeUnit

distanceUnit

Go Back

CloneDeep()

N/A

Remarks

N/A

Return Value

Parameters

Contains(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

Contains(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Crosses(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

Crosses(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Equals(Object)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

obj

  • Type:Object
  • Description:N/A

Go Back

GetAccurateArea(Int32,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeSrid

  • Type:Int32
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAccurateArea(String,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeProj4ProjectionParameters

  • Type:String
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAccuratePerimeter(Int32,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeSrid

  • Type:Int32
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAccuratePerimeter(String,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeProj4ProjectionParameters

  • Type:String
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

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

  • Return 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

  • 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.

Go Back

GetBoundingBox()

N/A

Remarks

N/A

Return Value

Parameters

GetCenterPoint()

N/A

Remarks

N/A

Return Value

Parameters

GetClosestPointTo(BaseShape,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

shapeUnit

Go Back

GetClosestPointTo(Feature,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetFeature

shapeUnit

Go Back

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

  • Return 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

GetCrossing(BaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

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

  • Return 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.

Go Back

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

  • Return 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

  • Description:The shape you are trying to find the difference with.

Go Back

GetDistanceTo(Feature,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

targetFeature

shapeUnit

distanceUnit

Go Back

GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

targetShape

shapeUnit

distanceUnit

Go Back

GetFeature(IDictionary<String,String>)

N/A

Remarks

N/A

Return Value

  • Return Type:Feature
  • Description:N/A

Parameters

columnValues

  • Type:IDictionary<String,String>
  • Description:N/A

Go Back

GetFeature()

N/A

Remarks

N/A

Return Value

  • Return Type:Feature
  • Description:N/A

Parameters

GetGeoJson()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

GetHashCode()

N/A

Remarks

N/A

Return Value

  • Return Type:Int32
  • Description:N/A

Parameters

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

  • Return 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.

Go Back

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

  • Return 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

  • Description:The shape you are trying to find the intersection with.

Go Back

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

  • Return 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

  • Description:This is the GeographyUnit of the shape you are performing the operation on.

returningUnit

  • 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.

Go Back

GetShortestLineTo(Feature,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetFeature

shapeUnit

Go Back

GetShortestLineTo(BaseShape,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

shapeUnit

Go Back

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

  • Return 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.

Go Back

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

  • Return 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

  • Description:The shape you are trying to find the symmetrical difference with.

Go Back

GetType()

N/A

Remarks

N/A

Return Value

  • Return Type:Type
  • Description:N/A

Parameters

GetWellKnownBinary(RingOrder,WkbByteOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

outerRingOrder

byteOrder

Go Back

GetWellKnownBinary(RingOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

outerRingOrder

Go Back

GetWellKnownBinary(WkbByteOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

byteOrder

Go Back

GetWellKnownBinary()

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

GetWellKnownText()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

GetWellKnownText(RingOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

outerRingOrder

Go Back

GetWellKnownType()

N/A

Remarks

N/A

Return Value

Parameters

Intersects(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Intersects(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

IsDisjointed(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

IsDisjointed(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsTopologicallyEqual(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

IsTopologicallyEqual(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsWithin(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

IsWithin(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

LoadFromWellKnownData(Byte[])

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

wellKnownBinary

  • Type:Byte[]
  • Description:N/A

Go Back

LoadFromWellKnownData(String)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

wellKnownText

  • Type:String
  • Description:N/A

Go Back

Overlaps(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

Overlaps(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Register(PointShape,PointShape,DistanceUnit,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

fromPoint

toPoint

fromUnit

toUnit

Go Back

Register(Feature,Feature,DistanceUnit,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

fromPoint

toPoint

fromUnit

toUnit

Go Back

Rotate(PointShape,Single)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

pivotPoint

degreeAngle

  • Type:Single
  • Description:N/A

Go Back

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

  • Return 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.

Go Back

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

  • Return 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

  • 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.

Go Back

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

  • Return 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.

Go Back

ScaleTo(Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

scale

  • Type:Double
  • Description:N/A

Go Back

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

  • Return Type:Feature
  • Description:N/A

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.

Go Back

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

  • 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.

Go Back

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

  • Return Type:Void
  • Description:N/A

Parameters

percentage

  • Type:Double
  • Description:This is the percentage by which to increase the shape's size.

Go Back

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

  • Return Type:MultipolygonShape
  • Description:This method returns a simplification multipolgyon by the specified parameters.

Parameters

targetShape

  • 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

  • Description:This prameter specifies the type of simplification operation.

Go Back

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

  • Return Type:MultipolygonShape
  • Description:This method returns a simplification multipolgyon by the specified parameters.

Parameters

targetShape

  • Description:This parameter specifies the area shape to be simplfied.

targetShapeUnit

  • 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

  • Description:This parameter specifes the distance unit of the tolerance.

simplificationType

  • Description:This prameter specifies the type of simplification operation.

Go Back

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

  • Return Type:MultipolygonShape
  • Description:This method returns a simplification multipolgyon by the specified parameters.

Parameters

shapeUnit

  • 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

  • Description:This parameter specifes the distance unit of the tolerance.

simplificationType

  • Description:This prameter specifies the type of simplification operation.

Go Back

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

  • Return 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

  • Description:This prameter specifies the type of simplification operation.

Go Back

Split(Feature,Feature)

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

Remarks

None.

Return Value

  • Return 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.

Go Back

Split(AreaBaseShape,AreaBaseShape)

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

Remarks

None.

Return Value

  • Return Type:Collection<MultipolygonShape>
  • Description:This method returns a collection of MultiPolygonShape split by the specified parameters.

Parameters

areaToSplit

  • Description:This parameter represents the shape to be split.

areaToSplitBy

  • Description:This parameter represents the shape that will be used to perform the split.

Go Back

ToString()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

Touches(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Touches(Feature)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetFeature

Go Back

TranslateByDegree(Double,Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

distance

  • Type:Double
  • Description:N/A

angleInDegrees

  • Type:Double
  • Description:N/A

Go Back

TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

distance

  • Type:Double
  • Description:N/A

angleInDegrees

  • Type:Double
  • Description:N/A

shapeUnit

distanceUnit

Go Back

TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

xOffsetDistance

  • Type:Double
  • Description:N/A

yOffsetDistance

  • Type:Double
  • Description:N/A

shapeUnit

distanceUnit

Go Back

TranslateByOffset(Double,Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

xOffsetDistance

  • Type:Double
  • Description:N/A

yOffsetDistance

  • Type:Double
  • Description:N/A

Go Back

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

  • Return 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.

Go Back

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

  • Return 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.

Go Back

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

  • Return 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

  • Description:The shape you are trying to find the union with.

Go Back

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

  • Return 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.

Go Back

Validate(ShapeValidationMode)

N/A

Remarks

N/A

Return Value

Parameters

validationMode

Go Back

Protected Methods

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

bufferCapType

shapeUnit

distanceUnit

Go Back

CloneDeepCore()

N/A

Remarks

N/A

Return Value

Parameters

ContainsCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

CrossesCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

Finalize()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

GetAccurateAreaCore(String,AreaUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeProj4ProjectionParameters

  • Type:String
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

GetAccuratePerimeterCore(String,DistanceUnit,DistanceCalculationMode)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

shapeProj4ProjectionParameters

  • Type:String
  • Description:N/A

returningUnit

distanceCalculationMode

Go Back

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

  • Return 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

  • 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.

Go Back

GetBoundingBoxCore()

N/A

Remarks

N/A

Return Value

Parameters

GetCenterPointCore()

N/A

Remarks

N/A

Return Value

Parameters

GetClosestPointToCore(BaseShape,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

shapeUnit

Go Back

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

  • Return 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

GetCrossingCore(BaseShape)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

Go Back

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

  • Return 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

  • Description:The shape you are trying to find the difference with.

Go Back

GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Double
  • Description:N/A

Parameters

targetShape

shapeUnit

distanceUnit

Go Back

GetGeoJsonCore()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

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

  • Return 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

  • Description:The shape you are trying to find the intersection with.

Go Back

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

  • Return 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

  • Description:This is the GeographyUnit of the shape you are performing the operation on.

returningUnit

  • 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.

Go Back

GetShortestLineToCore(BaseShape,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

targetShape

shapeUnit

Go Back

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

  • Return 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

  • Description:The shape you are trying to find the symmetrical difference with.

Go Back

GetWellKnownBinaryCore(RingOrder,WkbByteOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:Byte[]
  • Description:N/A

Parameters

outerRingOrder

byteOrder

Go Back

GetWellKnownTextCore(RingOrder)

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

outerRingOrder

Go Back

GetWellKnownTypeCore()

N/A

Remarks

N/A

Return Value

Parameters

IntersectsCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsDisjointedCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsTopologicallyEqualCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

IsWithinCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

LoadFromWellKnownDataCore(Byte[])

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

wellKnownBinary

  • Type:Byte[]
  • Description:N/A

Go Back

LoadFromWellKnownDataCore(String)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

wellKnownText

  • Type:String
  • Description:N/A

Go Back

MemberwiseClone()

N/A

Remarks

N/A

Return Value

  • Return Type:Object
  • Description:N/A

Parameters

OverlapsCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit)

N/A

Remarks

N/A

Return Value

Parameters

fromPoint

toPoint

fromUnit

toUnit

Go Back

RotateCore(PointShape,Single)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

pivotPoint

degreeAngle

  • Type:Single
  • Description:N/A

Go Back

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

  • Return Type:Void
  • Description:N/A

Parameters

percentage

  • Type:Double
  • Description:This is the percentage by which to decrease the shape's size.

Go Back

ScaleToCore(Double)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

scale

  • Type:Double
  • Description:N/A

Go Back

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

  • Return Type:Void
  • Description:N/A

Parameters

percentage

  • Type:Double
  • Description:This is the percentage by which to increase the shape's size.

Go Back

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

  • Return 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

  • Description:This prameter specifies the type of simplification operation.

Go Back

TouchesCore(BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

targetShape

Go Back

TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

distance

  • Type:Double
  • Description:N/A

angleInDegrees

  • Type:Double
  • Description:N/A

shapeUnit

distanceUnit

Go Back

TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

xOffsetDistance

  • Type:Double
  • Description:N/A

yOffsetDistance

  • Type:Double
  • Description:N/A

shapeUnit

distanceUnit

Go Back

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

  • Return 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

  • Description:The shape you are trying to find the union with.

Go Back

ValidateCore(ShapeValidationMode)

N/A

Remarks

N/A

Return Value

Parameters

validationMode

Go Back

Public Properties

CanRotate

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

Id

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

Tag

N/A

Remarks

N/A

Return Value

Return Type:Object

Go Back

Protected Properties

Public Events

thinkgeo.mapsuite.core.areabaseshape.1442484080.txt.gz · Last modified: 2015/09/17 10:01 by admin