Defines a set of conditions for filtering the features rendered in a BuildingSceneLayer. More...
| Header | #include <Building |
| Since | Esri |
| Inherits | Esri |
Public Functions
| Building | |
| virtual | ~ |
| Esri | blocks() const |
| Esri | clone(QObject *parent = nullptr) const |
| QString | description() const |
| QString | filter |
| QString | name() const |
| void | set |
| void | set |
Reimplemented Public Functions
| virtual QString | to |
Static Public Members
| Esri | from |
Detailed Description
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.
Relevant samples:
- Filter building scene layer: Explore details of a building scene by using filters and sublayer visibility.
Member Function Documentation
BuildingFilter::BuildingFilter (const QString &name, const QString &description, const QList<Esri::ArcGISRuntime::BuildingFilterBlock *> &blocks, QObject *parent = nullptr)
Creates a new building filter with filter blocks.
- name - The name of the filter.
- description - The description of the filter.
- blocks - The filter blocks that define which features are visible and how they should be drawn.
- parent - The optional parent QObject.
[override virtual noexcept] BuildingFilter::~BuildingFilter ()
Destructor.
Esri::ArcGISRuntime::BuildingFilterBlockListModel *BuildingFilter::blocks() const
Returns the filter blocks define which features should be visible in the affected BuildingSceneLayer and how the filtered features should be drawn.
Esri::ArcGISRuntime::BuildingFilter *BuildingFilter::clone(QObject *parent = nullptr) const
Clones and returns this instance of the filter and its members, with an optional parent.
QString BuildingFilter::description() const
Returns the description of the filter.
Use the description to show the user information about the filter.
See also setDescription().
QString BuildingFilter::filterId () const
Returns the unique identifier of the filter.
[static] Esri::ArcGISRuntime::BuildingFilter *BuildingFilter::fromJson (const QString &json, QObject *parent = nullptr)
Convert a JSON string to an object.
- json - The JSON string.
- parent - The optional parent QObject.
QString BuildingFilter::name() const
Returns the name of the filter.
See also setName().
void BuildingFilter::setDescription (const QString &description)
Sets the description to description.
See also description.
void BuildingFilter::setName (const QString &name)
Sets the name to name.
See also name.
[override virtual] QString BuildingFilter::toJson () const
Reimplements: JsonSerializable::toJson() const.
Convert and returns an object to JSON string.