Class: QgsCadUtils

Provides routines for CAD editing.

List of all members, including inherited members

Classes

AlignMapPointConstraint

Structure with details of one constraint.

AlignMapPointContext

Defines constraints for the QgsCadUtils.alignMapPoint() method.

AlignMapPointOutput

Structure returned from alignMapPoint() method.

Static Methods

alignMapPoint

Applies X/Y/angle/distance constraints from the given context to a map point.
class qgis.core.QgsCadUtils[source]

Bases: object

class AlignMapPointConstraint[source]

Bases: object

Structure with details of one constraint.

__init__(locked: bool = False, relative: bool = False, value: float = 0)

Constructor for AlignMapPointConstraint.

Parameters:

  • locked (bool = False)

  • relative (bool = False)

  • value (float = 0)

__init__(a0: QgsCadUtils.AlignMapPointConstraint)
Parameters:

a0 (QgsCadUtils.AlignMapPointConstraint)

locked: bool
relative: bool
value: float
class AlignMapPointContext[source]

Bases: object

Defines constraints for the QgsCadUtils.alignMapPoint() method.

angleConstraint: AlignMapPointConstraint
cadPoint(self, index: int) → QgsPoint[source]

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

See also

setCadPoint()

Added in version 3.22.

Parameters:

index (int)

Return type:

QgsPoint

property cadPointList
Return type:

list[QgsPointXY]

cadPoints(self) → list[QgsPoint]

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()

Added in version 3.22.

Return type:

list[QgsPoint]

commonAngleConstraint: AlignMapPointConstraint
distanceConstraint: AlignMapPointConstraint
lineExtensionConstraint
mConstraint: AlignMapPointConstraint
mapUnitsPerPixel: float
setCadPoint(self, index: int, point: QgsPoint)[source]

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

See also

cadPoint()

Added in version 3.22.

Parameters:
setCadPoints(self, points: Iterable[QgsPoint])[source]

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

See also

cadPoints()

Added in version 3.22.

Parameters:

points (Iterable[QgsPoint])

snappingToFeaturesOverridesCommonAngle: bool
snappingUtils: QgsSnappingUtils
xConstraint: AlignMapPointConstraint
xyVertexConstraint
yConstraint: AlignMapPointConstraint
zConstraint: AlignMapPointConstraint
class AlignMapPointOutput[source]

Bases: object

Structure returned from alignMapPoint() method.

edgeMatch: Match
finalMapPoint: QgsPointXY
snapMatch: Match
softLockCommonAngle: float
softLockLineExtension
softLockX
softLockY
valid: bool
static alignMapPoint(originalMapPoint: QgsPointXY, ctx: QgsCadUtils.AlignMapPointContext) → QgsCadUtils.AlignMapPointOutput[source]

Applies X/Y/angle/distance constraints from the given context to a map point. Returns a structure containing aligned map point, whether the constraints are valid and some extra information.

Parameters:
Return type:

QgsCadUtils.AlignMapPointOutput