Skip to content

Commit

Permalink
Fix doc comments to align with code
Browse files Browse the repository at this point in the history
The only previously implemented provider of these classes (for Cesium 3D
tiles) used values directly from the tiles, which are in meters per
spec.
  • Loading branch information
dvdkon committed Jul 23, 2024
1 parent 7cb764e commit 342e040
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ An null ``box`` removes the filter.

double requiredGeometricError() const;
%Docstring
Returns the required geometric error threshold for the returned tiles, in
scene CRS units.
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.

Expand All @@ -70,8 +70,8 @@ If the error is 0 then no geometric error filtering will be applied.

void setRequiredGeometricError( double error );
%Docstring
Sets the required geometric ``error`` threshold for the returned tiles, in
scene CRS units.
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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,16 +121,16 @@ Sets the ``resources`` ``attached`` to the tile.

double geometricError() const;
%Docstring
Returns the tile's geometric error, which is the error, in scene CRS units, of the tile's
simplified representation of its source geometry.
Returns the tile's geometric error, which is the error, in meters, of
the tile's simplified representation of its source geometry.

.. seealso:: :py:func:`setGeometricError`
%End

void setGeometricError( double error );
%Docstring
Sets the tile's geometric ``error``, which is the error, in scene CRS units, of the tile's
simplified representation of its source geometry.
Sets the tile's geometric ``error``, which is the error, in meters, of
the tile's simplified representation of its source geometry.

.. seealso:: :py:func:`geometricError`
%End
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ An null ``box`` removes the filter.

double requiredGeometricError() const;
%Docstring
Returns the required geometric error threshold for the returned tiles, in
scene CRS units.
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.

Expand All @@ -70,8 +70,8 @@ If the error is 0 then no geometric error filtering will be applied.

void setRequiredGeometricError( double error );
%Docstring
Sets the required geometric ``error`` threshold for the returned tiles, in
scene CRS units.
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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,16 +121,16 @@ Sets the ``resources`` ``attached`` to the tile.

double geometricError() const;
%Docstring
Returns the tile's geometric error, which is the error, in scene CRS units, of the tile's
simplified representation of its source geometry.
Returns the tile's geometric error, which is the error, in meters, of
the tile's simplified representation of its source geometry.

.. seealso:: :py:func:`setGeometricError`
%End

void setGeometricError( double error );
%Docstring
Sets the tile's geometric ``error``, which is the error, in scene CRS units, of the tile's
simplified representation of its source geometry.
Sets the tile's geometric ``error``, which is the error, in meters, of
the tile's simplified representation of its source geometry.

.. seealso:: :py:func:`geometricError`
%End
Expand Down
8 changes: 4 additions & 4 deletions src/core/tiledscene/qgstiledscenerequest.h
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ class CORE_EXPORT QgsTiledSceneRequest
void setFilterBox( const QgsOrientedBox3D &box ) { mFilterBox = box; }

/**
* Returns the required geometric error threshold for the returned tiles, in
* scene CRS units.
* 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.
*
Expand All @@ -83,8 +83,8 @@ class CORE_EXPORT QgsTiledSceneRequest
double requiredGeometricError() const { return mRequiredGeometricError; }

/**
* Sets the required geometric \a error threshold for the returned tiles, in
* scene CRS units.
* Sets the required geometric \a error threshold for the returned tiles,
* in meters.
*
* If the \a error is 0 then no geometric error filtering will be applied.
*
Expand Down
8 changes: 4 additions & 4 deletions src/core/tiledscene/qgstiledscenetile.h
Original file line number Diff line number Diff line change
Expand Up @@ -133,16 +133,16 @@ class CORE_EXPORT QgsTiledSceneTile
void setResources( const QVariantMap &resources );

/**
* Returns the tile's geometric error, which is the error, in scene CRS units, of the tile's
* simplified representation of its source geometry.
* Returns the tile's geometric error, which is the error, in meters, of
* the tile's simplified representation of its source geometry.
*
* \see setGeometricError()
*/
double geometricError() const { return mGeometricError; }

/**
* Sets the tile's geometric \a error, which is the error, in scene CRS units, of the tile's
* simplified representation of its source geometry.
* Sets the tile's geometric \a error, which is the error, in meters, of
* the tile's simplified representation of its source geometry.
*
* \see geometricError()
*/
Expand Down

0 comments on commit 342e040

Please sign in to comment.