Namespace: GameEngine.Geometry
Class: GameEngine/Geometry/ArcGISMutablePointCollection
Since: 1.0.0
Summary
A collection object that can be changed containing points.
Constructors
ArcGISMutablePointCollection(ArcGISSpatialReference)
Creates a mutable point collection with a specified spatial reference.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
spatial | A spatial reference object, can be null. |
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | Yes | Indicates if the mutable point collection contains no points. | ||
No | Yes | The number of points in the collection. | ||
Yes | No | The spatial reference for the mutable point collection. |
SpatialReference
ArcGISSpatialReference SpatialReference
The spatial reference for the mutable point collection.
If the collection does not have a spatial reference null is returned.
Methods
| Signature | Return Type | Summary |
|---|---|---|
Add a new point to the end of the mutable point collection by specifying the points x,y coordinates. | ||
Add a new point to the end of the mutable point collection by specifying the points x,y,z coordinates. | ||
Add a new point to the end of the mutable point collection. | ||
Add a new points to the end of the mutable point collection. | ||
Add a new points to the end of the mutable point collection. | ||
Returns a point at the specified index in the collection. | ||
Retrieves the position of the point in the mutable point collection. The first point that is equal to the supplied point is returned. | ||
Inserts a point specified by its x,y coordinates into the mutable point collection at the specified point index. | ||
Inserts a point specified by its x,y,z coordinate into the mutable point collection at the specified point index. | ||
Inserts a point into the mutable point collection at the specified point index. | ||
Remove all points from the mutable point collection. | ||
Removes a point from the mutable point collection. | ||
Replace a point in the mutable point collection at the specified point index. |
AddPoint
Add a new point to the end of the mutable point collection by specifying the points x,y coordinates.
Since 1.0.0
Arguments
Returns ulong
the point index where the point was added. If an error occurred, then -1 is returned.
AddPoint
Add a new point to the end of the mutable point collection by specifying the points x,y,z coordinates.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
x | The x-coordinate of the new point. | |
y | The y-coordinate of the new point. | |
z | The z coordinate of the new point. |
Returns ulong
the point index where the point was added. If an error occurred, then -1 is returned.
AddPoint
ulong AddPoint(ArcGISPoint point)
Add a new point to the end of the mutable point collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
point | The point to add. |
Returns ulong
the point index where the point was added. If an error occurred, then -1 is returned.
AddPoints
void AddPoints(ArcGISImmutablePointCollection points)
Add a new points to the end of the mutable point collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
points | The new points to add. |
Returns void
AddPoints
void AddPoints(ArcGISMutablePointCollection points)
Add a new points to the end of the mutable point collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
points | The new points to add. |
Returns void
GetPoint
ArcGISPoint GetPoint(ulong index)
Returns a point at the specified index in the collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
index | The position in the collection. |
Returns ArcGISPoint
The point at the specified position in the collection.
IndexOf
ulong IndexOf(ArcGISPoint point)
Retrieves the position of the point in the mutable point collection. The first point that is equal to the supplied point is returned.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
point | The point to find. |
Returns ulong
The position of the point in the collection, -1 otherwise.
InsertPoint
Inserts a point specified by its x,y coordinates into the mutable point collection at the specified point index.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
point | Zero-based index of the point. | |
x | The x-coordinate of the new point. | |
y | The y-coordinate of the new point. |
Returns void
InsertPoint
Inserts a point specified by its x,y,z coordinate into the mutable point collection at the specified point index.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
point | Zero-based index of the point. | |
x | The x-coordinate of the new point. | |
y | The y-coordinate of the new point. | |
z | The z-coordinate of the new point. |
Returns void
InsertPoint
void InsertPoint(ulong pointIndex, ArcGISPoint point)
Inserts a point into the mutable point collection at the specified point index.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
point | Zero-based index of the point. | |
point | The point to insert. |
Returns void
RemoveAll
void RemoveAll()
Remove all points from the mutable point collection.
Since 1.0.0
Returns void
RemovePoint
Removes a point from the mutable point collection.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
point | Zero-based index of the point. |
Returns void
SetPoint
void SetPoint(ulong pointIndex, ArcGISPoint point)
Replace a point in the mutable point collection at the specified point index.
Since 1.0.0
Arguments
| Name | Type | Summary |
|---|---|---|
point | Zero-based index of the point. | |
point | The point. |