Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISMutablePartCollection
Since: 1.0.0
Summary
A collection object that can be changed containing parts for a geometry. Each part is represented by an ArcGISMutablePart.
Constructors
ArcGISMutablePartCollection(const ArcGISSpatialReference&)
Creates a mutable part collection with a specified spatial reference.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
spatial | Yes | A spatial reference object, can be null. |
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | Yes | Indicates if the mutable part collection contains no parts. | ||
No | Yes | The number of parts in the collection. | ||
Yes | No | The spatial reference for the mutable part collection. |
SpatialReference
ArcGISSpatialReference GetSpatialReference() const
The spatial reference for the mutable part collection.
If the collection does not have a spatial reference null is returned.
Methods
| Signature | Return Type | Summary |
|---|---|---|
AddPart(const ArcGISMutablePart&) | Add a new part to the end of the mutable part collection. | |
Returns a part at the specified index in the collection. | ||
IndexOf(const ArcGISMutablePart&) | Retrieves the position of the segment in the mutable part collection. The first segment that is equal to the supplied segment is returned. | |
InsertPart(size_t, const ArcGISMutablePart&) | Inserts a part into the mutable part collection at the specified part index. | |
Remove all parts from the mutable part collection. | ||
Removes a part from the mutable part collection. | ||
SetPart(size_t, const ArcGISMutablePart&) | Replace a part in the mutable part collection at the specified part index. |
AddPart
size_t AddPart(const ArcGISMutablePart& mutablePart)
Add a new part to the end of the mutable part collection.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
mutable | Yes | The part to add. |
Returns size_t
the index where the part was added. If an error occurred, then -1 is returned.
GetPart
ArcGISMutablePart GetPart(size_t index) const
Returns a part at the specified index in the collection.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
index | No | The position in the collection. |
Returns ArcGISMutablePart
The part at the specified position in the collection.
IndexOf
size_t IndexOf(const ArcGISMutablePart& mutablePart) const
Retrieves the position of the segment in the mutable part collection. The first segment that is equal to the supplied segment is returned.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
mutable | Yes | The part to find. |
Returns size_t
The position of the segment in the collection, -1 otherwise.
InsertPart
void InsertPart(size_t index, const ArcGISMutablePart& mutablePart)
Inserts a part into the mutable part collection at the specified part index.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
index | No | Zero-based index of the part. | |
mutable | Yes | The part to insert. |
Returns void
RemovePart
Removes a part from the mutable part collection.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
index | No | Zero-based index of the part. |
Returns void
SetPart
void SetPart(size_t index, const ArcGISMutablePart& mutablePart)
Replace a part in the mutable part collection at the specified part index.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
index | No | Zero-based index of the part. | |
mutable | Yes | Collection of segments representing the part. |