Public Member Functions
def	action (self, arg)

def	Activated (self, name=translate("draft", "Line"))

def	drawSegment (self, point)

def	finish (self, closed=False, cont=False)

def	GetResources (self)

def	numericInput (self, numx, numy, numz)

def	orientWP (self)

def	removeTemporaryObject (self)

def	undolast (self)

def	wipe (self)

Public Member Functions inherited from draftguitools.gui_base_original.Creator
def	Activated (self, name="None", noplanesetup=False)

Public Member Functions inherited from draftguitools.gui_base_original.DraftTool
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

	featureName

	isWire

	node

	obj

	oldWP

	point

	pos

Public Attributes inherited from draftguitools.gui_base_original.Creator
	support

Public Attributes inherited from draftguitools.gui_base_original.DraftTool
	call

	commitList

	constrain

	doc

	extendedCopy

	featureName

	node

	obj

	planetrack

	point

	pos

	support

	ui

	view

Detailed Description

Gui command for the Line tool.

Member Function Documentation

◆ action()

def draftguitools.gui_lines.Line.action	(	self,
		arg
	)

Handle the 3D scene events.

This is installed as an EventCallback in the Inventor view.

Parameters
----------
arg: dict
    Dictionary with strings that indicates the type of event received
    from the 3D view.

Reimplemented in draftguitools.gui_beziers.CubicBezCurve, draftguitools.gui_beziers.BezCurve, and draftguitools.gui_splines.BSpline.

◆ Activated()

def draftguitools.gui_lines.Line.Activated	(	self,
		name = `translate("draft", "Line")`
	)

Execute when the command is called.

References Gui::GraphvizView.doc, draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.doc, draftguitools.gui_base.GuiCommandSimplest.doc, ExpressionCompleterModel::Info.doc, App::RelabelDocumentExpressionVisitor.doc, draftguitools.gui_base_original.DraftTool.doc, App::DynamicProperty::PropData.doc, draftguitools.gui_base.GuiCommandBase.doc, App::LinkBaseExtension::PropInfo.doc, ItemInfo.doc, ItemInfo2.doc, and importIFClegacy.IfcEntity.doc.

◆ drawSegment()

def draftguitools.gui_lines.Line.drawSegment	(	self,
		point
	)

Draws new line segment.

References DraftVecUtils.equals(), draftguitools.gui_lines.Line.isWire, 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, Gui::ActiveObjectList::ObjectInfo.obj, ExpressionCompleterModel::Info.obj, draftguitools.gui_base_original.DraftTool.obj, App::Origin::OriginExtension.obj, Base::ObjectStatusLocker< Status, Object >.obj, Info.obj, ArchProfile.ProfileTaskPanel.obj, ArchSchedule.ArchScheduleTaskPanel.obj, ArchMaterial._ArchMaterialTaskPanel.obj, ArchReference.ArchReferenceTaskPanel.obj, ArchAxis._AxisTaskPanel.obj, ArchMaterial._ArchMultiMaterialTaskPanel.obj, ArchRoof._RoofTaskPanel.obj, ArchAxis.AxisSystemTaskPanel.obj, UpdateLabelExpressionVisitor.obj, ArchWindow._ArchWindowTaskPanel.obj, ArchSectionPlane.SectionPlaneTaskPanel.obj, ArchAxis.ArchGridTaskPanel.obj, ArchPanel.SheetTaskPanel.obj, ItemInfo.obj, ItemInfo2.obj, ArchComponent.ComponentTaskPanel.obj, DraftGui.FacebinderTaskPanel.obj, draftguitools.gui_base_original.DraftTool.planetrack, and draftguitools.gui_base.GuiCommandBase.planetrack.

◆ finish()

def draftguitools.gui_lines.Line.finish	(	self,
		closed = `False`,
		cont = `False`
	)

Terminate the operation and close the polyline if asked.

Parameters
----------
closed: bool, optional
    Close the line if `True`.

Reimplemented in draftguitools.gui_beziers.CubicBezCurve, draftguitools.gui_beziers.BezCurve, and draftguitools.gui_splines.BSpline.

References ArchSchedule.CommandArchSchedule.Activated(), AddonManager.CommandAddonManager.Activated(), draftguitools.gui_arcs.Arc.Activated(), draftguitools.gui_array_simple.Array.Activated(), draftguitools.gui_base_original.DraftTool.Activated(), ArchCutPlane._CommandCutLine.Activated(), ArchFrame._CommandFrame.Activated(), ArchTruss.CommandArchTruss.Activated(), draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.Activated(), draftguitools.gui_base.GuiCommandSimplest.Activated(), ArchCutPlane._CommandCutPlane.Activated(), ArchProject._CommandProject.Activated(), ArchCurtainWall.CommandArchCurtainWall.Activated(), ArchMaterial._CommandArchMaterial.Activated(), ArchRebar._CommandRebar.Activated(), ArchPipe._CommandPipe.Activated(), ArchAxis._CommandAxis.Activated(), ArchFloor._CommandFloor.Activated(), ArchProfile.Arch_Profile.Activated(), draftguitools.gui_array_simple.LinkArray.Activated(), ArchRoof._CommandRoof.Activated(), ArchAxis._CommandAxisSystem.Activated(), ArchMaterial._CommandArchMultiMaterial.Activated(), InitGui.ArchWorkbench.Activated(), ArchPipe._CommandPipeConnector.Activated(), ArchPanel.CommandPanel.Activated(), ArchWindow._CommandWindow.Activated(), ArchAxis.CommandArchGrid.Activated(), ArchEquipment._CommandEquipment.Activated(), ArchStructure._CommandStructure.Activated(), ArchBuilding._CommandBuilding.Activated(), ArchStairs._CommandStairs.Activated(), ArchEquipment._Command3Views.Activated(), ArchSpace._CommandSpace.Activated(), ArchWall._CommandWall.Activated(), ArchBuildingPart.CommandBuildingPart.Activated(), ArchPanel.CommandPanelCut.Activated(), ArchFence._CommandFence.Activated(), ArchPanel.CommandPanelSheet.Activated(), draftguitools.gui_arcs.Arc_3Points.Activated(), ArchSite._CommandSite.Activated(), ArchWall._CommandMergeWalls.Activated(), ArchReference.ArchReferenceCommand.Activated(), ArchSectionPlane._CommandSectionPlane.Activated(), ArchCommands._CommandAdd.Activated(), ArchCommands._CommandRemove.Activated(), ArchCommands._CommandSplitMesh.Activated(), ArchCommands._CommandMeshToShape.Activated(), ArchCommands._CommandSelectNonSolidMeshes.Activated(), ArchCommands._CommandRemoveShape.Activated(), ArchCommands._CommandCloseHoles.Activated(), ArchPanel.CommandNest.Activated(), ArchCommands._CommandCheck.Activated(), ArchCommands._CommandSurvey.Activated(), ArchCommands._ToggleIfcBrepFlag.Activated(), ArchCommands._CommandComponent.Activated(), ArchCommands._CommandCloneComponent.Activated(), ArchCommands._CommandIfcSpreadsheet.Activated(), ArchCommands._ToggleSubs.Activated(), DraftGui.DraftToolBar.Activated(), Gui::MacroManager.commit(), draftguitools.gui_base_original.DraftTool.commit(), draftguitools.gui_base.GuiCommandBase.commit(), Base::ParameterGrpPy.getStrings(), draftguitools.gui_base_original.DraftTool.getStrings(), 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_lines.Line.oldWP, draftguitools.gui_lines.Line.removeTemporaryObject(), 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::TaskView::TaskAppearance.ui, Gui::Dialog::DlgMacroExecuteImp.ui, Gui::Dialog::DlgMaterialPropertiesImp.ui, Gui::Dialog::DlgInputDialogImp.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::DlgSettingsViewColor.ui, Gui::Dialog::DlgSettingsMacroImp.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, Gui::Dialog::DlgCustomToolbars.ui, draftguitools.gui_base_original.DraftTool.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.

◆ GetResources()

def draftguitools.gui_lines.Line.GetResources ( self )

Set icon, menu and tooltip.

Reimplemented in draftguitools.gui_lines.Wire, draftguitools.gui_beziers.CubicBezCurve, draftguitools.gui_beziers.BezCurve, and draftguitools.gui_splines.BSpline.

◆ numericInput()

def draftguitools.gui_lines.Line.numericInput	(	self,
		numx,
		numy,
		numz
	)

Validate the entry fields in the user interface.

This function is called by the toolbar or taskpanel interface
when valid x, y, and z have been entered in the input fields.

Referenced by draftguitools.gui_scale.Scale.handle_mouse_click_event().

◆ orientWP()

def draftguitools.gui_lines.Line.orientWP ( self )

Orient the working plane.

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, Gui::ActiveObjectList::ObjectInfo.obj, ExpressionCompleterModel::Info.obj, draftguitools.gui_base_original.DraftTool.obj, App::Origin::OriginExtension.obj, Base::ObjectStatusLocker< Status, Object >.obj, Info.obj, ArchProfile.ProfileTaskPanel.obj, ArchSchedule.ArchScheduleTaskPanel.obj, ArchMaterial._ArchMaterialTaskPanel.obj, ArchReference.ArchReferenceTaskPanel.obj, ArchAxis._AxisTaskPanel.obj, ArchMaterial._ArchMultiMaterialTaskPanel.obj, ArchRoof._RoofTaskPanel.obj, ArchAxis.AxisSystemTaskPanel.obj, UpdateLabelExpressionVisitor.obj, ArchWindow._ArchWindowTaskPanel.obj, ArchSectionPlane.SectionPlaneTaskPanel.obj, ArchAxis.ArchGridTaskPanel.obj, ArchPanel.SheetTaskPanel.obj, ItemInfo.obj, ItemInfo2.obj, ArchComponent.ComponentTaskPanel.obj, DraftGui.FacebinderTaskPanel.obj, draftguitools.gui_lines.Line.oldWP, draftguitools.gui_base_original.DraftTool.planetrack, and draftguitools.gui_base.GuiCommandBase.planetrack.

◆ removeTemporaryObject()

def draftguitools.gui_lines.Line.removeTemporaryObject ( self )

Remove temporary object created.

References Gui::GraphvizView.doc, draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.doc, draftguitools.gui_base.GuiCommandSimplest.doc, ExpressionCompleterModel::Info.doc, App::RelabelDocumentExpressionVisitor.doc, draftguitools.gui_base_original.DraftTool.doc, App::DynamicProperty::PropData.doc, draftguitools.gui_base.GuiCommandBase.doc, App::LinkBaseExtension::PropInfo.doc, ItemInfo.doc, ItemInfo2.doc, importIFClegacy.IfcEntity.doc, Gui::ActiveObjectList::ObjectInfo.obj, ExpressionCompleterModel::Info.obj, draftguitools.gui_base_original.DraftTool.obj, App::Origin::OriginExtension.obj, Base::ObjectStatusLocker< Status, Object >.obj, Info.obj, ArchProfile.ProfileTaskPanel.obj, ArchSchedule.ArchScheduleTaskPanel.obj, ArchMaterial._ArchMaterialTaskPanel.obj, ArchReference.ArchReferenceTaskPanel.obj, ArchAxis._AxisTaskPanel.obj, ArchMaterial._ArchMultiMaterialTaskPanel.obj, ArchRoof._RoofTaskPanel.obj, ArchAxis.AxisSystemTaskPanel.obj, UpdateLabelExpressionVisitor.obj, ArchWindow._ArchWindowTaskPanel.obj, ArchSectionPlane.SectionPlaneTaskPanel.obj, ArchAxis.ArchGridTaskPanel.obj, ArchPanel.SheetTaskPanel.obj, ItemInfo.obj, ItemInfo2.obj, ArchComponent.ComponentTaskPanel.obj, and DraftGui.FacebinderTaskPanel.obj.

Referenced by draftguitools.gui_lines.Line.finish().

◆ undolast()

def draftguitools.gui_lines.Line.undolast ( self )

Undoes last line segment.

Reimplemented in draftguitools.gui_beziers.CubicBezCurve, draftguitools.gui_beziers.BezCurve, and draftguitools.gui_splines.BSpline.

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, Gui::ActiveObjectList::ObjectInfo.obj, ExpressionCompleterModel::Info.obj, draftguitools.gui_base_original.DraftTool.obj, App::Origin::OriginExtension.obj, Base::ObjectStatusLocker< Status, Object >.obj, Info.obj, ArchProfile.ProfileTaskPanel.obj, ArchSchedule.ArchScheduleTaskPanel.obj, ArchMaterial._ArchMaterialTaskPanel.obj, ArchReference.ArchReferenceTaskPanel.obj, ArchAxis._AxisTaskPanel.obj, ArchMaterial._ArchMultiMaterialTaskPanel.obj, ArchRoof._RoofTaskPanel.obj, ArchAxis.AxisSystemTaskPanel.obj, UpdateLabelExpressionVisitor.obj, ArchWindow._ArchWindowTaskPanel.obj, ArchSectionPlane.SectionPlaneTaskPanel.obj, ArchAxis.ArchGridTaskPanel.obj, ArchPanel.SheetTaskPanel.obj, ItemInfo.obj, ItemInfo2.obj, ArchComponent.ComponentTaskPanel.obj, and DraftGui.FacebinderTaskPanel.obj.

◆ wipe()

def draftguitools.gui_lines.Line.wipe ( self )

Remove all previous segments and starts from last point.

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, Gui::ActiveObjectList::ObjectInfo.obj, ExpressionCompleterModel::Info.obj, draftguitools.gui_base_original.DraftTool.obj, App::Origin::OriginExtension.obj, Base::ObjectStatusLocker< Status, Object >.obj, Info.obj, ArchProfile.ProfileTaskPanel.obj, ArchSchedule.ArchScheduleTaskPanel.obj, ArchMaterial._ArchMaterialTaskPanel.obj, ArchReference.ArchReferenceTaskPanel.obj, ArchAxis._AxisTaskPanel.obj, ArchMaterial._ArchMultiMaterialTaskPanel.obj, ArchRoof._RoofTaskPanel.obj, ArchAxis.AxisSystemTaskPanel.obj, UpdateLabelExpressionVisitor.obj, ArchWindow._ArchWindowTaskPanel.obj, ArchSectionPlane.SectionPlaneTaskPanel.obj, ArchAxis.ArchGridTaskPanel.obj, ArchPanel.SheetTaskPanel.obj, ItemInfo.obj, ItemInfo2.obj, ArchComponent.ComponentTaskPanel.obj, and DraftGui.FacebinderTaskPanel.obj.

Member Data Documentation

◆ call

draftguitools.gui_lines.Line.call

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.accept(), draftguitools.gui_selectplane.Draft_SelectPlane.finish(), and drafttaskpanels.task_shapestring.ShapeStringTaskPanel.reject().

◆ featureName

draftguitools.gui_lines.Line.featureName

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

◆ isWire

draftguitools.gui_lines.Line.isWire

Referenced by draftguitools.gui_lines.Line.drawSegment().

◆ node

draftguitools.gui_lines.Line.node

Referenced by draftviewproviders.view_dimension.ViewProviderLinearDimension.draw_dim_arrows(), draftviewproviders.view_dimension.ViewProviderAngularDimension.draw_dim_arrows(), draftviewproviders.view_dimension.ViewProviderLinearDimension.draw_dim_overshoot(), draftviewproviders.view_dimension.ViewProviderLinearDimension.draw_ext_overshoot(), draftviewproviders.view_dimension.ViewProviderLinearDimension.remove_dim_arrows(), draftviewproviders.view_dimension.ViewProviderAngularDimension.remove_dim_arrows(), draftviewproviders.view_dimension.ViewProviderLinearDimension.remove_dim_overshoot(), and draftviewproviders.view_dimension.ViewProviderLinearDimension.remove_ext_overshoot().

◆ obj

draftguitools.gui_lines.Line.obj

◆ oldWP

draftguitools.gui_lines.Line.oldWP

Referenced by draftguitools.gui_lines.Line.finish(), and draftguitools.gui_lines.Line.orientWP().

◆ point

draftguitools.gui_lines.Line.point

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.action(), draftguitools.gui_orthoarray.OrthoArray.click(), draftguitools.gui_polararray.PolarArray.click(), PathScripts.PathGetPoint.TaskPanel.getPoint(), draftguitools.gui_polararray.PolarArray.move(), and PathScripts.PathGetPoint.TaskPanel.updatePoint().

◆ pos

draftguitools.gui_lines.Line.pos

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

src/Mod/Draft/draftguitools/gui_lines.py

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ action()

◆ Activated()

◆ drawSegment()

◆ finish()

◆ GetResources()

◆ numericInput()

◆ orientWP()

◆ removeTemporaryObject()

◆ undolast()

◆ wipe()

Member Data Documentation

◆ call

◆ featureName

◆ isWire

◆ node

◆ obj

◆ oldWP

◆ point

◆ pos