ElevationSource Class

  • ElevationSource
  • class Esri::ArcGISRuntime::ElevationSource

    Elevation sources provide a surface on which data can be draped or offset from. More...

    Header: #include <ElevationSource.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable
    Inherited By:

    Esri::ArcGISRuntime::ArcGISTiledElevationSource and Esri::ArcGISRuntime::RasterElevationSource

    Public Functions

    virtual ~ElevationSource() override
    Esri::ArcGISRuntime::ElevationSourceType elevationSourceType() const
    bool isEnabled() const
    QString name() const
    void setEnabled(bool enabled)
    void setName(const QString &name)

    Reimplemented Public Functions

    virtual void cancelLoad() override
    virtual void load() override
    virtual Esri::ArcGISRuntime::Error loadError() const override
    virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
    virtual void retryLoad() override


    void doneLoading(const Esri::ArcGISRuntime::Error &loadError)
    void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Detailed Description

    This is the base class for elevation sources, such as ArcGISTiledElevationSource and RasterElevationSource. To utilize an elevation source in a scene's surface, create the elevation source and add it to the scene's Surface::elevationSources collection. The combination of elevation sources within the Surface generates a rendering surface on which data can be draped or offset from.

    See also ArcGISTiledElevationSource.

    Member Function Documentation

    [override virtual] ElevationSource::~ElevationSource()


    [override virtual] void ElevationSource::cancelLoad()

    Reimplements: Loadable::cancelLoad().

    Cancels the loading metadata for the object.

    Cancels loading the metadata if the object is loading.

    See Loadable.

    [signal] void ElevationSource::doneLoading(const Esri::ArcGISRuntime::Error &loadError)

    Signal emitted when this object is done loading.

    • loadError - Details about any error that may have occurred.

    Note: If there is a load error it will also be emitted on the errorOccurred signal.

    See also Loadable and Object.

    Esri::ArcGISRuntime::ElevationSourceType ElevationSource::elevationSourceType() const

    Returns the type of elevation source.

    See also ElevationSourceType.

    bool ElevationSource::isEnabled() const

    Returns true if the elevation source participates in the generation of the Surface, false otherwise.

    See also ElevationSourceType.

    [override virtual] void ElevationSource::load()

    Reimplements: Loadable::load().

    Loads the metadata for the object asynchronously.

    Loads the metadata if the object is not loaded.

    See Loadable.

    [override virtual] Esri::ArcGISRuntime::Error ElevationSource::loadError() const

    Reimplements: Loadable::loadError() const.

    Returns the load error.

    See Loadable.

    See also Error.

    [override virtual] Esri::ArcGISRuntime::LoadStatus ElevationSource::loadStatus() const

    Reimplements: Loadable::loadStatus() const.

    Returns the load status.

    See Loadable.

    See also LoadStatus.

    [signal] void ElevationSource::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Signal emitted when the loadStatus property changes.

    See also Loadable.

    QString ElevationSource::name() const

    Returns the name of the elevation source.

    See also setName().

    [override virtual] void ElevationSource::retryLoad()

    Reimplements: Loadable::retryLoad().

    Loads or retries loading metadata for the object asynchronously.

    Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded. Will always call the done loading if this is called.

    See Loadable.

    void ElevationSource::setEnabled(bool enabled)

    Sets the enabled to enabled.

    See also isEnabled.

    void ElevationSource::setName(const QString &name)

    Sets the name to name.

    See also name.

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