Skip To Content ArcGIS for Developers Sign In Dashboard

ProximityResult Class

(Esri::ArcGISRuntime::ProximityResult)

The results returned from calling GeometryEngine::nearestCoordinate or GeometryEngine::nearestVertex. More...

Header: #include <ProximityResult>
Since: Esri::ArcGISRuntime 100.0

Public Functions

ProximityResult(const ProximityResult &other)
ProximityResult(ProximityResult &&other)
~ProximityResult()
Point coordinate() const
double distance() const
bool isEmpty() const
int partIndex() const
int pointIndex() const
ProximityResult &operator=(const ProximityResult &other)
ProximityResult &operator=(ProximityResult &&other)

Static Public Members

int npos()

Detailed Description

The results returned from calling GeometryEngine::nearestCoordinate or GeometryEngine::nearestVertex.

Member Function Documentation

ProximityResult::ProximityResult(const ProximityResult &other)

Copy constructor from other ProximityResult.

ProximityResult::ProximityResult(ProximityResult &&other)

Move constructor from other ProximityResult.

ProximityResult::~ProximityResult()

Destructor.

Point ProximityResult::coordinate() const

Returns the coordinate of the point.

double ProximityResult::distance() const

Returns the distance to the point.

bool ProximityResult::isEmpty() const

Returns whether this ProximityResult is empty.

[static] int ProximityResult::npos()

Returns the maximum possible value for partIndex or pointIndex.

Used for checking whether the index value is valid. If the index value is equal to npos then the index value is not valid.

int ProximityResult::partIndex() const

Returns the index of the part in which the point was found.

int ProximityResult::pointIndex() const

Returns the index of the point that was found within the part.

ProximityResult &ProximityResult::operator=(const ProximityResult &other)

Assignment operator from other ProximityResult.

ProximityResult &ProximityResult::operator=(ProximityResult &&other)

Equivalency operator to other ProximityResult.


Feedback on this topic?