BuildingFilter class final

Defines a set of conditions for filtering the features rendered in a BuildingSceneLayer.

A filter uses BuildingFilterBlock objects to define conditions for displaying or hiding components of a BuildingSceneLayer. Only a single filter block may apply to a Feature at a time. The order of filter blocks influences the order in which the filter blocks are applied. For example, if a filter block is using a BuildingWireframeFilterMode that precedes a block that is using a BuildingSolidFilterMode in the collection, features that match both filter blocks will be drawn as wireframe.

BuildingFilters are only applied to a BuildingComponentSublayer with type BuildingComponentSublayerType.sceneObject.

Implemented types
Mixed-in types

Constructors

BuildingFilter({required String name, required String description, required List<BuildingFilterBlock> blocks})
Creates a new building filter with filter blocks.
factory
BuildingFilter.fromJson(Map<String, dynamic> json)
Creates an instance of this class from JSON of the data type used by jsonDecode.
factory
BuildingFilter.fromJsonString(String jsonString)
Creates an instance of this class from a JSON String.
factory

Properties

blocks List<BuildingFilterBlock>
The filter blocks define which features should be visible in the affected BuildingSceneLayer and how the filtered features should be drawn.
no setter
description String
The description of the filter.
getter/setter pair
filterId String
The unique identifier of the filter.
no setter
hashCode int
The hash code for this object.
no setterinherited
name String
The name of the filter.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

clone() BuildingFilter
Clones this instance of the filter and its members.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Returns a JSON representation of this Object in the data type used by jsonDecode.
inherited
toJsonString() String
Returns a JSON representation of this Object as a String.
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited