• DistanceSymbolRange
  • class Esri::ArcGISRuntime::DistanceSymbolRange

    Used contain multiple symbols with distance ranges. More...

    Header: #include <DistanceSymbolRange.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    DistanceSymbolRange(QObject *parent = nullptr)
    DistanceSymbolRange(Esri::ArcGISRuntime::Symbol *symbol, QObject *parent = nullptr)
    DistanceSymbolRange(Esri::ArcGISRuntime::Symbol *symbol, double minDistance, double maxDistance, QObject *parent = nullptr)
    virtual ~DistanceSymbolRange() override
    double maxDistance() const
    double minDistance() const
    void setMaxDistance(double maxDistance)
    void setMinDistance(double minDistance)
    void setSymbol(Esri::ArcGISRuntime::Symbol *symbol)
    Esri::ArcGISRuntime::Symbol *symbol() const

    Detailed Description

    Distance composite symbol displays graphics with multiple symbols that may have distance ranges. The range contains a minimum and maximum distance for rendering the symbol. Outside of that range the symbol is not visible.

    Relevant samples:

    See also DistanceCompositeSceneSymbol and DistanceSymbolRange.

    Member Function Documentation

    DistanceSymbolRange::DistanceSymbolRange(QObject *parent = nullptr)

    reate a distance symbol range object.

    • parent - The optional parent QObject.

    Creates a Distance symbol range with just no symbol or no range properties.

    [explicit] DistanceSymbolRange::DistanceSymbolRange(Esri::ArcGISRuntime::Symbol *symbol, QObject *parent = nullptr)

    Create a distance symbol range object.

    • symbol - A symbol to set in the distance symbol range.
    • parent - The optional parent QObject.

    Creates a Distance Range with just a symbol and no range properties. As a result the symbol will always be visible regardless of the distance from the camera.

    DistanceSymbolRange::DistanceSymbolRange(Esri::ArcGISRuntime::Symbol *symbol, double minDistance, double maxDistance, QObject *parent = nullptr)

    Create a distance symbol range object.

    • symbol - A symbol to set in the distance symbol range.
    • minDistance - The minimum distance to set in the distance symbol range. Must be >= 0.0.
    • maxDistance - The maximum distance to set in the distance symbol range. Must be >= 0.0, 0.0 indicates there is no maximum range.
    • parent - The optional parent QObject.

    Creates a Distance Range with a symbol and range properties. As a result the symbol will only be visible when the camera is within the specified distance range. Note that setting the maximum range to 0.0 indicates that there isn't a maximum range limit and the symbol will always be visible beyond its minimum range.

    [override virtual noexcept] DistanceSymbolRange::~DistanceSymbolRange()

    Destructor

    double DistanceSymbolRange::maxDistance() const

    Returns the maximum distance (in meters) of the distance symbol range.

    The maximum distance (in meters) of the distance symbol range object.

    See also setMaxDistance().

    double DistanceSymbolRange::minDistance() const

    Returns the minimum distance (in meters) of the distance symbol range.

    The minimum distance (in meters) of the distance symbol range object.

    See also setMinDistance().

    void DistanceSymbolRange::setMaxDistance(double maxDistance)

    Sets the maxDistance to maxDistance.

    See also maxDistance.

    void DistanceSymbolRange::setMinDistance(double minDistance)

    Sets the minDistance to minDistance.

    See also minDistance.

    void DistanceSymbolRange::setSymbol(Esri::ArcGISRuntime::Symbol *symbol)

    Sets the symbol to symbol.

    See also symbol.

    Esri::ArcGISRuntime::Symbol *DistanceSymbolRange::symbol() const

    Returns the symbol (in meters) of the distance symbol range.

    The symbol Symbol of the distance symbol range object.

    See also setSymbol().