Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISMutablePart
Since: 1.0.0
Summary
Represents a single part of a multipart builder.
Constructors
ArcGISMutablePart(const ArcGISSpatialReference&)
Creates a part 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 |
|---|---|---|---|---|
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 | No | The spatial reference for the 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.
Both linear segments (represented by ArcGISLineSegment) and curve segments (represented by ArcGISCubicBezierSegment or ArcGISEllipticArcSegment) are supported in a ArcGISMutablePart. This property returns true if any curve segments (ArcGISSegment::IsCurve is true) are currently present in this part.
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 part.
If the mutable_part 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 |
|---|---|---|
Add a new point to the end of the part by specifying the points x,y coordinates. A new line segment is added to connect the new point to the previous. | ||
Add a new point to the end of the part by specifying the points x,y,z coordinates. A new line segment is added to connect the new point to the previous. | ||
AddPoint(const ArcGISPoint&) | Add a new point to the end of the part. A new line segment is added to connect the new point to the previous. | |
AddSegment(const ArcGISSegment&) | Add segment to the end of the part. | |
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. | ||
Inserts a point specified by its x,y coordinates into the part at the specified point index. Line segments are added to connect the point to adjacent segments. | ||
Inserts a point specified by its x,y,z coordinate into the part at the specified point index. Line segments are added to connect the point to adjacent segments. | ||
InsertPoint(size_t, const ArcGISPoint&) | Inserts a point into the part at the specified point index. Line segments are added to connect the point to adjacent segments. | |
InsertSegment(size_t, const ArcGISSegment&) | Inserts a segment into the part at the specified index. | |
Remove all segments from the part. | ||
Removes a point from the part. Segments connecting to this point are removed and the gap filled with a new line segment. | ||
Remove a segment at the specified index from the part. | ||
SetPoint(size_t, const ArcGISPoint&) | Replace a point in the part at the specified point index. Segments that use this point are changed. | |
SetSegment(size_t, const ArcGISSegment&) | Replaces a segment at the specified index in the part. |
AddPoint
Add a new point to the end of the part by specifying the points x,y coordinates. A new line segment is added to connect the new point to the previous.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | No | The x-coordinate of the new point. | |
y | No | The y-coordinate of the new point. |
Returns size_t
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 part by specifying the points x,y,z coordinates. A new line segment is added to connect the new point to the previous.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
x | No | The x-coordinate of the new point. | |
y | No | The y-coordinate of the new point. | |
z | No | The z-coordinate of the new point. |
Returns size_t
the point index where the point was added. If an error occurred then -1 is returned.
AddPoint
size_t AddPoint(const ArcGISPoint& point)
Add a new point to the end of the part. A new line segment is added to connect the new point to the previous.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | Yes | The point to add. |
Returns size_t
the point index where the point was added. If an error occurred then -1 is returned.
AddSegment
size_t AddSegment(const ArcGISSegment& segment)
Add segment to the end of the part.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
segment | Yes | The segment. |
Returns size_t
the segment index where the segment was added. If an error occurred, then -1 is returned.
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
A ArcGISPoint.
GetPoints
ArcGISImmutablePointCollection GetPoints() const
Returns all the points that are the vertexes of the part.
Since 1.0.0
Returns ArcGISImmutablePointCollection
The immutable collections of points.
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
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 or max size_t if the segment is not found.
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
InsertPoint
Inserts a point specified by its x,y coordinates into the part at the specified point index. Line segments are added to connect the point to adjacent segments.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. | |
x | No | The x-coordinate of the new point. | |
y | No | The y-coordinate of the new point. |
Returns void
InsertPoint
Inserts a point specified by its x,y,z coordinate into the part at the specified point index. Line segments are added to connect the point to adjacent segments.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. | |
x | No | The x-coordinate of the new point. | |
y | No | The y-coordinate of the new point. | |
z | No | The z-coordinate of the new point. |
Returns void
InsertPoint
void InsertPoint(size_t pointIndex, const ArcGISPoint& point)
Inserts a point into the part at the specified point index. Line segments are added to connect the point to adjacent segments.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. | |
point | Yes | The point to insert. |
Returns void
InsertSegment
void InsertSegment(size_t segmentIndex, const ArcGISSegment& segment)
Inserts a segment into the part at the specified index.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
segment | No | Zero-based index of the segment. | |
segment | Yes | The segment to insert. |
Returns void
RemovePoint
Removes a point from the part. Segments connecting to this point are removed and the gap filled with a new line segment.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. |
Returns void
RemoveSegment
Remove a segment at the specified index from the part.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
segment | No | Zero-based index of the segment. |
Returns void
SetPoint
void SetPoint(size_t pointIndex, const ArcGISPoint& point)
Replace a point in the part at the specified point index. Segments that use this point are changed.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
point | No | Zero-based index of the point. | |
point | Yes | The point. |
Returns void
SetSegment
void SetSegment(size_t segmentIndex, const ArcGISSegment& segment)
Replaces a segment at the specified index in the part.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
segment | No | Zero-based index of the segment. | |
segment | Yes | The segment to be set into the collection. |