Skip to content

ArcGISBuildingSceneLayer

Namespace: Esri::GameEngine::Layers
Class: Esri/GameEngine/Layers/ArcGISBuildingSceneLayer
Since: 1.2.0
Inheritance: ArcGISLayer->ArcGISBuildingSceneLayer

Summary

A layer that may be used to visualize building models exported from Building Information Modeling (BIM) projects.

Constructors

ArcGISBuildingSceneLayer(const FString&, const FString&)

Creates a new building scene layer.

Since 1.2.0

Arguments
NameTypeConstSummary
sourceFStringYes

Layer source.

APIKeyFStringYes

API key used to load data.

ArcGISBuildingSceneLayer(const FString&, const FString&, float, bool, const FString&)

Creates a new building scene layer.

Since 1.2.0

Arguments
NameTypeConstSummary
sourceFStringYes

Layer source.

nameFStringYes

Layer name.

opacityfloatNo

Layer opacity.

visibleboolNo

Layer visible or not.

APIKeyFStringYes

API key used to load data.

Properties

PropertyTypeNullableReadonlySummary
ActiveBuildingAttributeFilterArcGISBuildingAttributeFilterYesNo

An ArcGISBuildingAttributeFilter from ArcGISBuildingSceneLayer::BuildingAttributeFilters to apply.

BuildingAttributeFiltersArcGISCollection<ArcGISBuildingAttributeFilter>NoYes

A collection of all ArcGISBuildingAttributeFilter that can be applied, including those available from the service or package.

FeatureFilterArcGISSpatialFeatureFilterYesNo

The ArcGISSpatialFeatureFilter to apply to the layer.

SublayersArcGISImmutableCollection<ArcGISBuildingSceneSublayer>NoYes

An immutable collection of ArcGISBuildingSceneSublayer.

ActiveBuildingAttributeFilter

ArcGISBuildingAttributeFilter GetActiveBuildingAttributeFilter() const

void SetActiveBuildingAttributeFilter(const ArcGISBuildingAttributeFilter& activeBuildingAttributeFilter)

An ArcGISBuildingAttributeFilter from ArcGISBuildingSceneLayer::BuildingAttributeFilters to apply.

Must contain a filter that is part of ArcGISBuildingSceneLayer::BuildingAttributeFilters, otherwise a ArcGISErrorType::CommonInvalidArgument exception will occur. If the active filter is set to null, then no filter is applied.

BuildingAttributeFilters

ArcGISCollection<ArcGISBuildingAttributeFilter> GetBuildingAttributeFilters() const

A collection of all ArcGISBuildingAttributeFilter that can be applied, including those available from the service or package.

To enable a building attribute filter on a layer, specify an ArcGISBuildingSceneLayer::ActiveBuildingAttributeFilter from this collection.

FeatureFilter

ArcGISSpatialFeatureFilter GetFeatureFilter() const

void SetFeatureFilter(const ArcGISSpatialFeatureFilter& featureFilter)

The ArcGISSpatialFeatureFilter to apply to the layer.

Sublayers

ArcGISImmutableCollection<ArcGISBuildingSceneSublayer> GetSublayers() const

An immutable collection of ArcGISBuildingSceneSublayer.

Methods

SignatureReturn TypeSummary

FetchStatisticsAsync()

ArcGISFuture<ArcGISDictionary<FString, ArcGISBuildingSceneLayerAttributeStatistics>>

Asynchronously fetches available statistics for each feature attribute defined in this ArcGISBuildingSceneLayer. Statistics are stored as an ArcGISDictionary<Key, Value> of key-value pairs, with each key being the attribute's name, and the associated value being a group of relevant statistics.

FetchStatisticsAsync

ArcGISFuture<ArcGISDictionary<FString, ArcGISBuildingSceneLayerAttributeStatistics>> FetchStatisticsAsync()

Asynchronously fetches available statistics for each feature attribute defined in this ArcGISBuildingSceneLayer. Statistics are stored as an ArcGISDictionary<Key, Value> of key-value pairs, with each key being the attribute's name, and the associated value being a group of relevant statistics.

Since 1.4.0

Returns ArcGISFuture<ArcGISDictionary<FString, ArcGISBuildingSceneLayerAttributeStatistics>>

An ArcGISFuture<T> that returns an ArcGISDictionary<Key, Value> of ArcGISBuildingSceneLayerAttributeStatistics for the ArcGISBuildingSceneLayer

Events

NameTypeSummary
ActiveBuildingAttributeFilterChangedArcGISBuildingSceneLayerActiveBuildingAttributeFilterChangedEvent

Invokes the callback when the ArcGISBuildingSceneLayer::ActiveBuildingAttributeFilter changes.

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