ArcGISImmutablePart

Namespace: GameEngine.Geometry
Class: GameEngine/Geometry/ArcGISImmutablePart
Since: 1.0.0

Summary

Represents a single part of a multipart geometry (polygon or polyline).

Properties

PropertyTypeNullableReadonlySummary
Yes
Yes

The end point of the last segment in the part. Returns null if the collection is empty.

No
Yes

Indicates if the part contains any curve segments.

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 EndPoint

The end point of the last segment in the part. Returns null if the collection is empty.

HasCurves

bool HasCurves

Indicates if the part contains any curve segments.

Prior to v100.12, if this property returned true, there was no way to access the curve segment information contained by the part. Retrieving the ArcGISSegment instances of the part would return only ArcGISLineSegment instances.

From v100.12, when this property returns true, curve segments may be returned from ArcGISImmutablePart.GetSegment. A part may contain a mix of linear and curve segments.

IsEmpty

bool IsEmpty

Indicates if the part contains no segments.

PointCount

ulong PointCount

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.

SegmentCount

ulong SegmentCount

The count of segments in the part.

SpatialReference

ArcGISSpatialReference SpatialReference

The spatial reference for the immutable part.

If the collection does not have a spatial reference null is returned.

StartPoint

ArcGISPoint StartPoint

The start point of the first segment in the part. Returns null if the collection is empty.

Methods

SignatureReturn TypeSummary

GetEndPointIndexFromSegmentIndex(ulong)

ulong

For a segment at a specified segment_index the method returns the point index of the segment's end point.

GetPoint(ulong)

ArcGISPoint

Returns a point at a specified point index.

GetPoints()

ArcGISImmutablePointCollection

Returns all the points that are the vertexes of the part.

GetSegment(ulong)

ArcGISSegment

Gets a segment at a specified segment index.

GetSegmentIndexFromEndPointIndex(ulong)

ulong

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.

GetSegmentIndexFromPointIndex(ulong, ulong, ulong)

void

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.

GetSegmentIndexFromStartPointIndex(ulong)

ulong

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.

GetStartPointIndexFromSegmentIndex(ulong)

ulong

For a segment at a specified segment_index the method returns the point index of the segment's start point.

GetEndPointIndexFromSegmentIndex

ulong GetEndPointIndexFromSegmentIndex(ulong segmentIndex)

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
NameTypeSummary
segmentIndex

Zero-based index of the segment.

Returns ulong

A point index

GetPoint

ArcGISPoint GetPoint(ulong pointIndex)

Returns a point at a specified point index.

Since 1.0.0

Arguments
NameTypeSummary
pointIndex

Zero-based index of the point.

Returns ArcGISPoint

An ArcGISPoint.

GetPoints

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(ulong segmentIndex)

Gets a segment at a specified segment index.

Since 1.0.0

Arguments
NameTypeSummary
segmentIndex

Zero-based index of the segment.

Returns ArcGISSegment

An ArcGISSegment.

GetSegmentIndexFromEndPointIndex

ulong GetSegmentIndexFromEndPointIndex(ulong pointIndex)

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
NameTypeSummary
pointIndex

Zero-based index of the point.

Returns ulong

The segment index containing the end point. If the point index is not an end point, then -1 is returned.

GetSegmentIndexFromPointIndex

void GetSegmentIndexFromPointIndex(ulong pointIndex, ulong* outStartPointSegmentIndex, ulong* outEndPointSegmentIndex)

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
NameTypeSummary
pointIndex

Zero-based index of the point.

outStartPointSegmentIndex

This is set to the segment index using the point as a start point. Can be null.

outEndPointSegmentIndex

This is set to the segment index using the point as an end point. Can be null.

Returns void

GetSegmentIndexFromStartPointIndex

ulong GetSegmentIndexFromStartPointIndex(ulong pointIndex)

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
NameTypeSummary
pointIndex

Zero-based index of the point.

Returns ulong

The segment index containing the start point. If point is not a start point, then -1 is returned.

GetStartPointIndexFromSegmentIndex

ulong GetStartPointIndexFromSegmentIndex(ulong segmentIndex)

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
NameTypeSummary
segmentIndex

Zero-based index of the segment.

Returns ulong

A point index

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.