QGIS/python/core/auto_generated/tiledscene/qgstiledscenerequest.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

129 lines
3.4 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/tiledscene/qgstiledscenerequest.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsTiledSceneRequest
{
%Docstring(signature="appended")
Tiled scene data request.
.. versionadded:: 3.34
%End
%TypeHeaderCode
#include "qgstiledscenerequest.h"
%End
public:
QgsTiledSceneRequest();
void setFlags( Qgis::TiledSceneRequestFlags flags );
%Docstring
Sets ``flags`` that affect how tiles will be fetched.
.. seealso:: :py:func:`flags`
%End
Qgis::TiledSceneRequestFlags flags() const;
%Docstring
Returns the flags which affect how tiles are fetched.
.. seealso:: :py:func:`setFlags`
%End
QgsOrientedBox3D filterBox() const;
%Docstring
Returns the box from which data will be taken.
If the returned box is null, then no filter box is set.
.. seealso:: :py:func:`setFilterBox`
%End
void setFilterBox( const QgsOrientedBox3D &box );
%Docstring
Sets the ``box`` from which data will be taken.
An null ``box`` removes the filter.
.. seealso:: :py:func:`filterBox`
%End
double requiredGeometricError() const;
%Docstring
Returns the required geometric error threshold for the returned tiles,
in meters.
If the error is 0 then no geometric error filtering will be applied.
.. seealso:: :py:func:`setRequiredGeometricError`
%End
void setRequiredGeometricError( double error );
%Docstring
Sets the required geometric ``error`` threshold for the returned tiles,
in meters.
If the ``error`` is 0 then no geometric error filtering will be applied.
.. seealso:: :py:func:`requiredGeometricError`
%End
void setFeedback( QgsFeedback *feedback );
%Docstring
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.
.. seealso:: :py:func:`feedback`
%End
QgsFeedback *feedback() const;
%Docstring
Returns the feedback object that can be queried regularly by the request
to check if it should be canceled, if set.
.. seealso:: :py:func:`setFeedback`
%End
long long parentTileId() const;
%Docstring
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.
.. seealso:: :py:func:`setParentTileId`
%End
void setParentTileId( long long id );
%Docstring
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.
.. seealso:: :py:func:`parentTileId`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/tiledscene/qgstiledscenerequest.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/