BuildingSceneLayer class final
A layer that may be used to visualize building models exported from Building Information Modeling (BIM) projects.
This layer is used to visualize and interact with 3D building models developed using Building Information Modeling tools. The data in a building scene layer may represent building features such as walls, light fixtures, mechanical ductwork, and so forth. This layer is supported when used with ArcGISLocalSceneViewController.
The data in a BuildingSceneLayer is organized into a hierarchy of BuildingSublayer. The sublayers of the building scene layer are a Full Model sublayer, which contains all building components, organized into a hierarchy of sublayers, grouped by discipline (such as Architectural, Mechanical, or Structural). The building scene layer may also contain an Overview sublayer, which may be loaded to display the exterior shell of the building. The Overview sublayer provides a means to quickly visualize a building's exterior, in cases where visualization of interior features is not required. Sublayers are available through LayerContent.subLayerContents.
Due to its complexity, the data in this layer is organized using BuildingGroupSublayer, which contains BuildingComponentSublayer. Often, the building scene layer contains an Overview BuildingComponentSublayer that can be loaded to display the exterior shell of a building. This provides a preview of the entire building without loading all interior features. This layer might also contain a Full Model building group sublayer with all the features in a building grouped by disciplines. Each discipline is a building group sublayer containing building component sublayers with features such as rooftops, walls, doors, AC units, lighting fixtures, columns, or foundations.
Building scene layers always have a SurfacePlacement mode of absolute.
- Inheritance
- Implemented types
Constructors
- BuildingSceneLayer.withPortalItem(PortalItem portalItem)
-
Creates a building scene layer object with a portal item.
factory
- BuildingSceneLayer.withUri(Uri uri)
-
Creates a building scene layer object with the URI.
factory
Properties
- activeFilter ↔ BuildingFilter?
-
The active filter to apply to this layer.
getter/setter pair
- altitudeOffset ↔ double
-
The layer altitude offset.
getter/setter pair
- apiKey ↔ String
-
The API key allows your app to access ArcGIS location services and private
portal items.
getter/setter pairoverride
- attribution → String
-
The attribution text for the layer.
no setterinherited
- canChangeVisibility → bool
-
A flag indicating whether the layer content's visibility can be changed.
no setterinherited
- description ↔ String
-
The description for the layer.
getter/setter pairinherited
-
filters
→ List<
BuildingFilter> -
A collection of all available filters, including those that were
pre-authored from the service or package.
no setter
- fullExtent → Envelope?
-
The full extent of this layer, which is the extent where all layer data is
contained.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- id ↔ String
-
The unique identifying string for the layer, as specified in a map or
scene.
getter/setter pairinherited
- isIdentifyEnabled → bool
-
True if the layer supports identify, false otherwise.
no setterinherited
- isVisible ↔ bool
-
The layer content's visibility.
getter/setter pairinherited
- item → Item?
-
The item the layer has been created from.
no setterinherited
- loadError → ArcGISException?
-
The load error.
no setterinherited
- loadStatus → LoadStatus
-
The load status.
no setterinherited
- maxScale ↔ double
-
The maximum scale for the layer.
getter/setter pairinherited
- minScale ↔ double
-
The minimum scale for the layer.
getter/setter pairinherited
- name ↔ String
-
The layer content's name.
getter/setter pairinherited
-
onLoadStatusChanged
→ Stream<
LoadStatus> -
A stream that reports changes to the LoadStatus.
no setterinherited
-
onSubLayerContentChanged
→ Stream<
List< LayerContent> > -
Callback invoked when the sublayer content of the layer content have
changed.
no setterinherited
-
onVisibilityChanged
→ Stream<
bool> -
Callback invoked when the visibility of the layer changes.
no setterinherited
- opacity ↔ double
-
The opacity for the layer.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showChildrenInLegend ↔ bool
-
True if the child layers should be shown in the map legend, false
otherwise.
getter/setter pair
- showInLegend ↔ bool
-
A flag indicating whether the layer content participates in the legend.
getter/setter pairinherited
- spatialReference → SpatialReference?
-
The spatial reference of the layer.
no setterinherited
-
subLayerContents
→ List<
LayerContent> -
The sub layer contents of a layer content.
no setterinherited
-
sublayers
→ List<
BuildingSublayer> -
The hierarchical collection of sublayers in this layer.
no setter
- uri → Uri?
-
The URI of the building scene layer.
no setter
Methods
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
clone(
) → Layer -
Clones this instance of the layer and its members.
inherited
-
fetchLegendInfos(
) → Future< List< LegendInfo> > -
Fetches the list of legend info.
inherited
-
fetchStatistics(
) → Future< Map< CaseInsensitiveString, BuildingSceneLayerAttributeStatistics> > - Fetches available statistics for each attribute defined in this layer. Statistics are stored as a dictionary of key-value pairs, with each key being the attribute's name, and the associated value being a set of relevant statistics.
-
isVisibleAtScale(
double scale) → bool -
Returns the layer content's effective visibility at the specified scale.
inherited
-
load(
) → Future< void> -
Loads the metadata for the object asynchronously.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited