QgsTiledSceneRequest Class Reference

Tiled scene data request. More...

#include <qgstiledscenerequest.h>

Public Member Functions
	QgsTiledSceneRequest ()
QgsFeedback *	feedback () const
	Returns the feedback object that can be queried regularly by the request to check if it should be canceled, if set. More...
QgsOrientedBox3D	filterBox () const
	Returns the box from which data will be taken. More...
Qgis::TiledSceneRequestFlags	flags () const
	Returns the flags which affect how tiles are fetched. More...
long long	parentTileId () const
	Returns the parent tile ID, if filtering is limited to children of a specific tile. More...
double	requiredGeometricError () const
	Returns the required geometric error threshold for the returned tiles, in scene CRS units. More...
void	setFeedback (QgsFeedback *feedback)
	Attach a feedback object that can be queried regularly by the request to check if it should be canceled. More...
void	setFilterBox (const QgsOrientedBox3D &box)
	Sets the box from which data will be taken. More...
void	setFlags (Qgis::TiledSceneRequestFlags flags)
	Sets flags that affect how tiles will be fetched. More...
void	setParentTileId (long long id)
	Sets the parent tile id, if filtering is to be limited to children of a specific tile. More...
void	setRequiredGeometricError (double error)
	Sets the required geometric error threshold for the returned tiles, in scene CRS units. More...

Detailed Description

Tiled scene data request.

Since

QGIS 3.34

Definition at line 37 of file qgstiledscenerequest.h.

Constructor & Destructor Documentation

QgsTiledSceneRequest()

QgsTiledSceneRequest::QgsTiledSceneRequest ( )

default

Member Function Documentation

feedback()

QgsFeedback * QgsTiledSceneRequest::feedback

(

)

const

Returns the feedback object that can be queried regularly by the request to check if it should be canceled, if set.

See also

setFeedback()

Definition at line 29 of file qgstiledscenerequest.cpp.

filterBox()

QgsOrientedBox3D QgsTiledSceneRequest::filterBox ( ) const

inline

Returns the box from which data will be taken.

If the returned box is null, then no filter box is set.

See also

setFilterBox()

Definition at line 64 of file qgstiledscenerequest.h.

flags()

Qgis::TiledSceneRequestFlags QgsTiledSceneRequest::flags ( ) const

inline

Returns the flags which affect how tiles are fetched.

See also

setFlags()

Definition at line 55 of file qgstiledscenerequest.h.

parentTileId()

long long QgsTiledSceneRequest::parentTileId ( ) const

inline

Returns the parent tile ID, if filtering is limited to children of a specific tile.

Returns -1 if no parent tile ID filtering is to be made.

See also

setParentTileId()

Definition at line 121 of file qgstiledscenerequest.h.

requiredGeometricError()

double QgsTiledSceneRequest::requiredGeometricError ( ) const

inline

Returns the required geometric error threshold for the returned tiles, in scene CRS units.

If the error is 0 then no geometric error filtering will be applied.

See also

setRequiredGeometricError()

Definition at line 83 of file qgstiledscenerequest.h.

setFeedback()

void QgsTiledSceneRequest::setFeedback

(

QgsFeedback *

feedback

)

Attach a feedback object that can be queried regularly by the request to check if it should be canceled.

Ownership of feedback is NOT transferred, and the caller must take care that it exists for the lifetime of the request.

See also

feedback()

Definition at line 24 of file qgstiledscenerequest.cpp.

setFilterBox()

void QgsTiledSceneRequest::setFilterBox ( const QgsOrientedBox3D &  box )

inline

Sets the box from which data will be taken.

An null box removes the filter.

See also

filterBox()

Definition at line 73 of file qgstiledscenerequest.h.

setFlags()

void QgsTiledSceneRequest::setFlags ( Qgis::TiledSceneRequestFlags  flags )

inline

Sets flags that affect how tiles will be fetched.

See also

flags()

Definition at line 48 of file qgstiledscenerequest.h.

setParentTileId()

void QgsTiledSceneRequest::setParentTileId ( long long  id )

inline

Sets the parent tile id, if filtering is to be limited to children of a specific tile.

Set to -1 if no parent tile ID filtering is to be made.

See also

parentTileId()

Definition at line 130 of file qgstiledscenerequest.h.

setRequiredGeometricError()

void QgsTiledSceneRequest::setRequiredGeometricError ( double  error )

inline

Sets the required geometric error threshold for the returned tiles, in scene CRS units.

If the error is 0 then no geometric error filtering will be applied.

See also

requiredGeometricError()

Definition at line 93 of file qgstiledscenerequest.h.

---

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

• /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/tiledscene/qgstiledscenerequest.h
• /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/tiledscene/qgstiledscenerequest.cpp