Skip to content
Permalink
Browse files

[sipify] Fix creation of cross references

  • Loading branch information
nyalldawson committed Jun 15, 2020
1 parent e653711 commit 81a9db9f57706cba9b11e4372dd1bf50fcd7bc6a
Showing 376 changed files with 1,809 additions and 1,872 deletions.
@@ -42,15 +42,15 @@ Copy constructor

void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
%Docstring
Reads configuration from a DOM element previously written by writeXml()
Reads configuration from a DOM element previously written by :py:func:`~Qgs3DMapSettings.writeXml`
%End
QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
%Docstring
Writes configuration to a DOM element, to be used later with readXml()
Writes configuration to a DOM element, to be used later with :py:func:`~Qgs3DMapSettings.readXml`
%End
void resolveReferences( const QgsProject &project );
%Docstring
Resolves references to other objects (map layers) after the call to readXml()
Resolves references to other objects (map layers) after the call to :py:func:`~Qgs3DMapSettings.readXml`
%End

void setOrigin( const QgsVector3D &origin );
@@ -201,7 +201,7 @@ Sets resolution (in pixels) of the texture of a terrain tile
int mapTileResolution() const;
%Docstring
Returns resolution (in pixels) of the texture of a terrain tile. This parameter influences
how many zoom levels for terrain tiles there will be (together with maxTerrainGroundError())
how many zoom levels for terrain tiles there will be (together with :py:func:`~Qgs3DMapSettings.maxTerrainGroundError`)
%End

void setMaxTerrainScreenError( float error );
@@ -230,7 +230,7 @@ Returns maximum ground error of terrain tiles in world units.
float maxTerrainGroundError() const;
%Docstring
Returns maximum ground error of terrain tiles in world units. This parameter influences
how many zoom levels there will be (together with mapTileResolution()).
how many zoom levels there will be (together with :py:func:`~Qgs3DMapSettings.mapTileResolution`).
This value tells that when the given ground error is reached (e.g. 10 meters), it makes no sense
to further split terrain tiles into finer ones because they will not add extra details anymore.
%End
@@ -266,7 +266,7 @@ Sets terrain shading material.
QgsPhongMaterialSettings terrainShadingMaterial() const;
%Docstring
Returns terrain shading material. Diffuse color component is ignored since the diffuse component
is provided by 2D rendered map texture. Only used when isTerrainShadingEnabled() is ``True``.
is provided by 2D rendered map texture. Only used when :py:func:`~Qgs3DMapSettings.isTerrainShadingEnabled` is ``True``.

.. versionadded:: 3.6
%End
@@ -287,7 +287,7 @@ Empty map theme name means that the map theme is not overridden and the current

.. note::

Support for map themes only works if mapThemeCollection() is a valid object (otherwise it is not possible to resolve map themes from names)
Support for map themes only works if :py:func:`~Qgs3DMapSettings.mapThemeCollection` is a valid object (otherwise it is not possible to resolve map themes from names)

.. versionadded:: 3.6
%End
@@ -315,11 +315,11 @@ Returns whether skybox is enabled
%End
QString skyboxFileBase() const;
%Docstring
Returns base part of filenames of skybox (see setSkybox())
Returns base part of filenames of skybox (see :py:func:`~Qgs3DMapSettings.setSkybox`)
%End
QString skyboxFileExtension() const;
%Docstring
Returns extension part of filenames of skybox (see setSkybox())
Returns extension part of filenames of skybox (see :py:func:`~Qgs3DMapSettings.setSkybox`)
%End

void setShowTerrainBoundingBoxes( bool enabled );
@@ -38,7 +38,7 @@ of tiles.

void setZoomLevelsCount( int count );
%Docstring
Sets number of zoom levels. See zoomLevelsCount() documentation for more details.
Sets number of zoom levels. See :py:func:`~QgsVectorLayer3DTilingSettings.zoomLevelsCount` documentation for more details.
%End

void setShowBoundingBoxes( bool enabled );
@@ -72,7 +72,7 @@ Writes configuration to a new DOM element and returns it
%End
void readXml( const QDomElement &elem );
%Docstring
Reads configuration from a DOM element previously written using writeXml()
Reads configuration from a DOM element previously written using :py:func:`~QgsCameraPose.writeXml`
%End

bool operator==( const QgsCameraPose &other ) const;
@@ -86,7 +86,7 @@ Returns map scene. May be ``None`` if not yet configured.

void assignFreeId();
%Docstring
Sets the map id() to a number not yet used in the layout. The existing id() is kept if it is not in use.
Sets the map :py:func:`~QgsLayoutItem3DMap.id` to a number not yet used in the layout. The existing :py:func:`~QgsLayoutItem3DMap.id` is kept if it is not in use.
%End

virtual QString displayName() const;
@@ -92,7 +92,7 @@ Writes configuration to a new DOM element and returns it
%End
void readXml( const QDomElement &elem );
%Docstring
Reads configuration from a DOM element previously written using writeXml()
Reads configuration from a DOM element previously written using :py:func:`~QgsPointLightSettings.writeXml`
%End

bool operator==( const QgsPointLightSettings &other );
@@ -44,7 +44,7 @@ Ownership of ``feedback`` is not transferred and callers must ensure that it exi
%Docstring
Returns the fields output by features when saving the triangulation.
These fields should be used when creating
a suitable feature sink for setTriangulationSink()
a suitable feature sink for :py:func:`~QgsTinInterpolator.setTriangulationSink`

.. seealso:: :py:func:`setTriangulationSink`

@@ -56,7 +56,7 @@ a suitable feature sink for setTriangulationSink()
Sets the optional ``sink`` for saving the triangulation features.

The sink must be setup to accept LineString features, with fields matching
those returned by triangulationFields().
those returned by :py:func:`~QgsTinInterpolator.triangulationFields`.

.. seealso:: :py:func:`triangulationFields`

@@ -220,7 +220,7 @@ See the other variant for details.
%Docstring
Determine destination extent from the input rasters and calculate derived values

:return: ``True`` on success, sets error on error (see errorMessage())
:return: ``True`` on success, sets error on error (see :py:func:`~QgsAlignRaster.errorMessage`)
%End

QSize alignedRasterSize() const;
@@ -229,7 +229,7 @@ Returns the expected size of the resulting aligned raster

.. note::

first need to run checkInputParameters() which returns with success
first need to run :py:func:`~QgsAlignRaster.checkInputParameters` which returns with success
%End

QgsRectangle alignedRasterExtent() const;
@@ -238,20 +238,20 @@ Returns the expected extent of the resulting aligned raster

.. note::

first need to run checkInputParameters() which returns with success
first need to run :py:func:`~QgsAlignRaster.checkInputParameters` which returns with success
%End

bool run();
%Docstring
Run the alignment process

:return: ``True`` on success, sets error on error (see errorMessage())
:return: ``True`` on success, sets error on error (see :py:func:`~QgsAlignRaster.errorMessage`)
%End

QString errorMessage() const;
%Docstring
Returns the error from a previous run() call.
Error message is empty if run() succeeded (returned ``True``)
Returns the error from a previous :py:func:`~QgsAlignRaster.run` call.
Error message is empty if :py:func:`~QgsAlignRaster.run` succeeded (returned ``True``)
%End

void dump() const;
@@ -77,13 +77,13 @@ to generate the surface. The output path and file format are also required.
Result run();
%Docstring
Runs the KDE calculation across the whole layer at once. Either call this method, or manually
call run(), addFeature() and finalise() separately.
call :py:func:`~QgsKernelDensityEstimation.run`, :py:func:`~QgsKernelDensityEstimation.addFeature` and :py:func:`~QgsKernelDensityEstimation.finalise` separately.
%End

Result prepare();
%Docstring
Prepares the output file for writing and setups up the surface calculation. This must be called
before adding features via addFeature().
before adding features via :py:func:`~QgsKernelDensityEstimation.addFeature`.

.. seealso:: :py:func:`addFeature`

@@ -92,7 +92,7 @@ before adding features via addFeature().

Result addFeature( const QgsFeature &feature );
%Docstring
Adds a single feature to the KDE surface. prepare() must be called before adding features.
Adds a single feature to the KDE surface. :py:func:`~QgsKernelDensityEstimation.prepare` must be called before adding features.

.. seealso:: :py:func:`prepare`

@@ -101,7 +101,7 @@ Adds a single feature to the KDE surface. prepare() must be called before adding

Result finalise();
%Docstring
Finalises the output file. Must be called after adding all features via addFeature().
Finalises the output file. Must be called after adding all features via :py:func:`~QgsKernelDensityEstimation.addFeature`.

.. seealso:: :py:func:`prepare`

@@ -152,7 +152,7 @@ Starts the calculation and writes a new raster.
The optional ``feedback`` argument can be used for progress reporting and cancellation support.

:return: QgsRasterCalculator.Success in case of success. If an error is encountered then
a description of the error can be obtained by calling lastError().
a description of the error can be obtained by calling :py:func:`~QgsRasterCalculator.lastError`.
%End

QString lastError() const;
@@ -82,7 +82,7 @@ The coordinate reference system of this layer.
%Docstring
Returns the name of the layer.

Should be preferred over layer().name() because it can directly be run on
Should be preferred over :py:func:`~QgsFeaturePool.layer`.name() because it can directly be run on
the background thread.
%End

@@ -27,32 +27,15 @@ Writing the check
A new subclass of QgsGeometryCheck needs to be written and at least the following
abstract methods need to be implemented:

- `compatibleGeometryTypes()`

A list of geometry types to which this check applies

- `resolutionMethods()`

A list of names for (automated) resolution methods that can be used to fix errors of this type

- `description()`

A description for the geometry check.

- `id()`

A unique id for this check.

- `checkType()`

One of QgsGeometryCheck.LayerCheck, QgsGeometryCheck.FeatureCheck,QgsGeometryCheck.FeatureNodeCheck

- \link collectErrors() `collectErrors(featurePools, errors, messages, feedback, ids)`\endlink

This method will be called to validate geometries. All geometries which should be validated are passed
into this method with the parameter ids and should be retrieved from the available featurePools to make
use of caching. New errors should be appended to the error list and other message strings to messages.
The method needs to return a tuple (errors, messages).
- :py:func:`~compatibleGeometryTypes`: A list of geometry types to which this check applies
- :py:func:`~resolutionMethods`: A list of names for (automated) resolution methods that can be used to fix errors of this type
- :py:func:`~description`: A description for the geometry check.
- :py:func:`~id`: A unique id for this check.
- :py:func:`~checkType`: One of QgsGeometryCheck.LayerCheck, QgsGeometryCheck.FeatureCheck,QgsGeometryCheck.FeatureNodeCheck
- :py:func:`~collectErrors`: This method will be called to validate geometries. All geometries which should be validated are passed
into this method with the parameter ids and should be retrieved from the available featurePools to make
use of caching. New errors should be appended to the error list and other message strings to messages.
The method needs to return a tuple (errors, messages).

Creating a geometry check factory
---------------------------------
@@ -64,30 +47,13 @@ instances are created and used in parallel.
A new subclass of QgsGeometryCheckFactory needs to be written and at least the following
abstract methods need to be implemented:

- \link QgsGeometryCheckFactory.createGeometryCheck() `createGeometryCheck(context, configuration)`\endlink

Needs to return a new subclassed QgsGeometryCheck object that has been written in the previous step.

- \link QgsGeometryCheckFactory.id() `id()\endlink

A unique id for this geometry check.

- \link QgsGeometryCheckFactory.description() `description()\endlink

A description for this geometry check that can be presented to the user for more explanation.

- \link QgsGeometryCheckFactory.isCompatible() `QgsGeometryCheckFactory.isCompatible(layer)`\endlink

Returns a boolean that determines if this check is available for a given layer. This often
checks for the geometry type of the layer.

- \link QgsGeometryCheckFactory.flags() `flags()`\endlink

Returns additional flags for a geometry check. If unsure return QgsGeometryCheck.AvailableInValidation.

- \link QgsGeometryCheckFactory.checkType() `checkType()`\endlink

Returns the type of this geometry check.
- :py:func:`QgsGeometryCheckFactory.createGeometryCheck()`: Needs to return a new subclassed QgsGeometryCheck object that has been written in the previous step.
- :py:func:`QgsGeometryCheckFactory.id()`: A unique id for this geometry check.
- :py:func:`QgsGeometryCheckFactory.description()`: A description for this geometry check that can be presented to the user for more explanation.
- :py:func:`QgsGeometryCheckFactory.isCompatible()`: Returns a boolean that determines if this check is available for a given layer. This often
checks for the geometry type of the layer.
- :py:func:`QgsGeometryCheckFactory.flags()`: Returns additional flags for a geometry check. If unsure return QgsGeometryCheck.AvailableInValidation.
- :py:func:`QgsGeometryCheckFactory.checkType()`: Returns the type of this geometry check.

Registering the geometry check
------------------------------
@@ -17,7 +17,7 @@ class QgsGeometryCheckRegistry
This class manages all known geometry check factories.

QgsGeometryCheckRegistry is not usually directly created, but rather accessed through
:py:func:`QgsAnalysis.geometryCheckRegistry()`
:py:func:`QgsAnalysis.geometryCheckRegistry()`.

.. note::

@@ -34,7 +34,7 @@ QgsGeometryCheckRegistry is not usually directly created, but rather accessed th
QgsGeometryCheckRegistry();
%Docstring
Constructor for QgsGeometryCheckRegistry. QgsGeometryCheckRegistry is not usually directly created, but rather accessed through
:py:func:`QgsAnalysis.geometryCheckRegistry()`
:py:func:`QgsAnalysis.geometryCheckRegistry()`.
%End

~QgsGeometryCheckRegistry();
@@ -53,7 +53,7 @@ is specified in the layer units for the reference layer.
QgsFeatureList snapFeatures( const QgsFeatureList &features, double snapTolerance, SnapMode mode = PreferNodes );
%Docstring
Snaps a set of features to the reference layer and returns the result. This operation is
multithreaded for performance. The featureSnapped() signal will be emitted each time a feature
multithreaded for performance. The :py:func:`~QgsGeometrySnapper.featureSnapped` signal will be emitted each time a feature
is processed. The snap tolerance is specified in the layer units for the reference layer.
%End

@@ -66,7 +66,7 @@ Snaps a single geometry against a list of reference geometries.

void featureSnapped();
%Docstring
Emitted each time a feature has been processed when calling snapFeatures()
Emitted each time a feature has been processed when calling :py:func:`~QgsGeometrySnapper.snapFeatures`
%End

};
@@ -78,11 +78,11 @@ class QgsInternalGeometrySnapper
QgsInternalGeometrySnapper allows a set of geometries to be snapped to each other. It can be used to close gaps in layers.

To use :py:class:`QgsInternalGeometrySnapper`, first construct the snapper using the desired snap parameters. Then,
features are fed to to the snapper one-by-one by calling snapFeature(). Each feature passed by calling
snapFeature() will be snapped to any features which have already been processed by the snapper.
features are fed to to the snapper one-by-one by calling :py:func:`~QgsGeometrySnapper.snapFeature`. Each feature passed by calling
:py:func:`~QgsGeometrySnapper.snapFeature` will be snapped to any features which have already been processed by the snapper.

After processing all desired features, the results can be fetched by calling snappedGeometries().
The returned QgsGeometryMap can be passed to QgsVectorDataProvider.changeGeometryValues() to save
After processing all desired features, the results can be fetched by calling :py:func:`~QgsGeometrySnapper.snappedGeometries`.
The returned QgsGeometryMap can be passed to :py:func:`QgsVectorDataProvider.changeGeometryValues()` to save
the snapped geometries back to the source layer.

.. versionadded:: 3.0
@@ -102,7 +102,7 @@ how geometries will be snapped by the snapper.
QgsGeometry snapFeature( const QgsFeature &feature );
%Docstring
Snaps a single feature's geometry against all feature geometries already processed by
calls to snapFeature() in this object, and returns the snapped geometry.
calls to :py:func:`~QgsInternalGeometrySnapper.snapFeature` in this object, and returns the snapped geometry.
%End

QgsGeometryMap snappedGeometries() const;
@@ -1,5 +1,5 @@
# The following has been generated automatically from src/core/qgsmapsettingsutils.h
# monkey patching scoped based enum
QgsMapSettingsUtils.EffectsCheckFlag.IgnoreGeoPdfSupportedEffects.__doc__ = "Ignore advanced effects which are supported in GeoPDF exports"
QgsMapSettingsUtils.EffectsCheckFlag.__doc__ = 'Flags for controlling the behavior of containsAdvancedEffects()\n\n.. versionadded:: 3.14\n\n' + '* ``IgnoreGeoPdfSupportedEffects``: ' + QgsMapSettingsUtils.EffectsCheckFlag.IgnoreGeoPdfSupportedEffects.__doc__
QgsMapSettingsUtils.EffectsCheckFlag.__doc__ = 'Flags for controlling the behavior of :py:func:`~QgsMapSettingsUtils.containsAdvancedEffects`\n\n.. versionadded:: 3.14\n\n' + '* ``IgnoreGeoPdfSupportedEffects``: ' + QgsMapSettingsUtils.EffectsCheckFlag.IgnoreGeoPdfSupportedEffects.__doc__
# --
@@ -51,7 +51,7 @@ Constructor of the base class
class Qgs3DRendererRegistry
{
%Docstring
Keeps track of available 3D renderers. Should be accessed through QgsApplication.renderer3DRegistry() singleton.
Keeps track of available 3D renderers. Should be accessed through :py:func:`QgsApplication.renderer3DRegistry()` singleton.

.. versionadded:: 3.0
%End
@@ -16,7 +16,7 @@ class QgsAbstract3DRenderer /Abstract/
%Docstring
Base class for all renderers that may to participate in 3D view.

3D renderers implement the method createEntity() that returns a new 3D entity - that entity
3D renderers implement the method :py:func:`~createEntity` that returns a new 3D entity - that entity
will be added to the 3D scene to represent data in renderer's display style.

Renderers may store some custom properties (e.g. materials, sizes) that are written to and read from
@@ -50,7 +50,7 @@ Reads renderer's properties from given XML element
%End
virtual void resolveReferences( const QgsProject &project );
%Docstring
Resolves references to other objects - second phase of loading - after readXml()
Resolves references to other objects - second phase of loading - after :py:func:`~QgsAbstract3DRenderer.readXml`
%End

protected:

0 comments on commit 81a9db9

Please sign in to comment.
You can’t perform that action at this time.