ImmutablePart Class

  • ImmutablePart
  • class Esri::ArcGISRuntime::ImmutablePart

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

    Header: #include <ImmutablePart.h>
    Since: Esri::ArcGISRuntime 100.0

    Public Functions

    ImmutablePart()
    ImmutablePart(const Esri::ArcGISRuntime::ImmutablePart &other)
    ImmutablePart(Esri::ArcGISRuntime::ImmutablePart &&other)
    ~ImmutablePart()
    Esri::ArcGISRuntime::Point endPoint() const
    int endPointIndexFromSegmentIndex(int segmentIndex) const
    bool hasCurves() const
    bool isEmpty() const
    Esri::ArcGISRuntime::Point point(int pointIndex) const
    int pointCount() const
    Esri::ArcGISRuntime::ImmutablePointCollection points() const
    Esri::ArcGISRuntime::Segment segment(int segmentIndex) const
    int segmentCount() const
    int segmentIndexFromEndPointIndex(int pointIndex) const
    void segmentIndexFromPointIndex(int pointIndex, int &outStartPointSegmentIndex, int &outEndPointSegmentIndex) const
    int segmentIndexFromStartPointIndex(int pointIndex) const
    Esri::ArcGISRuntime::SpatialReference spatialReference() const
    Esri::ArcGISRuntime::Point startPoint() const
    int startPointIndexFromSegmentIndex(int segmentIndex) const
    Esri::ArcGISRuntime::ImmutablePart &operator=(const Esri::ArcGISRuntime::ImmutablePart &other)
    Esri::ArcGISRuntime::ImmutablePart &operator=(Esri::ArcGISRuntime::ImmutablePart &&other)

    Detailed Description

    This collection is used to represent a part in a Multipart geometry. This is a collection of segments. The points that are the vertices of the segments are also accessible.

    Member Function Documentation

    ImmutablePart::ImmutablePart()

    Default constructor.

    ImmutablePart::ImmutablePart(const Esri::ArcGISRuntime::ImmutablePart &other)

    Copy constructor from other ImmutablePart.

    ImmutablePart::ImmutablePart(Esri::ArcGISRuntime::ImmutablePart &&other)

    Move constructor from other ImmutablePart.

    ImmutablePart::~ImmutablePart()

    Destructor.

    Esri::ArcGISRuntime::Point ImmutablePart::endPoint() const

    Gets the end Point.

    Returns the end Point.

    int ImmutablePart::endPointIndexFromSegmentIndex(int segmentIndex) const

    Gets the end point index from the given segmentIndex.

    Returns the end point index or -1 on error or invalid index.

    bool ImmutablePart::hasCurves() const

    Returns true if this part has curves.

    bool ImmutablePart::isEmpty() const

    Gets whether the ImmutablePart contains anything.

    Returns true if the ImmutablePart contains no points or segments.

    Esri::ArcGISRuntime::Point ImmutablePart::point(int pointIndex) const

    Gets the Point at pointIndex.

    Returns the Point or an empty Point if the index isn't valid.

    int ImmutablePart::pointCount() const

    Gets the point count of the ImmutablePart.

    Returns the number of points.

    Esri::ArcGISRuntime::ImmutablePointCollection ImmutablePart::points() const

    Gets the points of the ImmutablePart as an ImmutablePointCollection.

    Returns the end Point.

    Esri::ArcGISRuntime::Segment ImmutablePart::segment(int segmentIndex) const

    Gets the Segment at segmentIndex.

    Returns the Segment or an empty Segment if the index isn't valid.

    int ImmutablePart::segmentCount() const

    Gets the segment count of the ImmutablePart.

    Returns the number of segments.

    int ImmutablePart::segmentIndexFromEndPointIndex(int pointIndex) const

    Gets the segment index from the end point index 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.

    void ImmutablePart::segmentIndexFromPointIndex(int pointIndex, int &outStartPointSegmentIndex, int &outEndPointSegmentIndex) const

    Returns converting 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.

    • outStartPointSegmentIndex - The index of the segment that begins at pointIndex.
    • outEndPointSegmentIndex - The index of the segment that ends at pointIndex.

    On error, the values are set to -1.

    int ImmutablePart::segmentIndexFromStartPointIndex(int pointIndex) const

    Returns converting 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.

    • pointIndex - Zero-based index of the point.

    Returns the segment point index or -1 on error or invalid index.

    Esri::ArcGISRuntime::SpatialReference ImmutablePart::spatialReference() const

    Gets the SpatialReference of the ImmutablePart.

    Returns the SpatialReference.

    Esri::ArcGISRuntime::Point ImmutablePart::startPoint() const

    Gets the start Point.

    Returns the start Point.

    int ImmutablePart::startPointIndexFromSegmentIndex(int segmentIndex) const

    Gets the start point index from the given segmentIndex.

    Returns the start point index or -1 on error or invalid index.

    Esri::ArcGISRuntime::ImmutablePart &ImmutablePart::operator=(const Esri::ArcGISRuntime::ImmutablePart &other)

    Assignment operator from other ImmutablePart.

    Esri::ArcGISRuntime::ImmutablePart &ImmutablePart::operator=(Esri::ArcGISRuntime::ImmutablePart &&other)

    Move operator from other ImmutablePart.

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