sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-14 00:07:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Rewriting documentation

Browse Source
This commit is contained in:
lbartoletti 2019-08-06 09:22:00 +02:00 committed by Nyall Dawson
parent 2354065e90
commit 03f48bdbd8
5 changed files with 22 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
python/core/auto_generated/qgsvectorlayereditutils.sip.in
View File

@ -182,25 +182,21 @@ Adds topological points for every vertex of the geometry.
int addTopologicalPoints( const QgsPointXY &p );
%Docstring
Adds a vertex to segments which intersect point p but don't
Adds a vertex to segments which intersect point ``p`` but don't
already have a vertex there. If a feature already has a vertex at position p,
no additional vertex is inserted. This method is useful for topological
editing.
:param p: position of the vertex
:return: 0 in case of success
%End
int addTopologicalPoints( const QgsPoint &p );
%Docstring
Adds a vertex to segments which intersect point p but don't
Adds a vertex to segments which intersect point ``p`` but don't
already have a vertex there. If a feature already has a vertex at position p,
no additional vertex is inserted. This method is useful for topological
editing.
:param p: position of the vertex
:return: 0 in case of success
.. versionadded:: 3.10

14
python/gui/auto_generated/qgsmaptooledit.sip.in
View File

@ -68,18 +68,16 @@ Returns the current vector layer of the map canvas or 0
InvalidLayer,
};
TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &geom );
TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &vertices );
%Docstring
Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
:param geom: list of points (in layer coordinate system)
Adds a list of ``vertices`` to other features to keep topology up to date, e.g. to neighbouring polygons.
The ``vertices`` list specifies a set of topological points to add, in the layer's coordinate reference system.
%End
TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &geom );
TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &vertices );
%Docstring
Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
:param geom: list of points (in layer coordinate system)
Adds a list of ``vertices`` to other features to keep topology up to date, e.g. to neighbouring polygons.
The ``vertices`` list specifies a set of topological points to add, in the layer's coordinate reference system.
.. versionadded:: 3.10
%End

6
src/core/qgsvectorlayereditutils.h
View File

@ -167,21 +167,19 @@ class CORE_EXPORT QgsVectorLayerEditUtils
int addTopologicalPoints( const QgsGeometry &geom );
/**
* Adds a vertex to segments which intersect point p but don't
* Adds a vertex to segments which intersect point \a p but don't
* already have a vertex there. If a feature already has a vertex at position p,
* no additional vertex is inserted. This method is useful for topological
* editing.
* \param p position of the vertex
* \return 0 in case of success
*/
int addTopologicalPoints( const QgsPointXY &p );
/**
* Adds a vertex to segments which intersect point p but don't
* Adds a vertex to segments which intersect point \a p but don't
* already have a vertex there. If a feature already has a vertex at position p,
* no additional vertex is inserted. This method is useful for topological
* editing.
* \param p position of the vertex
* \return 0 in case of success
* \since QGIS 3.10
*/

12
src/gui/qgsmaptooledit.cpp
View File

@ -92,7 +92,7 @@ QgsVectorLayer *QgsMapToolEdit::currentVectorLayer()
}
QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPoint> &geom )
QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPoint> &vertices )
{
if ( !mCanvas )
{
@ -107,15 +107,15 @@ QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QV
return QgsMapToolEdit::InvalidLayer;
}
QVector<QgsPoint>::const_iterator list_it = geom.constBegin();
for ( ; list_it != geom.constEnd(); ++list_it )
QVector<QgsPoint>::const_iterator list_it = vertices.constBegin();
for ( ; list_it != vertices.constEnd(); ++list_it )
{
vlayer->addTopologicalPoints( *list_it );
}
return QgsMapToolEdit::Success;
}
QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPointXY> &geom )
QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPointXY> &vertices )
{
if ( !mCanvas )
{
@ -130,8 +130,8 @@ QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QV
return QgsMapToolEdit::InvalidLayer;
}
QVector<QgsPointXY>::const_iterator list_it = geom.constBegin();
for ( ; list_it != geom.constEnd(); ++list_it )
QVector<QgsPointXY>::const_iterator list_it = vertices.constBegin();
for ( ; list_it != vertices.constEnd(); ++list_it )
{
vlayer->addTopologicalPoints( *list_it );
}

12
src/gui/qgsmaptooledit.h
View File

@ -76,17 +76,17 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool
};
/**
* Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
* \param geom list of points (in layer coordinate system)
* Adds a list of \a vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
* The \a vertices list specifies a set of topological points to add, in the layer's coordinate reference system.
*/
TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &geom );
TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &vertices );
/**
* Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
* \param geom list of points (in layer coordinate system)
* Adds a list of \a vertices to other features to keep topology up to date, e.g. to neighbouring polygons.
* The \a vertices list specifies a set of topological points to add, in the layer's coordinate reference system.
* \since QGIS 3.10
*/
TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &geom );
TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &vertices );
//! Display a timed message bar noting the active layer is not vector.
void notifyNotVectorLayer();