QGIS API Documentation 3.41.0-Master (64d82d4c163)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsPointCloudRequest Class Reference

Point cloud data request. More...

#include <qgspointcloudrequest.h>

Public Member Functions

 QgsPointCloudRequest ()
 
QgsPointCloudAttributeCollection attributes () const
 Returns attributes.
 
QgsRectangle filterRect () const
 Returns the rectangle from which points will be taken, in point cloud's crs.
 
bool ignoreIndexFilterEnabled () const
 Returns whether the request will ignore the point cloud index's filter expression, practically returning all the points.
 
bool operator== (const QgsPointCloudRequest &other) const
 
void setAttributes (const QgsPointCloudAttributeCollection &attributes)
 Set attributes filter in the request.
 
void setFilterRect (QgsRectangle extent)
 Sets the rectangle from which points will be taken, in point cloud's crs.
 
void setIgnoreIndexFilterEnabled (bool enable)
 When enable is true, the request will ignore the point cloud index's filter expression and use an empty subsetString practically returning all the points.
 

Detailed Description

Point cloud data request.

Since
QGIS 3.18

Definition at line 41 of file qgspointcloudrequest.h.

Constructor & Destructor Documentation

◆ QgsPointCloudRequest()

QgsPointCloudRequest::QgsPointCloudRequest ( )
default

Member Function Documentation

◆ attributes()

QgsPointCloudAttributeCollection QgsPointCloudRequest::attributes ( ) const

Returns attributes.

Definition at line 31 of file qgspointcloudrequest.cpp.

◆ filterRect()

QgsRectangle QgsPointCloudRequest::filterRect ( ) const
inline

Returns the rectangle from which points will be taken, in point cloud's crs.

If the returned rectangle is empty, then no filter rectangle is set.

Since
QGIS 3.30

Definition at line 59 of file qgspointcloudrequest.h.

◆ ignoreIndexFilterEnabled()

bool QgsPointCloudRequest::ignoreIndexFilterEnabled ( ) const
inline

Returns whether the request will ignore the point cloud index's filter expression, practically returning all the points.

See also
setIgnoreIndexFilterEnabled
Since
QGIS 3.42

Definition at line 84 of file qgspointcloudrequest.h.

◆ operator==()

bool QgsPointCloudRequest::operator== ( const QgsPointCloudRequest other) const

Definition at line 24 of file qgspointcloudrequest.cpp.

◆ setAttributes()

void QgsPointCloudRequest::setAttributes ( const QgsPointCloudAttributeCollection attributes)

Set attributes filter in the request.

Definition at line 36 of file qgspointcloudrequest.cpp.

◆ setFilterRect()

void QgsPointCloudRequest::setFilterRect ( QgsRectangle  extent)
inline

Sets the rectangle from which points will be taken, in point cloud's crs.

An empty rectangle removes the filter.

Since
QGIS 3.30

Definition at line 65 of file qgspointcloudrequest.h.

◆ setIgnoreIndexFilterEnabled()

void QgsPointCloudRequest::setIgnoreIndexFilterEnabled ( bool  enable)
inline

When enable is true, the request will ignore the point cloud index's filter expression and use an empty subsetString practically returning all the points.

Defaults to false, which means the returned points will be filtered using the point cloud index's filter expression. This is used in point cloud editing where we want to iterate all points so we have the correct point indexes within each node.

See also
ignoreIndexFilterEnabled
Since
QGIS 3.42

Definition at line 76 of file qgspointcloudrequest.h.


The documentation for this class was generated from the following files: