Public Member Functions
def	Activated (self)

def	click (self, event_cb=None)

def	completed (self)

def	GetResources (self)

def	move (self, event_cb)

Public Member Functions inherited from draftguitools.gui_base.GuiCommandBase
def	commit (self, name, func)

def	finish (self)

def	IsActive (self)

Public Attributes
	callback_click

	callback_move

	command_name

	location

	mouse_event

	point

	ui

	view

Public Attributes inherited from draftguitools.gui_base.GuiCommandBase
	call

	commit_list

	doc

	planetrack

	view

Detailed Description

Gui command for the PolarArray tool.

Member Function Documentation

◆ Activated()

def draftguitools.gui_polararray.PolarArray.Activated ( self )

Execute when the command is called.

We add callbacks that connect the 3D view with
the widgets of the task panel.

◆ click()

def draftguitools.gui_polararray.PolarArray.click	(	self,
		event_cb = `None`
	)

Execute as a callback when the pointer clicks on the 3D view.

It should act as if the Enter key was pressed, or the OK button
was pressed in the task panel.

References Gui::PickedPoint.point, FaceQuadStruct::Side::Contact.point, draftguitools.gui_circulararray.CircularArray.point, draftguitools.gui_orthoarray.OrthoArray.point, draftguitools.gui_polararray.PolarArray.point, draftguitools.gui_points.Point.point, Gui::DAG::VertexProperty.point, draftguitools.gui_base_original.DraftTool.point, draftguitools.gui_arcs.Arc.point, draftguitools.gui_ellipses.Ellipse.point, draftguitools.gui_mirror.Mirror.point, draftguitools.gui_labels.Label.point, draftguitools.gui_lines.Line.point, draftguitools.gui_move.Move.point, draftguitools.gui_dimensions.Dimension.point, test.ui, Gui::Dialog::Clipping::Private.ui, Gui::Dialog::DlgAddProperty.ui, Gui::TaskBoxPosition.ui, Gui::Dialog::DlgProjectInformationImp.ui, draftguitools.gui_circulararray.CircularArray.ui, draftguitools.gui_orthoarray.OrthoArray.ui, draftguitools.gui_polararray.PolarArray.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::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::DlgSettingsMacroImp.ui, Gui::Dialog::DlgSettingsViewColor.ui, Gui::Dialog::Placement.ui, Gui::Dialog::DlgSettingsUnitsImp.ui, Gui::Dialog::DownloadManager.ui, draftguitools.gui_groups.AddToGroup.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, draftguitools.gui_groups.SetAutoGroup.ui, draftguitools.gui_edit.Edit.ui, Gui::LocationDialogImp< Ui >.ui, Gui::LocationImpUi< Ui >.ui, and Gui::LocationDialogUiImp.ui.

Referenced by draftguitools.gui_polararray.PolarArray.Activated().

◆ completed()

def draftguitools.gui_polararray.PolarArray.completed ( self )

Execute when the command is terminated.

We should remove the callbacks that were added to the 3D view
and then close the task panel.

References draftguitools.gui_circulararray.CircularArray.callback_click, draftguitools.gui_orthoarray.OrthoArray.callback_click, draftguitools.gui_polararray.PolarArray.callback_click, draftguitools.gui_polararray.PolarArray.callback_move, draftguitools.gui_circulararray.CircularArray.callback_move, draftguitools.gui_base.GuiCommandBase.finish(), draftguitools.gui_circulararray.CircularArray.location, draftguitools.gui_polararray.PolarArray.location, draftguitools.gui_orthoarray.OrthoArray.mouse_event, draftguitools.gui_circulararray.CircularArray.mouse_event, draftguitools.gui_polararray.PolarArray.mouse_event, Gui::Dialog::Clipping::Private.view, Gui::PointMarker.view, Gui::GraphvizView.view, Gui::ItemViewSelection.view, and draftguitools.gui_base.GuiCommandBase.view.

◆ GetResources()

def draftguitools.gui_polararray.PolarArray.GetResources ( self )

Set icon, menu and tooltip.

◆ move()

def draftguitools.gui_polararray.PolarArray.move	(	self,
		event_cb
	)

Execute as a callback when the pointer moves in the 3D view.

It should automatically update the coordinates in the widgets
of the task panel.

References Gui::PickedPoint.point, FaceQuadStruct::Side::Contact.point, draftguitools.gui_circulararray.CircularArray.point, draftguitools.gui_orthoarray.OrthoArray.point, draftguitools.gui_polararray.PolarArray.point, draftguitools.gui_points.Point.point, Gui::DAG::VertexProperty.point, draftguitools.gui_base_original.DraftTool.point, draftguitools.gui_arcs.Arc.point, draftguitools.gui_ellipses.Ellipse.point, draftguitools.gui_mirror.Mirror.point, draftguitools.gui_labels.Label.point, draftguitools.gui_lines.Line.point, draftguitools.gui_move.Move.point, draftguitools.gui_dimensions.Dimension.point, test.ui, Gui::Dialog::Clipping::Private.ui, Gui::Dialog::DlgAddProperty.ui, Gui::TaskBoxPosition.ui, Gui::Dialog::DlgProjectInformationImp.ui, draftguitools.gui_circulararray.CircularArray.ui, draftguitools.gui_orthoarray.OrthoArray.ui, draftguitools.gui_polararray.PolarArray.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::DlgSettingsMacroImp.ui, Gui::Dialog::DlgSettingsViewColor.ui, Gui::Dialog::Placement.ui, draftguitools.gui_groups.AddToGroup.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, draftguitools.gui_groups.SetAutoGroup.ui, draftguitools.gui_edit.Edit.ui, Gui::LocationDialogImp< Ui >.ui, Gui::LocationImpUi< Ui >.ui, and Gui::LocationDialogUiImp.ui.

Referenced by draftguitools.gui_polararray.PolarArray.Activated().

Member Data Documentation

◆ callback_click

draftguitools.gui_polararray.PolarArray.callback_click

Referenced by draftguitools.gui_polararray.PolarArray.Activated(), and draftguitools.gui_polararray.PolarArray.completed().

◆ callback_move

draftguitools.gui_polararray.PolarArray.callback_move

Referenced by draftguitools.gui_polararray.PolarArray.Activated(), and draftguitools.gui_polararray.PolarArray.completed().

◆ command_name

draftguitools.gui_polararray.PolarArray.command_name

Referenced by draftguitools.gui_polararray.PolarArray.Activated().

◆ location

draftguitools.gui_polararray.PolarArray.location

Referenced by draftguitools.gui_polararray.PolarArray.Activated(), automotive_design.revolved_area_solid.axis_line(), automotive_design.surface_of_revolution.axis_line(), automotive_design.revolved_face_solid.axis_line(), ifc2x3.ifcsurfaceofrevolution.axisline(), ifc4.ifcsurfaceofrevolution.axisline(), ifc2x3.ifcrevolvedareasolid.axisline(), ifc4.ifcrevolvedareasolid.axisline(), ifc4.ifcrevolvedareasolid.axisstartinxy(), draftguitools.gui_polararray.PolarArray.completed(), ifc2x3.ifcplacement.dim(), ifc4.ifcplacement.dim(), ifc2x3.ifcexternalreference.wr1(), ifc4.ifcexternalreference.wr1(), and ifc2x3.ifcrevolvedareasolid.wr31().

◆ mouse_event

draftguitools.gui_polararray.PolarArray.mouse_event

Referenced by draftguitools.gui_polararray.PolarArray.Activated(), and draftguitools.gui_polararray.PolarArray.completed().

◆ point

draftguitools.gui_polararray.PolarArray.point

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

◆ ui

draftguitools.gui_polararray.PolarArray.ui

Referenced by draftguitools.gui_polararray.PolarArray.Activated(), DraftGui.DraftToolBar.changeEvent(), draftguitools.gui_polararray.PolarArray.click(), and draftguitools.gui_polararray.PolarArray.move().

◆ view

draftguitools.gui_polararray.PolarArray.view

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.accept(), draftguitools.gui_selectplane.Draft_SelectPlane.finish(), PathScripts.PathGetPoint.TaskPanel.getPoint(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickAlign(), drafttaskpanels.task_shapestring.ShapeStringTaskPanel.reject(), and PathScripts.PathGetPoint.TaskPanel.removeGlobalCallbacks().

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

src/Mod/Draft/draftguitools/gui_polararray.py

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ Activated()

◆ click()

◆ completed()

◆ GetResources()

◆ move()

Member Data Documentation

◆ callback_click

◆ callback_move

◆ command_name

◆ location

◆ mouse_event

◆ point

◆ ui

◆ view