ProximityResult Class

ProximityResult

class Esri::ArcGISRuntime::ProximityResult

The returned results of calling GeometryEngine::nearestCoordinate(const Esri::ArcGISRuntime::Geometry&, const Esri::ArcGISRuntime::Point&) and GeometryEngine::nearestVertex(const Esri::ArcGISRuntime::Geometry&, const Esri::ArcGISRuntime::Point&). More...

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

List of all members, including inherited members

Public Functions

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

Static Public Members

int	npos()

Detailed Description

Relevant samples:

Nearest vertex: Find the closest vertex and coordinate of a geometry to a point.

Member Function Documentation

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

Copy constructor from other ProximityResult.

`[noexcept]` ProximityResult::ProximityResult(Esri::ArcGISRuntime::ProximityResult &&other)

Move constructor from other ProximityResult.

`[noexcept]` ProximityResult::~ProximityResult()

Destructor.

Esri::ArcGISRuntime::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.

`[noexcept]` Esri::ArcGISRuntime::ProximityResult &ProximityResult::operator=(Esri::ArcGISRuntime::ProximityResult &&other)

Equivalency operator to other ProximityResult.

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

Assignment operator from other ProximityResult.