QgsCadUtils::AlignMapPointContext Class Reference

Defines constraints for the QgsCadUtils::alignMapPoint() method. More...

#include <qgscadutils.h>

Public Member Functions
QgsPoint	cadPoint (int index) const
	Returns the recent CAD point at the specified index (in map coordinates).
QList< QgsPoint >	cadPoints () const
	Returns the list of recent CAD points in map coordinates.
void	dump () const
	Dumps the context's properties, for debugging.
QQueue< QgsPointLocator::Match >	lockedSnapVertices () const
	Returns the queue of point locator matches that contain the locked vertices.
void	setCadPoint (int index, const QgsPoint &point)
	Sets the recent CAD point at the specified index to point (in map coordinates).
void	setCadPoints (const QList< QgsPoint > &points)
	Sets the list of recent CAD points (in map coordinates).
void	setLockedSnapVertices (const QQueue< QgsPointLocator::Match > &lockedSnapVertices)
	Sets the queue of locked vertices.

Public Attributes
QgsCadUtils::AlignMapPointConstraint	angleConstraint
	Constraint for angle.
QgsCadUtils::AlignMapPointConstraint	commonAngleConstraint
	Constraint for soft lock to a common angle.
QgsCadUtils::AlignMapPointConstraint	distanceConstraint
	Constraint for distance.
QgsCadUtils::AlignMapPointConstraint	lineExtensionConstraint
double	mapUnitsPerPixel
	Map units/pixel ratio from map canvas.
QgsCadUtils::AlignMapPointConstraint	mConstraint
	Constraint for M coordinate.
bool	snappingToFeaturesOverridesCommonAngle = false
	Flag to set snapping to features priority over common angle.
QgsSnappingUtils *	snappingUtils = nullptr
	Snapping utils that will be used to snap point to map. Must not be nullptr.
QgsCadUtils::AlignMapPointConstraint	xConstraint
	Constraint for X coordinate.
QgsCadUtils::AlignMapPointConstraint	xyVertexConstraint
QgsCadUtils::AlignMapPointConstraint	yConstraint
	Constraint for Y coordinate.
QgsCadUtils::AlignMapPointConstraint	zConstraint
	Constraint for Z coordinate.

Detailed Description

Defines constraints for the QgsCadUtils::alignMapPoint() method.

Definition at line 99 of file qgscadutils.h.

Member Function Documentation

cadPoint()

QgsPoint QgsCadUtils::AlignMapPointContext::cadPoint ( int  index ) const

inline

Returns the recent CAD point at the specified index (in map coordinates).

See also

setCadPoint()

Since

QGIS 3.22

Definition at line 178 of file qgscadutils.h.

cadPoints()

QList< QgsPoint > QgsCadUtils::AlignMapPointContext::cadPoints ( ) const

inline

Returns the list of recent CAD points in map coordinates.

These are used to turn relative constraints to absolute. The first point is the most recent point.

See also

setCadPoints()

Since

QGIS 3.22

Definition at line 154 of file qgscadutils.h.

dump()

void QgsCadUtils::AlignMapPointContext::dump

(

)

const

Dumps the context's properties, for debugging.

Note

Not available in Python bindings.

Definition at line 513 of file qgscadutils.cpp.

lockedSnapVertices()

QQueue< QgsPointLocator::Match > QgsCadUtils::AlignMapPointContext::lockedSnapVertices ( ) const

inline

Returns the queue of point locator matches that contain the locked vertices.

See also

setLockedSnapVertices()

Since

QGIS 3.26

Definition at line 196 of file qgscadutils.h.

setCadPoint()

void QgsCadUtils::AlignMapPointContext::setCadPoint ( int  index, const QgsPoint &  point  )

inline

Sets the recent CAD point at the specified index to point (in map coordinates).

See also

cadPoint()

Since

QGIS 3.22

Definition at line 170 of file qgscadutils.h.

setCadPoints()

void QgsCadUtils::AlignMapPointContext::setCadPoints ( const QList< QgsPoint > &  points )

inline

Sets the list of recent CAD points (in map coordinates).

See also

cadPoints()

Since

QGIS 3.22

Definition at line 162 of file qgscadutils.h.

setLockedSnapVertices()

void QgsCadUtils::AlignMapPointContext::setLockedSnapVertices ( const QQueue< QgsPointLocator::Match > &  lockedSnapVertices )

inline

Sets the queue of locked vertices.

Point locator matches are stored instead of vertices to keep more context.

See also

lockedSnapVertices()

Since

QGIS 3.26

Definition at line 188 of file qgscadutils.h.

Member Data Documentation

angleConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::angleConstraint

Constraint for angle.

Definition at line 126 of file qgscadutils.h.

commonAngleConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::commonAngleConstraint

Constraint for soft lock to a common angle.

Definition at line 128 of file qgscadutils.h.

distanceConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::distanceConstraint

Constraint for distance.

Definition at line 124 of file qgscadutils.h.

lineExtensionConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::lineExtensionConstraint

Definition at line 130 of file qgscadutils.h.

mapUnitsPerPixel

double QgsCadUtils::AlignMapPointContext::mapUnitsPerPixel

Map units/pixel ratio from map canvas.

Definition at line 105 of file qgscadutils.h.

mConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::mConstraint

Constraint for M coordinate.

Since

QGIS 3.22

Definition at line 122 of file qgscadutils.h.

snappingToFeaturesOverridesCommonAngle

bool QgsCadUtils::AlignMapPointContext::snappingToFeaturesOverridesCommonAngle = false

Flag to set snapping to features priority over common angle.

Since

QGIS 3.32

Definition at line 137 of file qgscadutils.h.

snappingUtils

QgsSnappingUtils* QgsCadUtils::AlignMapPointContext::snappingUtils = nullptr

Snapping utils that will be used to snap point to map. Must not be nullptr.

Definition at line 103 of file qgscadutils.h.

xConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::xConstraint

Constraint for X coordinate.

Definition at line 108 of file qgscadutils.h.

xyVertexConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::xyVertexConstraint

Definition at line 131 of file qgscadutils.h.

yConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::yConstraint

Constraint for Y coordinate.

Definition at line 110 of file qgscadutils.h.

zConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::zConstraint

Constraint for Z coordinate.

Since

QGIS 3.22

Definition at line 116 of file qgscadutils.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/qgscadutils.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/qgscadutils.cpp