mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
e453116101
Previously grids would always take precedence when both a grid and guide were within tolerance of a point. Now, guides will always take precedence - since they have been manually set by users we make the assumption that they have been explicitly placed at highly desirable snapping locations, and should be selected over the general grid. Additionally, grid snapping was previously only done if BOTH x and y could be snapped to the grid. We now snap to the nearest grid line for x/y separately. This means if a point is close to a vertical grid line but not a horizontal one it will still snap to that nearby vertical grid line.
118 lines
3.8 KiB
Plaintext
118 lines
3.8 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgslayoutsnapper.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
class QgsLayoutSnapper
|
|
{
|
|
%Docstring
|
|
Manages snapping grids and preset snap lines in a layout, and handles
|
|
snapping points to the nearest grid coordinate/snap line when possible.
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutsnapper.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutSnapper( QgsLayout *layout );
|
|
%Docstring
|
|
Constructor for QgsLayoutSnapper, attached to the specified ``layout``.
|
|
%End
|
|
|
|
void setSnapTolerance( const int snapTolerance );
|
|
%Docstring
|
|
Sets the snap ``tolerance`` (in pixels) to use when snapping.
|
|
.. seealso:: snapTolerance()
|
|
%End
|
|
|
|
int snapTolerance() const;
|
|
%Docstring
|
|
Returns the snap tolerance (in pixels) to use when snapping.
|
|
.. seealso:: setSnapTolerance()
|
|
:rtype: int
|
|
%End
|
|
|
|
bool snapToGrid() const;
|
|
%Docstring
|
|
Returns true if snapping to grid is enabled.
|
|
.. seealso:: setSnapToGrid()
|
|
:rtype: bool
|
|
%End
|
|
|
|
void setSnapToGrid( bool enabled );
|
|
%Docstring
|
|
Sets whether snapping to grid is ``enabled``.
|
|
.. seealso:: snapToGrid()
|
|
%End
|
|
|
|
bool snapToGuides() const;
|
|
%Docstring
|
|
Returns true if snapping to guides is enabled.
|
|
.. seealso:: setSnapToGuides()
|
|
:rtype: bool
|
|
%End
|
|
|
|
void setSnapToGuides( bool enabled );
|
|
%Docstring
|
|
Sets whether snapping to guides is ``enabled``.
|
|
.. seealso:: snapToGuides()
|
|
%End
|
|
|
|
QPointF snapPoint( QPointF point, double scaleFactor, bool &snapped /Out/ ) const;
|
|
%Docstring
|
|
Snaps a layout coordinate ``point``. If ``point`` was snapped, ``snapped`` will be set to true.
|
|
|
|
The ``scaleFactor`` argument should be set to the transformation from
|
|
scalar transform from layout coordinates to pixels, i.e. the
|
|
graphics view transform().m11() value.
|
|
|
|
This method considers snapping to the grid, snap lines, etc.
|
|
:rtype: QPointF
|
|
%End
|
|
|
|
QPointF snapPointToGrid( QPointF point, double scaleFactor, bool &snappedX /Out/, bool &snappedY /Out/ ) const;
|
|
%Docstring
|
|
Snaps a layout coordinate ``point`` to the grid. If ``point``
|
|
was snapped horizontally, ``snappedX`` will be set to true. If ``point``
|
|
was snapped vertically, ``snappedY`` will be set to true.
|
|
|
|
The ``scaleFactor`` argument should be set to the transformation from
|
|
scalar transform from layout coordinates to pixels, i.e. the
|
|
graphics view transform().m11() value.
|
|
|
|
If snapToGrid() is disabled, this method will return the point
|
|
unchanged.
|
|
:rtype: QPointF
|
|
%End
|
|
|
|
double snapPointToGuides( double original, QgsLayoutGuide::Orientation orientation, double scaleFactor, bool &snapped /Out/ ) const;
|
|
%Docstring
|
|
Snaps a layout coordinate ``point`` to the grid. If ``point``
|
|
was snapped, ``snapped`` will be set to true.
|
|
|
|
The ``scaleFactor`` argument should be set to the transformation from
|
|
scalar transform from layout coordinates to pixels, i.e. the
|
|
graphics view transform().m11() value.
|
|
|
|
If snapToGrid() is disabled, this method will return the point
|
|
unchanged.
|
|
:rtype: float
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgslayoutsnapper.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|