Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISImmutablePart
Since: 1.0.0
Summary
Represents a single part of a multipart geometry (polygon or polyline).
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
Yes | Yes | The end point of the last segment in the part. Returns null if the collection is empty. | ||
No | Yes | True if the part contains any curve segments, false otherwise. | ||
No | Yes | Indicates if the part contains no segments. | ||
No | Yes | The count of points in the part. | ||
No | Yes | The count of segments in the part. | ||
Yes | Yes | The spatial reference for the immutable part. | ||
Yes | Yes | The start point of the first segment in the part. Returns null if the collection is empty. |
EndPoint
ArcGISPoint GetEndPoint() const
The end point of the last segment in the part. Returns null if the collection is empty.
HasCurves
bool GetHasCurves() const
True if the part contains any curve segments, false otherwise.
If the value is true, curve segments may be returned from ArcGISImmutablePart::GetSegment. A part may contain a mix of linear and curve segments.
PointCount
size_t GetPointCount() const
The count of points in the part.
The points in the part are the start and end points of segments. Segments can share a point if the end point of one segment matches the start point of the next.
SpatialReference
ArcGISSpatialReference GetSpatialReference() const
The spatial reference for the immutable part.
If the collection does not have a spatial reference null is returned.
StartPoint
ArcGISPoint GetStartPoint() const
The start point of the first segment in the part. Returns null if the collection is empty.
Methods
| Signature | Return Type | Summary |
|---|---|---|
For a segment at a specified segment_index the method returns the point index of the segment's end point. | ||
Returns a point at a specified point index. | ||
Returns all the points that are the vertexes of the part. | ||
Gets a segment at a specified segment index. | ||
Converts from a point index to a segment index that uses the given point as an end point. If the point is not an end point then -1 is returned. | ||
Converts from a point index to a segment index of the start point and another segment index containing the end point. If the point is not a start or end point, then -1 is set. | ||
Converts from a point index to a segment index that uses the given point as a start point. If the point is not a start point, then -1 is returned. | ||
For a segment at a specified segment_index the method returns the point index of the segment's start point. |
GetEndPointIndexFromSegmentIndex
For a segment at a specified segment_index the method returns the point index of the segment's end point.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
segment | No | Zero-based index of the segment. |
Returns size_t
A point index
GetPoint
ArcGISPoint GetPoint(size_t pointIndex) const
Returns a point at a specified point index.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. |
Returns ArcGISPoint
An ArcGISPoint.
GetPoints
ArcGISImmutablePointCollection GetPoints() const
Returns all the points that are the vertexes of the part.
Since 1.0.0
Returns ArcGISImmutablePointCollection
A collections of points in the immutable part.
GetSegment
ArcGISSegment GetSegment(size_t segmentIndex) const
Gets a segment at a specified segment index.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
segment | No | Zero-based index of the segment. |
Returns ArcGISSegment
An ArcGISSegment.
GetSegmentIndexFromEndPointIndex
Converts from a point index to a segment index that uses the given point as an end point. If the point is not an end point then -1 is returned.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. |
Returns size_t
The segment index containing the end point. If the point index is not an end point, then -1 is returned.
GetSegmentIndexFromPointIndex
void GetSegmentIndexFromPointIndex(size_t pointIndex, size_t* outStartPointSegmentIndex, size_t* outEndPointSegmentIndex) const
Converts from a point index to a segment index of the start point and another segment index containing the end point. If the point is not a start or end point, then -1 is set.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. | |
out | No | This is set to the segment index using the point as a start point. Can be null. | |
out | No | This is set to the segment index using the point as an end point. Can be null. |
Returns void
GetSegmentIndexFromStartPointIndex
Converts from a point index to a segment index that uses the given point as a start point. If the point is not a start point, then -1 is returned.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. |
Returns size_t
The segment index containing the start point. If point is not a start point, then -1 is returned.
GetStartPointIndexFromSegmentIndex
For a segment at a specified segment_index the method returns the point index of the segment's start point.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
segment | No | Zero-based index of the segment. |
Returns size_t
A point index