Public Member Functions
def	Activated (self, name="None", noplanesetup=False, is_subtool=False)

def	commit (self, name, func)

def	finish (self, close=False)

def	getStrings (self, addrot=None)

def	IsActive (self)

Public Attributes
	call

	commitList

	constrain

	doc

	extendedCopy

	featureName

	node

	obj

	planetrack

	point

	pos

	support

	ui

	view

Detailed Description

The base class of all Draft Tools.

This is the original class that was defined in `DraftTools.py`
before any re-organization of the code.
It must be preserved exactly like this to keep the original tools
running without problems.

This class is subclassed by `Creator` and `Modifier`
to set up a few additional properties of these two types.

This class connects with the `draftToolBar` and `Snapper` classes
that are installed in the `FreeCADGui` namespace in order to set up some
properties of the running tools such as the task panel, the snapping
functions, and the grid trackers.

It also connects with the `DraftWorkingPlane` class
that is installed in the `FreeCAD` namespace in order to set up
the working plane if it doesn't exist.

This class is intended to be replaced by newer classes inside the
`gui_base` module, in particular, `GuiCommandBase`.

Member Function Documentation

◆ Activated()

def draftguitools.gui_base_original.DraftTool.Activated	(	self,
		name = `"None"`,
		noplanesetup = `False`,
		is_subtool = `False`
	)

Execute when the command is called.

If an active Gui Command exists, it will call the `finish` method
of it to terminate it.

If no active Gui Command exists, it will proceed with configuration
of the tool. The child class that subclasses this class
then should continue with its own Activated method.

Parameters
----------
name: str, optional
    It defaults to `'None'`.
    It is the `featureName` of the object, to know what is being run.

noplanesetup: bool, optional
    It defaults to `False`.
    If it is `False` it will set up the working plane
    by running `App.DraftWorkingPlane.setup()`.

is_subtool: bool, optional
    It defaults to `False`.
    This is set to `True` when we want to modify an object
    by using the mechanism of a `subtool`, introduced
    through the `Draft_SubelementHighlight` command.
    That is, first we run `Draft_SubelementHighlight`
    then we can use `Draft_Move` while setting `is_subtool` to `True`.

◆ commit()

def draftguitools.gui_base_original.DraftTool.commit	(	self,
		name,
		func
	)

Store actions in the commit list to be run later.

Parameters
----------
name: str
    An arbitrary string that indicates the name of the operation
    to run.

func: list of str
    Each element of the list is a string that will be run by
    `Gui.doCommand`.

    See the complete information in the `draftutils.todo.ToDo` class.

References draftguitools.gui_base_original.DraftTool.commitList.

◆ finish()

def draftguitools.gui_base_original.DraftTool.finish	(	self,
		close = `False`
	)

Finish the current command.

These are general cleaning tasks that are performed
when terminating all commands.

These include setting the node list to empty,
setting to `None` the active command,
turning off the graphical interface (task panel),
finishing the plane tracker, restoring the working plane,
turning off the snapper.

If a callback is installed in the 3D view, the callback is removed,
and set to `None`.

If the commit list is non-empty it will commit the instructions on
the list with `draftutils.todo.ToDo.delayCommit`,
and the list will be set to empty.

Reimplemented in draftguitools.gui_shapestrings.ShapeString, draftguitools.gui_points.Point, draftguitools.gui_trimex.Trimex, draftguitools.gui_edit.Edit, draftguitools.gui_offset.Offset, draftguitools.gui_stretch.Stretch, draftguitools.gui_dimensions.Dimension, draftguitools.gui_fillets.Fillet, and draftguitools.gui_clone.Clone.

References draftguitools.gui_array_simple.Array.call, draftguitools.gui_arcs.Arc.call, draftguitools.gui_base_original.DraftTool.call, draftguitools.gui_base.GuiCommandBase.call, draftguitools.gui_base_original.DraftTool.commitList, Gui::Dialog::Clipping::Private.node, draftguitools.gui_base_original.DraftTool.node, Gui::AxisOrigin.node, uvPtStruct.node, StdMeshers_Quadrangle_2D::ForcedPoint.node, draftguitools.gui_arcs.Arc.node, draftguitools.gui_base_original.DraftTool.planetrack, draftguitools.gui_base.GuiCommandBase.planetrack, test.ui, Gui::Dialog::Clipping::Private.ui, Gui::Dialog::DlgAddProperty.ui, Gui::TaskBoxPosition.ui, Gui::Dialog::DlgProjectInformationImp.ui, Gui::Dialog::DlgGeneralImp.ui, Gui::Dialog::DlgSettings3DViewImp.ui, Gui::ElementColors::Private.ui, Gui::Dialog::TextureMapping.ui, Gui::Dialog::DlgSettingsNavigation.ui, Gui::Dialog::DlgCustomCommandsImp.ui, Gui::Dialog::DlgSettingsEditorImp.ui, Gui::Dialog::DlgDisplayPropertiesImp::Private.ui, Gui::Dialog::DlgParameterFind.ui, Gui::TaskBoxAngle.ui, Gui::Dialog::DlgCustomKeyboardImp.ui, Gui::Dialog::DlgWorkbenchesImp.ui, Gui::Dialog::DlgMacroExecuteImp.ui, Gui::TaskView::TaskAppearance.ui, Gui::Dialog::DlgInputDialogImp.ui, Gui::Dialog::DlgMaterialPropertiesImp.ui, Gui::Dialog::DlgExpressionInput.ui, Gui::Dialog::DlgMacroRecordImp.ui, Gui::Dialog::DemoMode.ui, Gui::Dialog::DlgSettingsColorGradientImp.ui, Gui::DlgObjectSelection.ui, Gui::Dialog::DlgCustomizeSpNavSettings.ui, Gui::Dialog::DlgProjectUtility.ui, Gui::Dialog::DlgInspector.ui, Gui::Dialog::DlgActivateWindowImp.ui, Gui::Dialog::DlgCustomActionsImp.ui, Gui::Dialog::DlgReportViewImp.ui, Gui::Dialog::DlgSettingsMacroImp.ui, Gui::Dialog::DlgSettingsViewColor.ui, Gui::Dialog::Placement.ui, Gui::Dialog::DlgSettingsUnitsImp.ui, Gui::Dialog::DownloadManager.ui, Gui::Dialog::DlgSettingsDocumentImp.ui, Gui::TaskView::TaskSelectLinkProperty.ui, Gui::Dialog::DlgOnlineHelpImp.ui, Gui::Dialog::DlgPropertyLink.ui, Gui::Dialog::DlgRunExternal.ui, Gui::Dialog::DlgUnitsCalculator.ui, Gui::Dialog::IconDialog.ui, Gui::Dialog::DlgParameterImp.ui, draftguitools.gui_base_original.DraftTool.ui, Gui::Dialog::DlgCustomToolbars.ui, Gui::Dialog::DlgSettingsImageImp.ui, Gui::Dialog::DlgCheckableMessageBoxPrivate.ui, Gui::Dialog::AboutDialog.ui, Gui::Dialog::Transform.ui, Gui::Dialog::DlgPreferencesImp.ui, Gui::Dialog::DocumentRecoveryPrivate.ui, Gui::CheckListDialog.ui, Gui::LocationDialogImp< Ui >.ui, Gui::LocationImpUi< Ui >.ui, Gui::LocationDialogUiImp.ui, Gui::Dialog::Clipping::Private.view, Gui::PointMarker.view, Gui::GraphvizView.view, draftguitools.gui_base_original.DraftTool.view, Gui::ItemViewSelection.view, and draftguitools.gui_base.GuiCommandBase.view.

◆ getStrings()

def draftguitools.gui_base_original.DraftTool.getStrings	(	self,
		addrot = `None`
	)

Return useful strings that will be used to build commands.

Returns
-------
str, str, str, str
    A tuple of four strings that represent useful information.

    * the current working plane rotation quaternion as a string
    * the support object if available as a string
    * the list of nodes inside the `node` attribute as a string
    * the string `'True'` or `'False'` depending on the fill mode
      of the current tool

References Gui::Dialog::Clipping::Private.node, draftguitools.gui_base_original.DraftTool.node, Gui::AxisOrigin.node, uvPtStruct.node, StdMeshers_Quadrangle_2D::ForcedPoint.node, draftguitools.gui_arcs.Arc.node, draftguitools.gui_base_original.DraftTool.support, DraftVecUtils.toString(), test.ui, Gui::Dialog::Clipping::Private.ui, Gui::Dialog::DlgAddProperty.ui, Gui::TaskBoxPosition.ui, Gui::Dialog::DlgProjectInformationImp.ui, Gui::Dialog::DlgGeneralImp.ui, Gui::Dialog::DlgSettings3DViewImp.ui, Gui::ElementColors::Private.ui, Gui::Dialog::TextureMapping.ui, Gui::Dialog::DlgSettingsNavigation.ui, Gui::Dialog::DlgCustomCommandsImp.ui, Gui::Dialog::DlgSettingsEditorImp.ui, Gui::Dialog::DlgDisplayPropertiesImp::Private.ui, Gui::Dialog::DlgParameterFind.ui, Gui::TaskBoxAngle.ui, Gui::Dialog::DlgCustomKeyboardImp.ui, Gui::Dialog::DlgWorkbenchesImp.ui, Gui::Dialog::DlgMacroExecuteImp.ui, Gui::TaskView::TaskAppearance.ui, Gui::Dialog::DlgInputDialogImp.ui, Gui::Dialog::DlgMaterialPropertiesImp.ui, Gui::Dialog::DlgExpressionInput.ui, Gui::Dialog::DlgMacroRecordImp.ui, Gui::Dialog::DlgSettingsColorGradientImp.ui, Gui::Dialog::DemoMode.ui, Gui::DlgObjectSelection.ui, Gui::Dialog::DlgCustomizeSpNavSettings.ui, Gui::Dialog::DlgProjectUtility.ui, Gui::Dialog::DlgInspector.ui, Gui::Dialog::DlgActivateWindowImp.ui, Gui::Dialog::DlgCustomActionsImp.ui, Gui::Dialog::DlgReportViewImp.ui, Gui::Dialog::DlgSettingsMacroImp.ui, Gui::Dialog::DlgSettingsViewColor.ui, Gui::Dialog::Placement.ui, Gui::Dialog::DlgSettingsUnitsImp.ui, Gui::Dialog::DownloadManager.ui, Gui::Dialog::DlgSettingsDocumentImp.ui, Gui::TaskView::TaskSelectLinkProperty.ui, Gui::Dialog::DlgOnlineHelpImp.ui, Gui::Dialog::DlgPropertyLink.ui, Gui::Dialog::DlgRunExternal.ui, Gui::Dialog::DlgUnitsCalculator.ui, Gui::Dialog::IconDialog.ui, Gui::Dialog::DlgParameterImp.ui, draftguitools.gui_base_original.DraftTool.ui, Gui::Dialog::DlgCustomToolbars.ui, Gui::Dialog::DlgSettingsImageImp.ui, Gui::Dialog::DlgCheckableMessageBoxPrivate.ui, Gui::Dialog::AboutDialog.ui, Gui::Dialog::Transform.ui, Gui::Dialog::DlgPreferencesImp.ui, Gui::Dialog::DocumentRecoveryPrivate.ui, Gui::CheckListDialog.ui, Gui::LocationDialogImp< Ui >.ui, Gui::LocationImpUi< Ui >.ui, and Gui::LocationDialogUiImp.ui.

Referenced by draftguitools.gui_ellipses.Ellipse.createObject(), draftguitools.gui_rectangles.Rectangle.createObject(), draftguitools.gui_shapestrings.ShapeString.createObject(), draftguitools.gui_arcs.Arc.drawArc(), draftguitools.gui_polygons.Polygon.drawPolygon(), draftguitools.gui_lines.Line.finish(), draftguitools.gui_splines.BSpline.finish(), draftguitools.gui_beziers.BezCurve.finish(), and draftguitools.gui_beziers.CubicBezCurve.finish().

◆ IsActive()

def draftguitools.gui_base_original.DraftTool.IsActive ( self )

Return True when this command should be available.

It is `True` when there is a document.

Reimplemented in draftguitools.gui_line_add_delete.DelPoint, and draftguitools.gui_line_add_delete.AddPoint.

Member Data Documentation

◆ call

draftguitools.gui_base_original.DraftTool.call

◆ commitList

draftguitools.gui_base_original.DraftTool.commitList

Referenced by draftguitools.gui_base_original.DraftTool.commit(), and draftguitools.gui_base_original.DraftTool.finish().

◆ constrain

draftguitools.gui_base_original.DraftTool.constrain

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

◆ doc

draftguitools.gui_base_original.DraftTool.doc

◆ extendedCopy

draftguitools.gui_base_original.DraftTool.extendedCopy

Referenced by draftguitools.gui_mirror.Mirror.action(), and draftguitools.gui_offset.Offset.action().

◆ featureName

draftguitools.gui_base_original.DraftTool.featureName

Referenced by PathScripts.PathOpGui.TaskPanelBaseGeometryPage.selectionSupportedAsBaseGeometry().

◆ node

draftguitools.gui_base_original.DraftTool.node

◆ obj

draftguitools.gui_base_original.DraftTool.obj

◆ planetrack

draftguitools.gui_base_original.DraftTool.planetrack

Referenced by draftguitools.gui_labels.Label.action(), draftguitools.gui_stretch.Stretch.addPoint(), draftguitools.gui_ellipses.Ellipse.appendPoint(), draftguitools.gui_rectangles.Rectangle.appendPoint(), draftguitools.gui_lines.Line.drawSegment(), draftguitools.gui_splines.BSpline.drawUpdate(), draftguitools.gui_beziers.BezCurve.drawUpdate(), draftguitools.gui_beziers.CubicBezCurve.drawUpdate(), draftguitools.gui_base_original.DraftTool.finish(), and draftguitools.gui_lines.Line.orientWP().

◆ point

draftguitools.gui_base_original.DraftTool.point

◆ pos

draftguitools.gui_base_original.DraftTool.pos

◆ support

draftguitools.gui_base_original.DraftTool.support

Referenced by draftguitools.gui_splines.BSpline.action(), draftguitools.gui_beziers.BezCurve.action(), draftguitools.gui_lines.Line.action(), draftguitools.gui_ellipses.Ellipse.action(), draftguitools.gui_rectangles.Rectangle.action(), and draftguitools.gui_base_original.DraftTool.getStrings().

◆ ui

draftguitools.gui_base_original.DraftTool.ui

◆ view

draftguitools.gui_base_original.DraftTool.view

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

src/Mod/Draft/draftguitools/gui_base_original.py

Public Member Functions

Public Attributes