Skip to content
Permalink
Browse files

doxymentation

  • Loading branch information
3nids committed Oct 26, 2018
1 parent f002a9c commit 9e6d165861ab3330a6715296755eabe6b352d54b
@@ -221,31 +221,35 @@ construction mode is used to draw intermediate points. These points won't be giv

AdditionalConstraint additionalConstraint() const;
%Docstring
Additional constraints are used to place perpendicular/parallel segments to snapped segments on the canvas
Returns the additional constraints which are used to place
perpendicular/parallel segments to snapped segments on the canvas
%End
const CadConstraint *constraintAngle() const;
%Docstring
Constraint on the angle
Returns the ``CadConstraint`` on the angle
%End
const CadConstraint *constraintDistance() const;
%Docstring
Constraint on the distance
Returns the ``CadConstraint`` on the distance
%End
const CadConstraint *constraintX() const;
%Docstring
Constraint on the X coordinate
Returns the ``CadConstraint`` on the X coordinate
%End
const CadConstraint *constraintY() const;
%Docstring
Constraint on the Y coordinate
Retruns the ``CadConstraint`` on the Y coordinate
%End
bool commonAngleConstraint() const;
%Docstring
Constraint on a common angle
Returns true if a constraint on a common angle is active
%End

QgsPointLocator::Match mapPointMatch() const;
%Docstring
SnapMatch for indicator
Returns the point locator match

.. versionadded:: 3.4
%End

void clearPoints();
@@ -244,19 +244,26 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private
//! construction mode is used to draw intermediate points. These points won't be given any further (i.e. to the map tools)
bool constructionMode() const { return mConstructionMode; }

//! Additional constraints are used to place perpendicular/parallel segments to snapped segments on the canvas
/**
* Returns the additional constraints which are used to place
* perpendicular/parallel segments to snapped segments on the canvas
*/
AdditionalConstraint additionalConstraint() const { return mAdditionalConstraint; }
//! Constraint on the angle
//! Returns the \a CadConstraint on the angle
const CadConstraint *constraintAngle() const { return mAngleConstraint.get(); }
//! Constraint on the distance
//! Returns the \a CadConstraint on the distance
const CadConstraint *constraintDistance() const { return mDistanceConstraint.get(); }
//! Constraint on the X coordinate
//! Returns the \a CadConstraint on the X coordinate
const CadConstraint *constraintX() const { return mXConstraint.get(); }
//! Constraint on the Y coordinate
//! Retruns the \a CadConstraint on the Y coordinate
const CadConstraint *constraintY() const { return mYConstraint.get(); }
//! Constraint on a common angle
//! Returns true if a constraint on a common angle is active
bool commonAngleConstraint() const { return !qgsDoubleNear( mCommonAngleConstraint, 0.0 ); }
//! SnapMatch for indicator

/**
* Returns the point locator match
* \since QGIS 3.4
*/
QgsPointLocator::Match mapPointMatch() const { return mSnapMatch; }

/**

2 comments on commit 9e6d165

@jef-n

This comment has been minimized.

Copy link
Member

@jef-n jef-n replied Oct 26, 2018

It's past 12:00 UTC!

@3nids

This comment has been minimized.

Copy link
Member Author

@3nids 3nids replied Oct 26, 2018

well, if it misses 3.4 no big deal, it'll be backported.

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