Public Member Functions

def addHoldPoint (self)
 
def constrain (self, point, basepoint=None, axis=None)
 
def cstr (self, lastpoint, constrain, point)
 
def cycleSnapObject (self)
 
def device_pixel_ratio (self)
 
def get_cursor_size (self)
 
def get_cursor_with_tail (self, base_icon_name, tail_icon_name=None)
 
def get_snap_toolbar (self)
 
def getApparentPoint (self, x, y)
 
def getPerpendicular (self, edge, pt)
 
def getPoint (self, last=None, callback=None, movecallback=None, extradlg=None, title=None, mode="point")
 
def getScreenDist (self, dist, cursor)
 
def hide (self)
 
def init_active_snaps (self)
 
def init_draft_snap_buttons (self, commands, context, button_suffix)
 
def init_grid_button (self, context)
 
def isEnabled (self, snap)
 
def makeSnapToolBar (self)
 
def off (self, hideSnapBar=False)
 
def restack (self)
 
def restore_snap_buttons_state (self, toolbar, button_suffix)
 
def save_snap_state (self)
 
def setAngle (self, delta=None)
 
def setArchDims (self, p1, p2)
 
def setCursor (self, mode=None)
 
def setGrid (self)
 
def setSelectMode (self, mode)
 
def setTrackers (self)
 
def show (self)
 
def showradius (self)
 
def snap (self, screenpos, lastpoint=None, active=True, constrain=False, noTracker=False)
 
def snapToAngles (self, shape)
 
def snapToCenter (self, shape)
 
def snapToCrossExtensions (self, point)
 
def snapToDim (self, obj)
 
def snapToElines (self, e1, e2)
 
def snapToEndpoints (self, shape)
 
def snapToExtensions (self, point, last, constrain, eline)
 
def snapToExtOrtho (self, last, constrain, eline)
 
def snapToExtPerpendicular (self, last)
 
def snapToFace (self, shape)
 
def snapToGrid (self, point)
 
def snapToHold (self, point)
 
def snapToIntersection (self, shape)
 
def snapToMidpoint (self, shape)
 
def snapToObject (self, lastpoint, active, constrain, eline, point, oldActive)
 
def snapToOrtho (self, shape, last, constrain)
 
def snapToPerpendicular (self, shape, last)
 
def snapToPolar (self, point, last)
 
def snapToPolygon (self, obj)
 
def snapToSpecials (self, obj, lastpoint=None, eline=None)
 
def snapToVertex (self, info, active=False)
 
def toggle_snap (self, snap, set_to=None)
 
def toggleGrid (self)
 
def toWP (self, point)
 
def unconstrain (self)
 

Public Attributes

 active
 
 active_snaps
 
 activeview
 
 affinity
 
 basepoint
 
 callbackClick
 
 callbackMove
 
 constrainLine
 
 constraintAxis
 
 cursorMode
 
 cursors
 
 dim1
 
 dim2
 
 extLine
 
 extLine2
 
 forceGridOff
 
 grid
 
 holdPoints
 
 holdTracker
 
 lastExtensions
 
 lastObj
 
 lastSnappedObject
 
 mask
 
 maxEdges
 
 mk
 
 polarAngles
 
 pt
 
 radius
 
 radiusTracker
 
 running
 
 selectMode
 
 snapInfo
 
 snapObjectIndex
 
 snaps
 
 snapStyle
 
 spoint
 
 toolbar
 
 tracker
 
 trackers
 
 trackLine
 
 ui
 
 view
 

Detailed Description

Classes to manage snapping in Draft and Arch.

The Snapper objects contains all the functionality used by draft
and arch module to manage object snapping. It is responsible for
finding snap points and displaying snap markers. Usually You
only need to invoke it's snap() function, all the rest is taken
care of.

3 functions are useful for the scriptwriter: snap(), constrain()
or getPoint() which is an all-in-one combo.

The individual snapToXXX() functions return a snap definition in
the form [real_point,marker_type,visual_point], and are not
meant to be used directly, they are all called when necessary by
the general snap() function.

The Snapper lives inside Gui once the Draft module has been
loaded.

Member Function Documentation

◆ addHoldPoint()

def draftguitools.gui_snapper.Snapper.addHoldPoint (   self)

◆ constrain()

def draftguitools.gui_snapper.Snapper.constrain (   self,
  point,
  basepoint = None,
  axis = None 
)
Return a constrained point.

constrain(point,basepoint=None,axis=None: Returns a
constrained point. Axis can be "x","y" or "z" or a custom vector. If None,
the closest working plane axis will be picked.
Basepoint is the base point used to figure out from where the point
must be constrained. If no basepoint is given, the current point is
used as basepoint.

References draftguitools.gui_snapper.Snapper.affinity, draftguitools.gui_snapper.Snapper.basepoint, MeshCore::MeshDistancePlanarSegment.basepoint, MeshCore::PlaneSurfaceFit.basepoint, MeshCore::CylinderSurfaceFit.basepoint, MeshCore::MeshPlaneVisitor.basepoint, draftguitools.gui_snapper.Snapper.constrainLine, draftguitools.gui_snapper.Snapper.constraintAxis, DraftGui.DraftToolBar.mask, draftguitools.gui_snapper.Snapper.mask, drafttaskpanels.task_circulararray.TaskPanelCircularArray.mask, drafttaskpanels.task_polararray.TaskPanelPolarArray.mask, draftguitools.gui_snapper.Snapper.off(), DraftVecUtils.project(), and draftguitools.gui_snapper.Snapper.snapStyle.

Referenced by DraftGui.DraftToolBar.checkSpecialChars(), and draftguitools.gui_snapper.Snapper.cstr().

◆ cstr()

◆ cycleSnapObject()

def draftguitools.gui_snapper.Snapper.cycleSnapObject (   self)
Increase the index of the snap object by one.

References draftguitools.gui_snapper.Snapper.snapObjectIndex.

◆ device_pixel_ratio()

def draftguitools.gui_snapper.Snapper.device_pixel_ratio (   self)

◆ get_cursor_size()

def draftguitools.gui_snapper.Snapper.get_cursor_size (   self)

◆ get_cursor_with_tail()

def draftguitools.gui_snapper.Snapper.get_cursor_with_tail (   self,
  base_icon_name,
  tail_icon_name = None 
)

◆ get_snap_toolbar()

def draftguitools.gui_snapper.Snapper.get_snap_toolbar (   self)
Returns snap toolbar object.

References Gui.getMainWindow().

Referenced by draftguitools.gui_snapper.Snapper.show().

◆ getApparentPoint()

def draftguitools.gui_snapper.Snapper.getApparentPoint (   self,
  x,
  y 
)

◆ getPerpendicular()

def draftguitools.gui_snapper.Snapper.getPerpendicular (   self,
  edge,
  pt 
)

◆ getPoint()

def draftguitools.gui_snapper.Snapper.getPoint (   self,
  last = None,
  callback = None,
  movecallback = None,
  extradlg = None,
  title = None,
  mode = "point" 
)
Get a 3D point from the screen.

getPoint([last],[callback],[movecallback],[extradlg],[title]):
gets a 3D point from the screen. You can provide an existing point,
in that case additional snap options and a tracker are available.
You can also pass a function as callback, which will get called
with the resulting point as argument, when a point is clicked,
and optionally another callback which gets called when
the mouse is moved.

If the operation gets cancelled (the user pressed Escape),
no point is returned.

Example:

def cb(point):
    if point:
        print "got a 3D point: ",point

Gui.Snapper.getPoint(callback=cb)

If the callback function accepts more than one argument,
it will also receive the last snapped object. Finally, a qt widget
can be passed as an extra taskbox.
title is the title of the point task box mode is the dialog box
you want (default is point, you can also use wire and line)

If getPoint() is invoked without any argument, nothing is done
but the callbacks are removed, so it can be used as a cancel function.

Referenced by PathScripts.PathOpGui.TaskPanelBaseLocationPage.addLocation(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel.addNewTag(), PathScripts.PathOpGui.TaskPanelBaseLocationPage.editLocation(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel.editTag(), draftguitools.gui_arcs.Arc_3Points.getPoint(), ArchCurtainWall.CommandArchCurtainWall.getPoint(), ArchTruss.CommandArchTruss.getPoint(), PathScripts.PathDressupTagGui.PathDressupTagTaskPanel.modifyStandardButtons(), and PathScripts.PathOpGui.TaskPanelBaseLocationPage.modifyStandardButtons().

◆ getScreenDist()

def draftguitools.gui_snapper.Snapper.getScreenDist (   self,
  dist,
  cursor 
)
Return a distance in 3D space from a screen pixels distance.

Referenced by draftguitools.gui_snapper.Snapper.showradius().

◆ hide()

◆ init_active_snaps()

def draftguitools.gui_snapper.Snapper.init_active_snaps (   self)
set self.active_snaps according to user prefs

◆ init_draft_snap_buttons()

def draftguitools.gui_snapper.Snapper.init_draft_snap_buttons (   self,
  commands,
  context,
  button_suffix 
)
Init Draft Snap toolbar buttons.

Parameters:
commands        Snap command list,
                use: get_draft_snap_commands():
context         The toolbar or action group the buttons have
                to be added to
button_suffix   The suffix that have to be applied to the command name
                to define the button name

References draftguitools.gui_snapper.Snapper.init_grid_button(), and draftguitools.gui_snapper.Snapper.toolbar.

◆ init_grid_button()

def draftguitools.gui_snapper.Snapper.init_grid_button (   self,
  context 
)
Add grid button to the given toolbar

Referenced by draftguitools.gui_snapper.Snapper.init_draft_snap_buttons().

◆ isEnabled()

◆ makeSnapToolBar()

def draftguitools.gui_snapper.Snapper.makeSnapToolBar (   self)
Build the Snap toolbar.

References Gui.getMainWindow().

Referenced by draftguitools.gui_snapper.Snapper.show().

◆ off()

def draftguitools.gui_snapper.Snapper.off (   self,
  hideSnapBar = False 
)
Finish snapping.

References draftguitools.gui_snapper.Snapper.dim1, draftguitools.gui_snapper.Snapper.dim2, draftguitools.gui_snapper.Snapper.extLine, draftguitools.gui_snapper.Snapper.extLine2, FaceQuadStruct::Side.grid, ArchAxis._AxisTaskPanel.grid, ArchAxis.AxisSystemTaskPanel.grid, ArchComponent.ComponentTaskPanel.grid, ArchCutPlane._CutPlaneTaskPanel.grid, ArchPrecast._PrecastTaskPanel.grid, ArchPrecast._DentsTaskPanel.grid, ArchRoof._RoofTaskPanel.grid, ArchSectionPlane.SectionPlaneTaskPanel.grid, ArchWindow._ArchWindowTaskPanel.grid, DraftGui.FacebinderTaskPanel.grid, draftguitools.gui_snapper.Snapper.grid, MeshGui::Vertex.grid, MeshPartGui::MeshCrossSection.grid, MeshPartGui::CurveOnMeshHandler::Private.grid, Plot.Plot.grid, ColorPickerPopup.grid, draftguitools.gui_snapper.Snapper.hide(), draftguitools.gui_snapper.Snapper.holdPoints, draftguitools.gui_snapper.Snapper.holdTracker, DraftGui.DraftToolBar.mask, draftguitools.gui_snapper.Snapper.mask, drafttaskpanels.task_circulararray.TaskPanelCircularArray.mask, drafttaskpanels.task_polararray.TaskPanelPolarArray.mask, Measure::MeasurementPy.radius(), DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, DrawSketchHandler3PointArc.radius, DrawSketchHandler3PointCircle.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, draftguitools.gui_snapper.Snapper.radiusTracker, App::PropertyExpressionEngine.running, Gui::GUISingleApplication::Private.running, Gui::PythonDebuggerP.running, ArchNesting.Nester.running, draftguitools.gui_edit.Edit.running, draftguitools.gui_line_add_delete.AddPoint.running, draftguitools.gui_line_add_delete.DelPoint.running, draftguitools.gui_offset.Offset.running, draftguitools.gui_snapper.Snapper.running, draftguitools.gui_wire2spline.WireToBSpline.running, femsolver.task.Task.running, AdaptivePath::PerfCounter.running, shipHydrostatics.TaskPanel.TaskPanel.running, qtunittest.BaseGUITestRunner.running, Mod.Test.unittestgui.BaseGUITestRunner.running, draftguitools.gui_snapper.Snapper.selectMode, SketcherGui::DrawSketchHandler.setCursor(), draftguitools.gui_snapper.Snapper.setCursor(), draftguitools.gui_snapper.Snapper.toolbar, ArchPanel.CommandPanel.tracker, ArchStructure._CommandStructure.tracker, ArchWall._CommandWall.tracker, ArchWindow._CommandWindow.tracker, draftguitools.gui_arcs.Arc_3Points.tracker, draftguitools.gui_snapper.Snapper.tracker, draftguitools.gui_snapper.Snapper.trackLine, and draftguitools.gui_snapper.Snapper.unconstrain().

Referenced by draftguitools.gui_snapper.Snapper.constrain(), draftguitools.gui_snapper.Snapper.setSelectMode(), and draftguitools.gui_snapper.Snapper.unconstrain().

◆ restack()

def draftguitools.gui_snapper.Snapper.restack (   self)
Lower the grid tracker so it doesn't obscure other objects.

References FaceQuadStruct::Side.grid, ArchAxis._AxisTaskPanel.grid, ArchAxis.AxisSystemTaskPanel.grid, ArchComponent.ComponentTaskPanel.grid, ArchCutPlane._CutPlaneTaskPanel.grid, ArchPrecast._PrecastTaskPanel.grid, ArchPrecast._DentsTaskPanel.grid, ArchRoof._RoofTaskPanel.grid, ArchSectionPlane.SectionPlaneTaskPanel.grid, ArchWindow._ArchWindowTaskPanel.grid, DraftGui.FacebinderTaskPanel.grid, draftguitools.gui_snapper.Snapper.grid, MeshGui::Vertex.grid, MeshPartGui::MeshCrossSection.grid, MeshPartGui::CurveOnMeshHandler::Private.grid, Plot.Plot.grid, and ColorPickerPopup.grid.

◆ restore_snap_buttons_state()

def draftguitools.gui_snapper.Snapper.restore_snap_buttons_state (   self,
  toolbar,
  button_suffix 
)
Restore toolbar button's checked state according to
"snapModes" saved in preferences

References draftguitools.gui_snapper.Snapper.active_snaps.

◆ save_snap_state()

def draftguitools.gui_snapper.Snapper.save_snap_state (   self)
Save snap state to user preferences to be restored in next session.

References draftguitools.gui_snapper.Snapper.active_snaps, and draftguitools.gui_snapper.Snapper.snaps.

Referenced by draftguitools.gui_snapper.Snapper.toggle_snap().

◆ setAngle()

◆ setArchDims()

def draftguitools.gui_snapper.Snapper.setArchDims (   self,
  p1,
  p2 
)

◆ setCursor()

◆ setGrid()

def draftguitools.gui_snapper.Snapper.setGrid (   self)
Set the grid, if visible.

References draftguitools.gui_snapper.Snapper.forceGridOff, FaceQuadStruct::Side.grid, ArchAxis._AxisTaskPanel.grid, ArchAxis.AxisSystemTaskPanel.grid, ArchComponent.ComponentTaskPanel.grid, ArchCutPlane._CutPlaneTaskPanel.grid, ArchPrecast._PrecastTaskPanel.grid, ArchPrecast._DentsTaskPanel.grid, ArchRoof._RoofTaskPanel.grid, ArchSectionPlane.SectionPlaneTaskPanel.grid, ArchWindow._ArchWindowTaskPanel.grid, DraftGui.FacebinderTaskPanel.grid, draftguitools.gui_snapper.Snapper.grid, MeshGui::Vertex.grid, MeshPartGui::MeshCrossSection.grid, MeshPartGui::CurveOnMeshHandler::Private.grid, Plot.Plot.grid, ColorPickerPopup.grid, draftguitools.gui_snapper.Snapper.setTrackers(), and draftguitools.gui_edit.Edit.setTrackers().

◆ setSelectMode()

def draftguitools.gui_snapper.Snapper.setSelectMode (   self,
  mode 
)

◆ setTrackers()

def draftguitools.gui_snapper.Snapper.setTrackers (   self)
Set the trackers.

References draftguitools.gui_snapper.Snapper.activeview, draftguitools.gui_snapper.Snapper.dim1, draftguitools.gui_snapper.Snapper.dim2, draftguitools.gui_snapper.Snapper.extLine, draftguitools.gui_snapper.Snapper.extLine2, draftguitools.gui_snapper.Snapper.forceGridOff, FaceQuadStruct::Side.grid, ArchAxis._AxisTaskPanel.grid, ArchAxis.AxisSystemTaskPanel.grid, ArchComponent.ComponentTaskPanel.grid, ArchCutPlane._CutPlaneTaskPanel.grid, ArchPrecast._PrecastTaskPanel.grid, ArchPrecast._DentsTaskPanel.grid, ArchRoof._RoofTaskPanel.grid, ArchSectionPlane.SectionPlaneTaskPanel.grid, ArchWindow._ArchWindowTaskPanel.grid, DraftGui.FacebinderTaskPanel.grid, draftguitools.gui_snapper.Snapper.grid, MeshGui::Vertex.grid, MeshPartGui::MeshCrossSection.grid, MeshPartGui::CurveOnMeshHandler::Private.grid, Plot.Plot.grid, ColorPickerPopup.grid, draftguitools.gui_snapper.Snapper.holdTracker, draftguitools.gui_snapper.Snapper.radiusTracker, draftguitools.gui_snapper.Snapper.snapStyle, ArchPanel.CommandPanel.tracker, ArchStructure._CommandStructure.tracker, ArchWall._CommandWall.tracker, ArchWindow._CommandWindow.tracker, draftguitools.gui_arcs.Arc_3Points.tracker, draftguitools.gui_snapper.Snapper.tracker, draftguitools.gui_edit.Edit.trackers, draftguitools.gui_snapper.Snapper.trackers, and draftguitools.gui_snapper.Snapper.trackLine.

Referenced by draftguitools.gui_edit.Edit.proceed(), draftguitools.gui_edit.Edit.resetTrackers(), draftguitools.gui_snapper.Snapper.setGrid(), and draftguitools.gui_snapper.Snapper.show().

◆ show()

◆ showradius()

def draftguitools.gui_snapper.Snapper.showradius (   self)
Show the snap radius indicator.

References draftguitools.gui_snapper.Snapper.getScreenDist(), Measure::MeasurementPy.radius(), DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, DrawSketchHandler3PointArc.radius, DrawSketchHandler3PointCircle.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, and draftguitools.gui_snapper.Snapper.radiusTracker.

◆ snap()

def draftguitools.gui_snapper.Snapper.snap (   self,
  screenpos,
  lastpoint = None,
  active = True,
  constrain = False,
  noTracker = False 
)
Return a snapped point from the given (x, y) screen position.

snap(screenpos,lastpoint=None,active=True,constrain=False,
noTracker=False): returns a snapped point from the given
(x,y) screenpos (the position of the mouse cursor), active is to
activate active point snapping or not (passive),
lastpoint is an optional other point used to draw an
imaginary segment and get additional snap locations. Constrain can
be True to constrain the point against the closest working plane axis.
Screenpos can be a list, a tuple or a coin.SbVec2s object.
If noTracker is True, the tracking line is not displayed.

References App::PropertyExpressionEngine.running, Gui::GUISingleApplication::Private.running, Gui::PythonDebuggerP.running, ArchNesting.Nester.running, draftguitools.gui_edit.Edit.running, draftguitools.gui_line_add_delete.AddPoint.running, draftguitools.gui_line_add_delete.DelPoint.running, draftguitools.gui_offset.Offset.running, draftguitools.gui_snapper.Snapper.running, draftguitools.gui_wire2spline.WireToBSpline.running, femsolver.task.Task.running, AdaptivePath::PerfCounter.running, shipHydrostatics.TaskPanel.TaskPanel.running, qtunittest.BaseGUITestRunner.running, and Mod.Test.unittestgui.BaseGUITestRunner.running.

◆ snapToAngles()

def draftguitools.gui_snapper.Snapper.snapToAngles (   self,
  shape 
)

◆ snapToCenter()

def draftguitools.gui_snapper.Snapper.snapToCenter (   self,
  shape 
)

◆ snapToCrossExtensions()

def draftguitools.gui_snapper.Snapper.snapToCrossExtensions (   self,
  point 
)
Snap to the intersection of the last 2 extension lines.

References DraftVecUtils.equals(), draftguitools.gui_snapper.Snapper.extLine, draftguitools.gui_snapper.Snapper.extLine2, Base::LogLevel.isEnabled(), draftguitools.gui_snapper.Snapper.isEnabled(), draftguitools.gui_snapper.Snapper.lastExtensions, draftguitools.gui_snapper.Snapper.mk, Measure::MeasurementPy.radius(), DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, DrawSketchHandler3PointArc.radius, DrawSketchHandler3PointCircle.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, draftguitools.gui_snapper.Snapper.selectMode, SketcherGui::DrawSketchHandler.setCursor(), draftguitools.gui_snapper.Snapper.setCursor(), draftguitools.gui_snapper.Snapper.snapStyle, ArchPanel.CommandPanel.tracker, ArchStructure._CommandStructure.tracker, ArchWall._CommandWall.tracker, ArchWindow._CommandWindow.tracker, draftguitools.gui_arcs.Arc_3Points.tracker, and draftguitools.gui_snapper.Snapper.tracker.

◆ snapToDim()

def draftguitools.gui_snapper.Snapper.snapToDim (   self,
  obj 
)

◆ snapToElines()

def draftguitools.gui_snapper.Snapper.snapToElines (   self,
  e1,
  e2 
)

◆ snapToEndpoints()

def draftguitools.gui_snapper.Snapper.snapToEndpoints (   self,
  shape 
)

◆ snapToExtensions()

def draftguitools.gui_snapper.Snapper.snapToExtensions (   self,
  point,
  last,
  constrain,
  eline 
)
Return a point snapped to extension or parallel line.

The parallel line of the last object, if any.

References draftguitools.gui_snapper.Snapper.extLine, draftguitools.gui_snapper.Snapper.getPerpendicular(), ArchRoof._Roof.getPerpendicular(), Base::LogLevel.isEnabled(), draftguitools.gui_snapper.Snapper.isEnabled(), DraftVecUtils.isNull(), draftguitools.gui_snapper.Snapper.lastExtensions, draftguitools.gui_snapper.Snapper.lastObj, draftguitools.gui_snapper.Snapper.maxEdges, draftguitools.gui_snapper.Snapper.mk, Measure::MeasurementPy.radius(), DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, DrawSketchHandler3PointArc.radius, DrawSketchHandler3PointCircle.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, draftguitools.gui_snapper.Snapper.selectMode, SketcherGui::DrawSketchHandler.setCursor(), draftguitools.gui_snapper.Snapper.setCursor(), draftguitools.gui_snapper.Snapper.snapStyle, draftguitools.gui_snapper.Snapper.snapToExtOrtho(), draftguitools.gui_snapper.Snapper.snapToExtPerpendicular(), draftguitools.gui_snapper.Snapper.snapToHold(), ArchPanel.CommandPanel.tracker, ArchStructure._CommandStructure.tracker, ArchWall._CommandWall.tracker, ArchWindow._CommandWindow.tracker, draftguitools.gui_arcs.Arc_3Points.tracker, and draftguitools.gui_snapper.Snapper.tracker.

◆ snapToExtOrtho()

def draftguitools.gui_snapper.Snapper.snapToExtOrtho (   self,
  last,
  constrain,
  eline 
)

◆ snapToExtPerpendicular()

def draftguitools.gui_snapper.Snapper.snapToExtPerpendicular (   self,
  last 
)

◆ snapToFace()

def draftguitools.gui_snapper.Snapper.snapToFace (   self,
  shape 
)

◆ snapToGrid()

def draftguitools.gui_snapper.Snapper.snapToGrid (   self,
  point 
)
Return a grid snap point if available.

References FaceQuadStruct::Side.grid, ArchAxis._AxisTaskPanel.grid, ArchAxis.AxisSystemTaskPanel.grid, ArchComponent.ComponentTaskPanel.grid, ArchCutPlane._CutPlaneTaskPanel.grid, ArchPrecast._PrecastTaskPanel.grid, ArchPrecast._DentsTaskPanel.grid, ArchRoof._RoofTaskPanel.grid, ArchSectionPlane.SectionPlaneTaskPanel.grid, ArchWindow._ArchWindowTaskPanel.grid, DraftGui.FacebinderTaskPanel.grid, draftguitools.gui_snapper.Snapper.grid, MeshGui::Vertex.grid, MeshPartGui::MeshCrossSection.grid, MeshPartGui::CurveOnMeshHandler::Private.grid, Plot.Plot.grid, ColorPickerPopup.grid, Base::LogLevel.isEnabled(), draftguitools.gui_snapper.Snapper.isEnabled(), draftguitools.gui_snapper.Snapper.mk, Measure::MeasurementPy.radius(), DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, DrawSketchHandler3PointArc.radius, DrawSketchHandler3PointCircle.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, draftguitools.gui_snapper.Snapper.selectMode, SketcherGui::DrawSketchHandler.setCursor(), draftguitools.gui_snapper.Snapper.setCursor(), ArchPanel.CommandPanel.tracker, ArchStructure._CommandStructure.tracker, ArchWall._CommandWall.tracker, ArchWindow._CommandWindow.tracker, draftguitools.gui_arcs.Arc_3Points.tracker, and draftguitools.gui_snapper.Snapper.tracker.

◆ snapToHold()

def draftguitools.gui_snapper.Snapper.snapToHold (   self,
  point 
)
Return a snap location that is orthogonal to hold points.

Or if possible at crossings.

References draftguitools.gui_snapper.Snapper.holdPoints, Base::LogLevel.isEnabled(), draftguitools.gui_snapper.Snapper.isEnabled(), Measure::MeasurementPy.radius(), DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, DrawSketchHandler3PointArc.radius, DrawSketchHandler3PointCircle.radius, TechDraw::arcPoints.radius, and TechDraw::Circle.radius.

Referenced by draftguitools.gui_snapper.Snapper.snapToExtensions().

◆ snapToIntersection()

◆ snapToMidpoint()

def draftguitools.gui_snapper.Snapper.snapToMidpoint (   self,
  shape 
)

◆ snapToObject()

def draftguitools.gui_snapper.Snapper.snapToObject (   self,
  lastpoint,
  active,
  constrain,
  eline,
  point,
  oldActive 
)
Snap to an object.

References draftguitools.gui_snapper.Snapper.cstr(), Base::LogLevel.isEnabled(), draftguitools.gui_snapper.Snapper.isEnabled(), draftguitools.gui_snapper.Snapper.lastObj, draftguitools.gui_snapper.Snapper.lastSnappedObject, draftguitools.gui_snapper.Snapper.maxEdges, draftguitools.gui_snapper.Snapper.mk, Measure::MeasurementPy.radius(), DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, DrawSketchHandler3PointArc.radius, DrawSketchHandler3PointCircle.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, App::PropertyExpressionEngine.running, Gui::GUISingleApplication::Private.running, Gui::PythonDebuggerP.running, ArchNesting.Nester.running, draftguitools.gui_edit.Edit.running, draftguitools.gui_line_add_delete.AddPoint.running, draftguitools.gui_line_add_delete.DelPoint.running, draftguitools.gui_offset.Offset.running, draftguitools.gui_snapper.Snapper.running, draftguitools.gui_wire2spline.WireToBSpline.running, femsolver.task.Task.running, AdaptivePath::PerfCounter.running, shipHydrostatics.TaskPanel.TaskPanel.running, qtunittest.BaseGUITestRunner.running, Mod.Test.unittestgui.BaseGUITestRunner.running, draftguitools.gui_snapper.Snapper.selectMode, draftguitools.gui_snapper.Snapper.setArchDims(), SketcherGui::DrawSketchHandler.setCursor(), draftguitools.gui_snapper.Snapper.setCursor(), draftguitools.gui_snapper.Snapper.snapInfo, draftguitools.gui_snapper.Snapper.snapToAngles(), draftguitools.gui_snapper.Snapper.snapToCenter(), draftguitools.gui_snapper.Snapper.snapToDim(), draftguitools.gui_snapper.Snapper.snapToElines(), draftguitools.gui_snapper.Snapper.snapToEndpoints(), draftguitools.gui_snapper.Snapper.snapToFace(), draftguitools.gui_snapper.Snapper.snapToIntersection(), draftguitools.gui_snapper.Snapper.snapToMidpoint(), draftguitools.gui_snapper.Snapper.snapToPerpendicular(), draftguitools.gui_snapper.Snapper.snapToPolygon(), draftguitools.gui_snapper.Snapper.snapToSpecials(), draftguitools.gui_snapper.Snapper.snapToVertex(), draftguitools.gui_snapper.Snapper.spoint, draftguitools.gui_snapper.Snapper.toWP(), ArchPanel.CommandPanel.tracker, ArchStructure._CommandStructure.tracker, ArchWall._CommandWall.tracker, ArchWindow._CommandWindow.tracker, draftguitools.gui_arcs.Arc_3Points.tracker, draftguitools.gui_snapper.Snapper.tracker, and draftguitools.gui_snapper.Snapper.trackLine.

◆ snapToOrtho()

def draftguitools.gui_snapper.Snapper.snapToOrtho (   self,
  shape,
  last,
  constrain 
)

◆ snapToPerpendicular()

def draftguitools.gui_snapper.Snapper.snapToPerpendicular (   self,
  shape,
  last 
)

◆ snapToPolar()

def draftguitools.gui_snapper.Snapper.snapToPolar (   self,
  point,
  last 
)
Snap to polar lines from the given point.

References draftguitools.gui_snapper.Snapper.getPerpendicular(), ArchRoof._Roof.getPerpendicular(), Base::LogLevel.isEnabled(), draftguitools.gui_snapper.Snapper.isEnabled(), DraftVecUtils.isNull(), DraftGui.DraftToolBar.mask, draftguitools.gui_snapper.Snapper.mask, drafttaskpanels.task_circulararray.TaskPanelCircularArray.mask, drafttaskpanels.task_polararray.TaskPanelPolarArray.mask, draftguitools.gui_snapper.Snapper.mk, draftguitools.gui_snapper.Snapper.polarAngles, Measure::MeasurementPy.radius(), DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, DrawSketchHandler3PointArc.radius, DrawSketchHandler3PointCircle.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, DraftVecUtils.rotate(), draftguitools.gui_snapper.Snapper.selectMode, SketcherGui::DrawSketchHandler.setCursor(), draftguitools.gui_snapper.Snapper.setCursor(), ArchPanel.CommandPanel.tracker, ArchStructure._CommandStructure.tracker, ArchWall._CommandWall.tracker, ArchWindow._CommandWindow.tracker, draftguitools.gui_arcs.Arc_3Points.tracker, and draftguitools.gui_snapper.Snapper.tracker.

◆ snapToPolygon()

def draftguitools.gui_snapper.Snapper.snapToPolygon (   self,
  obj 
)

◆ snapToSpecials()

◆ snapToVertex()

def draftguitools.gui_snapper.Snapper.snapToVertex (   self,
  info,
  active = False 
)

◆ toggle_snap()

def draftguitools.gui_snapper.Snapper.toggle_snap (   self,
  snap,
  set_to = None 
)
Sets the given snap on/off according to the given parameter

References draftguitools.gui_snapper.Snapper.active_snaps, and draftguitools.gui_snapper.Snapper.save_snap_state().

◆ toggleGrid()

def draftguitools.gui_snapper.Snapper.toggleGrid (   self)
Toggle FreeCAD Draft Grid.

◆ toWP()

◆ unconstrain()

def draftguitools.gui_snapper.Snapper.unconstrain (   self)

Member Data Documentation

◆ active

draftguitools.gui_snapper.Snapper.active

◆ active_snaps

◆ activeview

draftguitools.gui_snapper.Snapper.activeview

◆ affinity

draftguitools.gui_snapper.Snapper.affinity

◆ basepoint

draftguitools.gui_snapper.Snapper.basepoint

◆ callbackClick

draftguitools.gui_snapper.Snapper.callbackClick

◆ callbackMove

draftguitools.gui_snapper.Snapper.callbackMove

◆ constrainLine

draftguitools.gui_snapper.Snapper.constrainLine

◆ constraintAxis

◆ cursorMode

draftguitools.gui_snapper.Snapper.cursorMode

◆ cursors

draftguitools.gui_snapper.Snapper.cursors

◆ dim1

◆ dim2

◆ extLine

◆ extLine2

◆ forceGridOff

draftguitools.gui_snapper.Snapper.forceGridOff

◆ grid

◆ holdPoints

◆ holdTracker

◆ lastExtensions

◆ lastObj

◆ lastSnappedObject

draftguitools.gui_snapper.Snapper.lastSnappedObject

◆ mask

◆ maxEdges

◆ mk

◆ polarAngles

draftguitools.gui_snapper.Snapper.polarAngles

◆ pt

◆ radius

draftguitools.gui_snapper.Snapper.radius

Referenced by PathScripts.PathPocketBase.ObjectPocket.areaOpAreaParams(), PathScripts.PathProfile.ObjectProfile.areaOpAreaParams(), PathScripts.PathPocketBase.ObjectPocket.areaOpPathParams(), PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), DraftGui.DraftToolBar.changeRadiusValue(), PathScripts.PathHelix.ObjectHelix.circularHoleExecute(), PathScripts.PathDressupHoldingTags.Tag.createSolidsAt(), PathScripts.PathSurface.ObjectSurface.deleteOpVariables(), PathScripts.PathWaterline.ObjectWaterline.deleteOpVariables(), PathScripts.PathOp.ObjectOp.execute(), PathScripts.PathDressupAxisMap.TaskPanel.getFields(), PathScripts.PathHelix.ObjectHelix.helix_cut(), ifc4.ifcsweptdisksolid.innerradiussize(), draftguitools.gui_snapper.Snapper.off(), PathScripts.PathSurfaceSupport.ProcessSelectedFaces.preProcessModel(), draftguitools.gui_snapper.Snapper.showradius(), draftguitools.gui_snapper.Snapper.snapToCrossExtensions(), draftguitools.gui_snapper.Snapper.snapToExtensions(), draftguitools.gui_snapper.Snapper.snapToGrid(), draftguitools.gui_snapper.Snapper.snapToHold(), draftguitools.gui_snapper.Snapper.snapToObject(), draftguitools.gui_snapper.Snapper.snapToPolar(), DraftGui.DraftToolBar.taskUi(), PathScripts.PathDressupAxisMap.TaskPanel.updateUI(), DraftGui.DraftToolBar.validatePoint(), automotive_design.right_circular_cone.wr1(), automotive_design.conical_surface.wr1(), config_control_design.conical_surface.wr1(), automotive_design.swept_disk_solid.wr2(), and ifc2x3.ifcsweptdisksolid.wr2().

◆ radiusTracker

◆ running

◆ selectMode

◆ snapInfo

draftguitools.gui_snapper.Snapper.snapInfo

◆ snapObjectIndex

draftguitools.gui_snapper.Snapper.snapObjectIndex

◆ snaps

draftguitools.gui_snapper.Snapper.snaps

◆ snapStyle

◆ spoint

draftguitools.gui_snapper.Snapper.spoint

◆ toolbar

◆ tracker

◆ trackers

◆ trackLine

◆ ui

draftguitools.gui_snapper.Snapper.ui

Referenced by draftguitools.gui_beziers.BezCurve.action(), draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_ellipses.Ellipse.action(), draftguitools.gui_labels.Label.action(), draftguitools.gui_lines.Line.action(), draftguitools.gui_mirror.Mirror.action(), draftguitools.gui_offset.Offset.action(), draftguitools.gui_rectangles.Rectangle.action(), draftguitools.gui_shapestrings.ShapeString.action(), draftguitools.gui_splines.BSpline.action(), draftguitools.gui_texts.Text.action(), draftguitools.gui_arcs.Arc.Activated(), draftguitools.gui_circulararray.CircularArray.Activated(), draftguitools.gui_clone.Clone.Activated(), draftguitools.gui_downgrade.Downgrade.Activated(), draftguitools.gui_draft2sketch.Draft2Sketch.Activated(), draftguitools.gui_ellipses.Ellipse.Activated(), draftguitools.gui_facebinders.Facebinder.Activated(), draftguitools.gui_join.Join.Activated(), draftguitools.gui_orthoarray.OrthoArray.Activated(), draftguitools.gui_polararray.PolarArray.Activated(), draftguitools.gui_polygons.Polygon.Activated(), draftguitools.gui_rectangles.Rectangle.Activated(), draftguitools.gui_rotate.Rotate.Activated(), draftguitools.gui_shape2dview.Shape2DView.Activated(), draftguitools.gui_split.Split.Activated(), draftguitools.gui_stretch.Stretch.Activated(), draftguitools.gui_styles.ApplyStyle.Activated(), draftguitools.gui_texts.Text.Activated(), draftguitools.gui_upgrade.Upgrade.Activated(), draftguitools.gui_fillets.Fillet.Activated(), draftguitools.gui_array_simple.Array.Activated(), draftguitools.gui_stretch.Stretch.addPoint(), draftguitools.gui_ellipses.Ellipse.appendPoint(), draftguitools.gui_rectangles.Rectangle.appendPoint(), DraftGui.DraftToolBar.changeEvent(), draftguitools.gui_circulararray.CircularArray.click(), draftguitools.gui_orthoarray.OrthoArray.click(), draftguitools.gui_polararray.PolarArray.click(), draftguitools.gui_dimensions.Dimension.createObject(), draftguitools.gui_polygons.Polygon.drawPolygon(), draftguitools.gui_edit.Edit.endEditing(), draftguitools.gui_base_original.DraftTool.finish(), draftguitools.gui_fillets.Fillet.finish(), draftguitools.gui_dimensions.Dimension.finish(), draftguitools.gui_edit.Edit.finish(), draftguitools.gui_trimex.Trimex.finish(), draftguitools.gui_arcs.Arc.finish(), draftguitools.gui_beziers.BezCurve.finish(), draftguitools.gui_beziers.CubicBezCurve.finish(), draftguitools.gui_ellipses.Ellipse.finish(), draftguitools.gui_lines.Line.finish(), draftguitools.gui_mirror.Mirror.finish(), draftguitools.gui_move.Move.finish(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_rectangles.Rectangle.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_splines.BSpline.finish(), draftguitools.gui_texts.Text.finish(), draftguitools.gui_points.Point.finish(), draftguitools.gui_shapestrings.ShapeString.finish(), draftguitools.gui_move.Move.get_object_selection(), draftguitools.gui_rotate.Rotate.get_object_selection(), draftguitools.gui_scale.Scale.get_object_selection(), draftguitools.gui_subelements.SubelementHighlight.get_selection(), draftguitools.gui_base_original.DraftTool.getStrings(), draftguitools.gui_move.Move.handle_mouse_click_event(), draftguitools.gui_move.Move.move(), draftguitools.gui_circulararray.CircularArray.move(), draftguitools.gui_points.Point.move(), draftguitools.gui_polararray.PolarArray.move(), draftguitools.gui_move.Move.move_object(), draftguitools.gui_move.Move.move_subelements(), draftguitools.gui_arcs.Arc.numericInput(), draftguitools.gui_polygons.Polygon.numericInput(), draftguitools.gui_rotate.Rotate.numericInput(), draftguitools.gui_shapestrings.ShapeString.numericInput(), draftguitools.gui_arcs.Arc.numericRadius(), draftguitools.gui_offset.Offset.numericRadius(), draftguitools.gui_rotate.Rotate.numericRadius(), draftguitools.gui_edit.Edit.proceed(), draftguitools.gui_groups.AddToGroup.proceed(), draftguitools.gui_groups.SetAutoGroup.proceed(), draftguitools.gui_trimex.Trimex.redraw(), draftguitools.gui_rotate.Rotate.rotate(), draftguitools.gui_fillets.Fillet.set_chamfer(), draftguitools.gui_fillets.Fillet.set_delete(), draftguitools.gui_move.Move.set_ghosts(), draftguitools.gui_rotate.Rotate.set_ghosts(), draftguitools.gui_scale.Scale.set_ghosts(), draftguitools.gui_rotate.Rotate.set_start_point(), draftguitools.gui_edit.Edit.startEditing(), and draftguitools.gui_edit.Edit.updateTrackerAndGhost().

◆ view

draftguitools.gui_snapper.Snapper.view

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.accept(), femexamples.examplesgui.FemExamples.accept(), draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_circulararray.CircularArray.Activated(), draftguitools.gui_orthoarray.OrthoArray.Activated(), draftguitools.gui_polararray.PolarArray.Activated(), draftguitools.gui_circulararray.CircularArray.completed(), draftguitools.gui_orthoarray.OrthoArray.completed(), draftguitools.gui_polararray.PolarArray.completed(), femexamples.examplesgui.FemExamples.double_clicked(), femexamples.examplesgui.FemExamples.enable_buttons(), draftguitools.gui_base.GuiCommandBase.finish(), draftguitools.gui_base_original.DraftTool.finish(), draftguitools.gui_selectplane.Draft_SelectPlane.finish(), draftguitools.gui_points.Point.finish(), draftguitools.gui_subelements.SubelementHighlight.get_selection(), PathScripts.PathGetPoint.TaskPanel.getPoint(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickAlign(), draftguitools.gui_drawing.Drawing.proceed(), draftguitools.gui_mirror.Mirror.proceed(), draftguitools.gui_move.Move.proceed(), draftguitools.gui_offset.Offset.proceed(), draftguitools.gui_rotate.Rotate.proceed(), draftguitools.gui_scale.Scale.proceed(), draftguitools.gui_stretch.Stretch.proceed(), draftguitools.gui_trimex.Trimex.proceed(), draftguitools.gui_edit.Edit.register_selection_callback(), drafttaskpanels.task_shapestring.ShapeStringTaskPanel.reject(), draftguitools.gui_subelements.SubelementHighlight.remove_view_callback(), PathScripts.PathGetPoint.TaskPanel.removeGlobalCallbacks(), femexamples.examplesgui.FemExamples.run(), and draftguitools.gui_edit.Edit.unregister_selection_callback().


The documentation for this class was generated from the following file:
  • Sources/FreeCAD/src/Mod/Draft/draftguitools/gui_snapper.py