FreeCAD: draftguitools.gui_offset.Offset Class Reference

Public Member Functions
def action (self, arg)

def Activated (self)

def finish (self, closed=False)

def GetResources (self)

def numericRadius (self, rad)

def proceed (self)

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 getStrings (self, addrot=None)

def IsActive (self)

Public Attributes
arctrack

call

center

constrainSeg

dvec

extendedCopy

faces

ghost

linetrack

mode

npts

running

sel

shape

step

Public Attributes inherited from draftguitools.gui_base_original.Modifier
copymode

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 Offset tool.

Member Function Documentation

◆ action()

def draftguitools.gui_offset.Offset.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.

References DraftVecUtils.angle(), draftguitools.gui_arcs.Arc.center, draftguitools.gui_offset.Offset.center, draftguitools.gui_dimensions.Dimension.center, Gui::MacroManager.commit(), draftguitools.gui_base_original.DraftTool.commit(), draftguitools.gui_base.GuiCommandBase.commit(), draftguitools.gui_offset.Offset.constrainSeg, draftguitools.gui_offset.Offset.dvec, draftguitools.gui_base_original.DraftTool.extendedCopy, zipios::GZIPOutputStreambuf.finish(), zipios::GZIPOutputStream.finish(), Gui::SoFCDB.finish(), zipios::ZipOutputStreambuf.finish(), Gui::SoFCBackgroundGradient.finish(), Gui::SoFCColorLegend.finish(), zipios::ZipOutputStream.finish(), Gui::SoFCColorGradient.finish(), Gui::SoFCColorBarBase.finish(), Gui::SoFCHighlightAction.finish(), Gui::SoFCUnifiedSelection.finish(), Gui::SoFCSelection.finish(), Gui::SoFCSelectionAction.finish(), draftguitools.gui_arcs.Arc.finish(), Gui::SoFCBoundingBox.finish(), Gui::SoFCEnableSelectionAction.finish(), Gui::SoSkipBoundingGroup.finish(), Gui::SoFCEnableHighlightAction.finish(), Gui::SoFCColorBar.finish(), Gui::SoFCPathAnnotation.finish(), draftguitools.gui_base_original.DraftTool.finish(), Gui::SoFCSelectionColorAction.finish(), Gui::SoFCSeparator.finish(), Gui::SoFCHighlightColorAction.finish(), draftguitools.gui_base.GuiCommandBase.finish(), Gui::SoFCSelectionRoot.finish(), Gui::SoFCDocumentAction.finish(), Gui::ManualAlignment.finish(), Gui::SoFCDocumentObjectAction.finish(), Gui::SoUpdateVBOAction.finish(), DraftGui.DraftToolBar.finish(), ifc4.ifcworktime.finish, draftguitools.gui_mirror.Mirror.ghost, draftguitools.gui_labels.Label.ghost, draftguitools.gui_offset.Offset.ghost, draftguitools.gui_drawing.Drawing.ghost, draftguitools.gui_edit.Edit.ghost, draftguitools.gui_offset.Offset.linetrack, draftguitools.gui_arcs.Arc.linetrack, Base::gzstreambuf.mode, draftguitools.gui_offset.Offset.mode, Gui::SoSkipBoundingGroup.mode, Gui::FileChooser.mode, draftguitools.gui_offset.Offset.npts, Gui::PickedPoint.point, FaceQuadStruct::Side::Contact.point, Gui::DAG::VertexProperty.point, draftguitools.gui_base_original.DraftTool.point, draftguitools.gui_arcs.Arc.point, DraftVecUtils.rotate(), draftguitools.gui_labels.Label.sel, draftguitools.gui_mirror.Mirror.sel, draftguitools.gui_offset.Offset.sel, ArchWindow._CommandWindow.sel, draftguitools.gui_offset.Offset.shape, 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, 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.

◆ Activated()

def draftguitools.gui_offset.Offset.Activated ( self )

Execute when the command is called.

◆ finish()

def draftguitools.gui_offset.Offset.finish	(		self,
			closed = `False`
	)

Finish the offset operation.

Reimplemented from draftguitools.gui_base_original.DraftTool.

References draftguitools.gui_mirror.Mirror.ghost, draftguitools.gui_labels.Label.ghost, draftguitools.gui_offset.Offset.ghost, draftguitools.gui_drawing.Drawing.ghost, draftguitools.gui_edit.Edit.ghost, draftguitools.gui_offset.Offset.linetrack, draftguitools.gui_arcs.Arc.linetrack, draftguitools.gui_line_add_delete.AddPoint.running, ArchNesting.Nester.running, draftguitools.gui_offset.Offset.running, draftguitools.gui_line_add_delete.DelPoint.running, App::PropertyExpressionEngine.running, draftguitools.gui_edit.Edit.running, Gui::GUISingleApplication::Private.running, and Gui::PythonDebuggerP.running.

Referenced by drafttaskpanels.task_polararray.TaskPanelPolarArray.accept(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.accept(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.accept(), draftguitools.gui_selectplane.Draft_SelectPlane.action(), draftguitools.gui_selectplane.Draft_SelectPlane.checkSelection(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickAlign(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickAuto(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickCenter(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickFront(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickMove(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickPrevious(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickSide(), draftguitools.gui_selectplane.Draft_SelectPlane.onClickTop(), draftguitools.gui_selectplane.Draft_SelectPlane.reject(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.reject(), drafttaskpanels.task_polararray.TaskPanelPolarArray.reject(), and drafttaskpanels.task_circulararray.TaskPanelCircularArray.reject().

◆ GetResources()

def draftguitools.gui_offset.Offset.GetResources ( self )

Set icon, menu and tooltip.

◆ numericRadius()

def draftguitools.gui_offset.Offset.numericRadius	(		self,
			rad
	)

Validate the radius entry field in the user interface. This function is called by the toolbar or taskpanel interface when a valid radius has been entered in the input field.

References Gui::MacroManager.commit(), draftguitools.gui_base_original.DraftTool.commit(), draftguitools.gui_base.GuiCommandBase.commit(), draftguitools.gui_offset.Offset.dvec, zipios::GZIPOutputStreambuf.finish(), zipios::GZIPOutputStream.finish(), Gui::SoFCDB.finish(), Gui::SoFCBackgroundGradient.finish(), zipios::ZipOutputStreambuf.finish(), Gui::SoFCColorLegend.finish(), zipios::ZipOutputStream.finish(), Gui::SoFCColorGradient.finish(), Gui::SoFCColorBarBase.finish(), Gui::SoFCHighlightAction.finish(), Gui::SoFCUnifiedSelection.finish(), Gui::SoFCSelection.finish(), Gui::SoFCSelectionAction.finish(), draftguitools.gui_arcs.Arc.finish(), Gui::SoFCBoundingBox.finish(), Gui::SoFCEnableSelectionAction.finish(), Gui::SoSkipBoundingGroup.finish(), Gui::SoFCEnableHighlightAction.finish(), Gui::SoFCColorBar.finish(), Gui::SoFCPathAnnotation.finish(), Gui::SoFCSelectionColorAction.finish(), draftguitools.gui_base_original.DraftTool.finish(), Gui::SoFCSeparator.finish(), Gui::SoFCHighlightColorAction.finish(), draftguitools.gui_base.GuiCommandBase.finish(), Gui::SoFCSelectionRoot.finish(), Gui::SoFCDocumentAction.finish(), Gui::ManualAlignment.finish(), Gui::SoFCDocumentObjectAction.finish(), Gui::SoUpdateVBOAction.finish(), DraftGui.DraftToolBar.finish(), ifc4.ifcworktime.finish, draftguitools.gui_mirror.Mirror.ghost, draftguitools.gui_labels.Label.ghost, draftguitools.gui_offset.Offset.ghost, draftguitools.gui_drawing.Drawing.ghost, draftguitools.gui_edit.Edit.ghost, Base::gzstreambuf.mode, draftguitools.gui_offset.Offset.mode, Gui::SoSkipBoundingGroup.mode, Gui::FileChooser.mode, draftguitools.gui_labels.Label.sel, draftguitools.gui_mirror.Mirror.sel, draftguitools.gui_offset.Offset.sel, ArchWindow._CommandWindow.sel, draftguitools.gui_offset.Offset.shape, 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::Dialog::TextureMapping.ui, Gui::ElementColors::Private.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::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::DownloadManager.ui, Gui::Dialog::DlgSettingsUnitsImp.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.

◆ proceed()

def draftguitools.gui_offset.Offset.proceed ( self )

Proceed with the command if one object was selected.

References draftguitools.gui_array_simple.Array.call, draftguitools.gui_arcs.Arc.call, draftguitools.gui_base_original.DraftTool.call, draftguitools.gui_base.GuiCommandBase.call, 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.

Referenced by draftguitools.gui_split.Split.action(), draftguitools.gui_rotate.Rotate.get_object_selection(), draftguitools.gui_scale.Scale.get_object_selection(), and draftguitools.gui_subelements.SubelementHighlight.get_selection().

Member Data Documentation

◆ arctrack

draftguitools.gui_offset.Offset.arctrack

Referenced by draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_polygons.Polygon.numericInput(), draftguitools.gui_rotate.Rotate.numericInput(), and draftguitools.gui_rotate.Rotate.numericRadius().

◆ call

draftguitools.gui_offset.Offset.call

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

◆ center

draftguitools.gui_offset.Offset.center

Referenced by drafttaskpanels.task_polararray.TaskPanelPolarArray.accept(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.accept(), draftguitools.gui_polygons.Polygon.action(), draftguitools.gui_offset.Offset.action(), draftguitools.gui_scale.Scale.build_copy_subelements_command(), draftguitools.gui_rotate.Rotate.build_copy_subelements_command(), draftguitools.gui_rotate.Rotate.build_rotate_subelements_command(), draftguitools.gui_scale.Scale.build_scale_subelements_command(), drafttaskpanels.task_polararray.TaskPanelPolarArray.create_object(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.create_object(), draftguitools.gui_polygons.Polygon.drawPolygon(), PathScripts.PathDressupAxisMap.ObjectDressup.execute(), draftguitools.gui_rotate.Rotate.handle_mouse_move_event(), draftguitools.gui_polygons.Polygon.numericInput(), draftguitools.gui_rotate.Rotate.numericInput(), draftguitools.gui_polygons.Polygon.numericRadius(), PathScripts.PathDressupAxisMap.ObjectDressup.onChanged(), drafttaskpanels.task_polararray.TaskPanelPolarArray.print_messages(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.print_messages(), drafttaskpanels.task_polararray.TaskPanelPolarArray.reset_point(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.reset_point(), draftguitools.gui_rotate.Rotate.rotate_object(), draftguitools.gui_scale.Scale.scale_object(), draftguitools.gui_rotate.Rotate.set_center(), and draftguitools.gui_rotate.Rotate.set_rotation_angle().

◆ constrainSeg

draftguitools.gui_offset.Offset.constrainSeg

Referenced by draftguitools.gui_offset.Offset.action().

◆ dvec

draftguitools.gui_offset.Offset.dvec

Referenced by draftguitools.gui_offset.Offset.action(), and draftguitools.gui_offset.Offset.numericRadius().

◆ extendedCopy

draftguitools.gui_offset.Offset.extendedCopy

◆ faces

draftguitools.gui_offset.Offset.faces

◆ ghost

draftguitools.gui_offset.Offset.ghost

Referenced by draftguitools.gui_offset.Offset.action(), draftguitools.gui_offset.Offset.finish(), draftguitools.gui_trimex.Trimex.finish(), draftguitools.gui_offset.Offset.numericRadius(), draftguitools.gui_trimex.Trimex.redraw(), and draftguitools.gui_trimex.Trimex.trimObject().

◆ linetrack

draftguitools.gui_offset.Offset.linetrack

Referenced by draftguitools.gui_offset.Offset.action(), draftguitools.gui_offset.Offset.finish(), and draftguitools.gui_trimex.Trimex.finish().

◆ mode

draftguitools.gui_offset.Offset.mode

Referenced by draftguitools.gui_offset.Offset.action(), gzip_utf8.GzipFile.close(), Commands.SphereCreator.enter(), gzip_utf8.GzipFile.filename(), gzip_utf8.GzipFile.flush(), Commands.SphereCreator.leave(), draftguitools.gui_offset.Offset.numericRadius(), gzip_utf8.GzipFile.read(), gzip_utf8.GzipFile.readable(), gzip_utf8.GzipFile.rewind(), gzip_utf8.GzipFile.seek(), gzip_utf8.GzipFile.writable(), and gzip_utf8.GzipFile.write().

◆ npts

draftguitools.gui_offset.Offset.npts

Referenced by draftguitools.gui_offset.Offset.action().

◆ running

draftguitools.gui_offset.Offset.running

Referenced by shipHydrostatics.TaskPanel.TaskPanel.accept(), draftguitools.gui_wire2spline.WireToBSpline.Activated(), shipHydrostatics.TaskPanel.TaskPanel.externalFaces(), draftguitools.gui_offset.Offset.finish(), draftguitools.gui_snapper.Snapper.off(), shipHydrostatics.TaskPanel.TaskPanel.reject(), draftguitools.gui_snapper.Snapper.snap(), draftguitools.gui_snapper.Snapper.snapToObject(), and femsolver.task.Task.start().

◆ sel

draftguitools.gui_offset.Offset.sel

Referenced by draftguitools.gui_offset.Offset.action(), and draftguitools.gui_offset.Offset.numericRadius().

◆ shape

draftguitools.gui_offset.Offset.shape

Referenced by draftguitools.gui_offset.Offset.action(), PathScripts.PathSurfaceSupport.PathGeometryGenerator.generatePathGeometry(), and draftguitools.gui_offset.Offset.numericRadius().

◆ step

draftguitools.gui_offset.Offset.step

Referenced by draftguitools.gui_stretch.Stretch.action(), draftguitools.gui_stretch.Stretch.addPoint(), draftguitools.gui_rotate.Rotate.handle_mouse_click_event(), draftguitools.gui_polygons.Polygon.numericInput(), draftguitools.gui_rotate.Rotate.numericInput(), and draftguitools.gui_rotate.Rotate.numericRadius().

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

src/Mod/Draft/draftguitools/gui_offset.py