BuildingFilterBlock Class | ArcGIS Maps SDK for Qt

BuildingFilterBlock

class Esri::ArcGISRuntime::BuildingFilterBlock

Defines a set of conditions that can show or hide components in a BuildingSceneLayer. More...

Header:	`#include <BuildingFilterBlock.h>`
Since:	Esri::ArcGISRuntime 300.0
Inherits:	Esri::ArcGISRuntime::Object

List of all members, including inherited members

Public Functions

	BuildingFilterBlock(const QString &title, const QString &whereClause, Esri::ArcGISRuntime::BuildingFilterMode *mode, QObject *parent = nullptr)
virtual	~BuildingFilterBlock() override
Esri::ArcGISRuntime::BuildingFilterBlock *	clone(QObject *parent = nullptr) const
Esri::ArcGISRuntime::BuildingFilterMode *	mode() const
void	setMode(Esri::ArcGISRuntime::BuildingFilterMode *mode)
void	setTitle(const QString &title)
void	setWhereClause(const QString &whereClause)
QString	title() const
QString	whereClause() const

Detailed Description

Relevant samples:

Filter building scene layer: Explore details of a building scene by using filters and sublayer visibility.

Member Function Documentation

BuildingFilterBlock::BuildingFilterBlock(const QString &title, const QString &whereClause, Esri::ArcGISRuntime::BuildingFilterMode **mode*, QObject **parent* = nullptr)

Creates a new building filter block for filtering the content displayed in a building scene layer.

title - The title of the filter block.
whereClause - The SQL where clause used to match features to this filter block.
mode - The mode for the filter block.
parent - The optional parent QObject.

`[override virtual noexcept]` BuildingFilterBlock::~BuildingFilterBlock()

Destructor.

Esri::ArcGISRuntime::BuildingFilterBlock *BuildingFilterBlock::clone(QObject **parent* = nullptr) const

Clones and returns this instance of the filter block and its members, with an optional parent.

Esri::ArcGISRuntime::BuildingFilterMode *BuildingFilterBlock::mode() const

Returns how features are drawn when participating in a filter block.

See also setMode().

void BuildingFilterBlock::setMode(Esri::ArcGISRuntime::BuildingFilterMode **mode*)

Sets the mode to mode.

See also mode.

void BuildingFilterBlock::setTitle(const QString &title)

Sets the title to title.

See also title.

void BuildingFilterBlock::setWhereClause(const QString &whereClause)

Sets the whereClause to whereClause.

See also whereClause.

QString BuildingFilterBlock::title() const

Returns the title of the filter block.

See also setTitle().

QString BuildingFilterBlock::whereClause() const

Returns a SQL where clause used to match features to this filter block. Features that satisfy this clause are displayed.

This expression only supports standardized SQL and is evaluated against feature attributes on the client. For buildings with a "BldgLevel" attribute, for example, a clause to display only the first floor might look like this: "BldgLevel=1". Invalid or malformed SQL will cause zero features to pass the filter block: none will be rendered. An empty where clause will cause all features to pass the filter block: all will be rendered.

See also setWhereClause().