An analysis object that evaluates direct, vertical, and horizontal distances between two points defined by start and end point locations. More...
| Header | #include <Exploratory |
| Since | Esri |
| Inherits | Esri |
Public Functions
| Exploratory | |
| virtual | ~ |
| Esri | direct |
| Esri | end |
| Esri | horizontal |
| void | set |
| void | set |
| void | set |
| Esri | start |
| Esri | unit |
| Esri | vertical |
Signals
| void | measurement |
Detailed Description
The ExploratoryLocationDistanceMeasurement analysis measures the distance between a start and an end location (each using Point geometry).
Three distance components are calculated:
- direct distance - the direct distance between the start and end location
- horizontal distance - the horizontal component of the direct distance
- vertical distance - the vertical component of the direct distance
Relevant samples:
- Distance measurement analysis: Measure distances between two points in 3D.
Member Function Documentation
ExploratoryLocationDistanceMeasurement::ExploratoryLocationDistanceMeasurement (const Esri::ArcGISRuntime::Point &startLocation , const Esri::ArcGISRuntime::Point &endLocation , QObject *parent = nullptr)
Creates a ExploratoryLocationDistanceMeasurement analysis object that defines a start and an end location using Point objects.
The ExploratoryLocationDistanceMeasurement analysis result is a distance measurement between the start and end locations with direct, horizontal, and vertical components.
- startLocation - A point that defines the start location of the measurement.
- endLocation - A point that defines the end location of the measurement.
- parent - An optional parent.
[override virtual noexcept] ExploratoryLocationDistanceMeasurement::~ExploratoryLocationDistanceMeasurement ()
Destructor.
Esri::ArcGISRuntime::Distance ExploratoryLocationDistanceMeasurement::directDistance () const
Returns the direct distance component of the ExploratoryLocationDistanceMeasurement.
The distance's unit will be in the chosen UnitSystem and appropriate for the scale. The value will be empty until the analysis is added to the analysis overlay of a scene view.
See also measurementChanged.
Esri::ArcGISRuntime::Point ExploratoryLocationDistanceMeasurement::endLocation () const
Returns the end location of the ExploratoryLocationDistanceMeasurement.
The point coordinates (x,y,z) define the end location in 3D space.
See also setEndLocation().
Esri::ArcGISRuntime::Distance ExploratoryLocationDistanceMeasurement::horizontalDistance () const
Returns the horizontal distance component of the ExploratoryLocationDistanceMeasurement.
The distance's unit will be in the chosen UnitSystem and appropriate for the scale. The value will be empty until the analysis is added to the analysis overlay of a scene view.
See also measurementChanged.
[signal] void ExploratoryLocationDistanceMeasurement::measurementChanged (const Esri::ArcGISRuntime::Distance &directDistance , const Esri::ArcGISRuntime::Distance &horizontalDistance , const Esri::ArcGISRuntime::Distance &verticalDistance )
Signal emitted when any distance calculation component in a ExploratoryLocationDistanceMeasurement analysis has changed.
- directDistance - The new direct distance calculation.
- horizontalDistance - The new horizontal distance calculation.
- verticalDistance - The new vertical distance calculation.
See also Distance.
void ExploratoryLocationDistanceMeasurement::setEndLocation (const Esri::ArcGISRuntime::Point &endLocation )
Sets the end location of the ExploratoryLocationDistanceMeasurement to endLocation.
The point coordinates (x,y,z) define the end location in 3D space.
See also endLocation().
void ExploratoryLocationDistanceMeasurement::setStartLocation (const Esri::ArcGISRuntime::Point &startLocation )
Sets the start location of the ExploratoryLocationDistanceMeasurement to startLocation.
The point coordinates (x,y,z) define the start location in 3D space.
See also startLocation().
void ExploratoryLocationDistanceMeasurement::setUnitSystem (Esri::ArcGISRuntime::UnitSystem unitSystem )
Sets the UnitSystem of the ExploratoryLocationDistanceMeasurement under which distances are calculated to unitSystem.
See also unitSystem().
Esri::ArcGISRuntime::Point ExploratoryLocationDistanceMeasurement::startLocation () const
Returns the start location of the ExploratoryLocationDistanceMeasurement.
The point coordinates (x,y,z) define the start location in 3D space.
See also setStartLocation().
Esri::ArcGISRuntime::UnitSystem ExploratoryLocationDistanceMeasurement::unitSystem () const
Returns the UnitSystem of the ExploratoryLocationDistanceMeasurement under which distances are calculated.
See also setUnitSystem().
Esri::ArcGISRuntime::Distance ExploratoryLocationDistanceMeasurement::verticalDistance () const
Returns the vertical distance component of the ExploratoryLocationDistanceMeasurement.
The distance's unit will be in the chosen UnitSystem and appropriate for the scale. The value will be empty until the analysis is added to the analysis overlay of a scene view.
See also measurementChanged.