QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | Public Attributes | List of all members
QgsCadUtils::AlignMapPointContext Class Reference
core library

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

Public Attributes

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

Detailed Description

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

Since
QGIS 3.0

Definition at line 103 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 176 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 152 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 501 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 194 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 168 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 160 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 186 of file qgscadutils.h.

Member Data Documentation

◆ angleConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::angleConstraint

Constraint for angle.

Definition at line 130 of file qgscadutils.h.

◆ commonAngleConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::commonAngleConstraint

Constraint for soft lock to a common angle.

Definition at line 132 of file qgscadutils.h.

◆ distanceConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::distanceConstraint

Constraint for distance.

Definition at line 128 of file qgscadutils.h.

◆ lineExtensionConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::lineExtensionConstraint

Definition at line 134 of file qgscadutils.h.

◆ mapUnitsPerPixel

double QgsCadUtils::AlignMapPointContext::mapUnitsPerPixel

Map units/pixel ratio from map canvas.

Definition at line 109 of file qgscadutils.h.

◆ mConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::mConstraint

Constraint for M coordinate.

Since
QGIS 3.22

Definition at line 126 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 107 of file qgscadutils.h.

◆ xConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::xConstraint

Constraint for X coordinate.

Definition at line 112 of file qgscadutils.h.

◆ xyVertexConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::xyVertexConstraint

Definition at line 135 of file qgscadutils.h.

◆ yConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::yConstraint

Constraint for Y coordinate.

Definition at line 114 of file qgscadutils.h.

◆ zConstraint

QgsCadUtils::AlignMapPointConstraint QgsCadUtils::AlignMapPointContext::zConstraint

Constraint for Z coordinate.

Since
QGIS 3.22

Definition at line 120 of file qgscadutils.h.

The documentation for this class was generated from the following files:
Generated on Sat Oct 22 2022 16:10:47 for QGIS API Documentation by doxygen 1.9.4