;

DirectionManeuver Class

  • DirectionManeuver
  • class Esri::ArcGISRuntime::DirectionManeuver

    Information about a specific maneuver that must be made in a Route. More...

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

    This class was introduced in Esri::ArcGISRuntime 100.0.

    Public Functions

    DirectionManeuver(Esri::ArcGISRuntime::DirectionManeuver &&other)
    DirectionManeuver(const Esri::ArcGISRuntime::DirectionManeuver &other)
    DirectionManeuver()
    Esri::ArcGISRuntime::DirectionManeuver &operator=(Esri::ArcGISRuntime::DirectionManeuver &&other)
    Esri::ArcGISRuntime::DirectionManeuver &operator=(const Esri::ArcGISRuntime::DirectionManeuver &other)
    ~DirectionManeuver()
    QList<Esri::ArcGISRuntime::DirectionEvent> directionEvents() const
    Esri::ArcGISRuntime::DirectionManeuverType directionManeuverType() const
    QString directionText() const
    double duration() const
    QDateTime estimatedArrivalTime() const
    double estimatedArrivalTimeShift() const
    int fromLevel() const
    Esri::ArcGISRuntime::Geometry geometry() const
    bool isEmpty() const
    double length() const
    QList<Esri::ArcGISRuntime::DirectionMessage> maneuverMessages() const
    int toLevel() const

    Detailed Description

    A Route contains a list of DirectionManeuvers that must be made. Each DirectionManeuver contains information such as a DirectionEvent, DirectionMessage, and DirectionType. These are useful for producing turn by turn directions for a Route.

    Examples of a DirectionManeuver include "Turn left", "Sharp right", or "Make a U-turn".

    Member Function Documentation

    DirectionManeuver::DirectionManeuver(Esri::ArcGISRuntime::DirectionManeuver &&other)

    Move constructor from other DirectionManeuver.

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

    Copy constructor from other DirectionManeuver.

    DirectionManeuver::DirectionManeuver()

    Default constructor.

    Warning: This is for convenience only and will construct an empty object.

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

    Move operator from other DirectionManeuver.

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

    Assignment operator from other DirectionManeuver.

    DirectionManeuver::~DirectionManeuver()

    Destructor.

    QList<Esri::ArcGISRuntime::DirectionEvent> DirectionManeuver::directionEvents() const

    Returns a list of DirectionEvents (e.g. passing state boundaries).

    Esri::ArcGISRuntime::DirectionManeuverType DirectionManeuver::directionManeuverType() const

    Returns the maneuver used to perform this direction (e.g. Depart, Go Straight, and so on).

    QString DirectionManeuver::directionText() const

    Returns the textual representation of a direction (e.g. "Turn right on Main Street").

    double DirectionManeuver::duration() const

    Returns the duration of a DirectionManeuver in minutes.

    QDateTime DirectionManeuver::estimatedArrivalTime() const

    Returns the estimated arrival time for this DirectionManeuver of the route in UTC time.

    double DirectionManeuver::estimatedArrivalTimeShift() const

    Returns the time zone shift of estimated arrival time for this segment of the route in minutes.

    int DirectionManeuver::fromLevel() const

    Returns the from level value for a direction maneuver.

    This property provides a way to filter directions based on logical level division.

    For example, 3D routing applications might render a 2D map and it might be useful to display route lines by logical levels instead of displaying the whole route line that overlaps individual lines on different levels.

    This property is populated from the source data and is never calculated by the directions engine. If the source data does not contain the from level field, the property will be set to -1.

    This function was introduced in Esri::ArcGISRuntime 100.2.

    Esri::ArcGISRuntime::Geometry DirectionManeuver::geometry() const

    Returns the geometry for this segment of the route.

    bool DirectionManeuver::isEmpty() const

    Returns true if this DirectionManeuver is empty.

    double DirectionManeuver::length() const

    Returns the length of this DirectionManeuver.

    The returned value's units is determined by what is set in RouteParameters::directionsDistanceUnits.

    QList<Esri::ArcGISRuntime::DirectionMessage> DirectionManeuver::maneuverMessages() const

    Returns a list of detailed direction messages for this DirectionManeuver.

    int DirectionManeuver::toLevel() const

    Returns the to level value for a direction maneuver.

    This property provides a way to filter directions based on logical level division.

    For example, 3D routing applications might render a 2D map and it might be useful to display route lines by logical levels instead of displaying the whole route line that overlaps individual lines on different levels.

    This property is populated from the source data and is never calculated by the directions engine. If the source data does not contain the to level field, the property will be set to -1.

    This function was introduced in Esri::ArcGISRuntime 100.2.

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