BuildingSublayer Class

Member Function Documentation

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

Destructor.

Esri::ArcGISRuntime::BuildingSublayerType BuildingSublayer::buildingSublayerType() const

Returns the instantiated type of the sublayer.

[override virtual] bool BuildingSublayer::canChangeVisibility() const

Reimplements: LayerContent::canChangeVisibility() const.

Returns a flag indicating whether the layer content's visibility can be changed.

A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

[override virtual] void BuildingSublayer::cancelLoad()

Reimplements: Loadable::cancelLoad().

Cancels loading metadata for the object.

Cancels loading the metadata if the object is loading and always calls doneLoading.

Esri::ArcGISRuntime::BuildingSublayerDiscipline BuildingSublayer::discipline() const

Returns the building discipline (such as Architectural, Mechanical, or Structural) that this sublayer represents.

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

Signal emitted when this object is done loading.

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

See also Loadable and Object.

[override virtual] bool BuildingSublayer::isAutoFetchLegendInfos() const

Reimplements: LayerContent::isAutoFetchLegendInfos() const.

Returns whether legend infos are automatically fetched by the layer's legend info list model.

See also isVisible.

[override virtual] bool BuildingSublayer::isShowInLegend() const

Reimplements: LayerContent::isShowInLegend() const.

Returns a flag indicating whether the layer content participates in the legend.

A flag indicating whether the layer content is shown in the legend.

[override virtual] bool BuildingSublayer::isVisible() const

Reimplements: LayerContent::isVisible() const.

Returns the layer content's visibility.

The layer content visibility. Will return false if an error occurs.

[override virtual] bool BuildingSublayer::isVisibleAtScale(double scale) const

Reimplements: LayerContent::isVisibleAtScale(double scale) const.

Returns the layer content's effective visibility at the specified scale.

• scale - The scale the visibility has to be calculated for.

Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

[override virtual] Esri::ArcGISRuntime::LegendInfoListModel *BuildingSublayer::legendInfos() const

Reimplements: LayerContent::legendInfos() const.

Returns a list of legend information for the layer and any sublayers.

See LayerContent.

[override virtual] void BuildingSublayer::load()

Reimplements: Loadable::load().

Loads the metadata for the object asynchronously.

Loads the metadata if the object is not loaded and always calls doneLoading.

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

Reimplements: Loadable::loadError() const.

Returns the load error.

See also Error.

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

Reimplements: Loadable::loadStatus() const.

Returns the load status.

See also LoadStatus.

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

Signal emitted when the loadStatus changes for this object.

See also Loadable.

QString BuildingSublayer::modelName() const

Returns the name that identifies the building entity (such as Floors, Ceiling, Casework) that this sublayer represents.

This may be used to define behavior or visualization properties specific to a given building component.

[override virtual] QString BuildingSublayer::name() const

Reimplements: LayerContent::name() const.

Returns the name of this sublayer.

See also setName().

float BuildingSublayer::opacity() const

Returns the opacity of this sublayer.

The valid opacity values range from 0.0 (fully transparent) to 1.0 (fully opaque).

See also setOpacity().

[override virtual] void BuildingSublayer::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.

[override virtual] void BuildingSublayer::setAutoFetchLegendInfos(bool autoFetchLegendInfos)

Reimplements: LayerContent::setAutoFetchLegendInfos(bool autoFetchLegendInfos).

Sets whether legend infos are automatically fetched by the layer's legend info list model to autoFetchLegendInfos.

See LayerContent.

See also isAutoFetchLegendInfos().

void BuildingSublayer::setName(const QString &name)

Sets the name to name.

See also name.

void BuildingSublayer::setOpacity(float opacity)

Sets the opacity to opacity.

See also opacity.

[override virtual] void BuildingSublayer::setShowInLegend(bool showInLegend)

Reimplements: LayerContent::setShowInLegend(bool showInLegend).

Sets the showInLegend to showInLegend.

See also isShowInLegend.

[override virtual] void BuildingSublayer::setVisible(bool visible)

Reimplements: LayerContent::setVisible(bool visible).

Sets the visible to visible.

See also isVisible.

[override virtual] QList<Esri::ArcGISRuntime::LayerContent *> BuildingSublayer::subLayerContents() const

Reimplements: LayerContent::subLayerContents() const.

Returns the sub layer contents of a layer content.

int BuildingSublayer::sublayerId() const

Returns the sublayer's layer ID as defined by the scene service.

[signal, since Esri::ArcGISRuntime 100.9] void BuildingSublayer::visibleChanged(bool visible)

Signal emitted when the isVisible property changes for this object.

• visible - The current visibility of the layer.

This function was introduced in Esri::ArcGISRuntime 100.9.