Public Member Functions
def	action (self, arg)

def	Activated (self)

def	build_copy_subelements_command (self)

def	build_scale_subelements_command (self)

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

def	get_object_selection (self)

def	GetResources (self)

def	handle_mouse_click_event (self)

def	handle_mouse_move_event (self, arg)

def	is_scalable (self, obj)

def	numericInput (self, numx, numy, numz)

def	pickRef (self)

def	proceed (self)

def	scale (self)

def	scale_object (self)

def	scale_subelements (self)

def	scale_with_clone (self)

def	scaleGhost (self, x, y, z, rel)

def	set_ghosts (self)

def	set_subelement_ghosts (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	finish (self, close=False)

def	getStrings (self, addrot=None)

def	IsActive (self)

Public Attributes
	call

	center

	delta

	ghosts

	name

	node

	pickmode

	point

	refs

	selected_objects

	selected_subelements

	task

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

This tool scales the selected objects from a base point.

Member Function Documentation

◆ action()

def draftguitools.gui_scale.Scale.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.

◆ Activated()

def draftguitools.gui_scale.Scale.Activated ( self )

Execute when the command is called.

◆ build_copy_subelements_command()

def draftguitools.gui_scale.Scale.build_copy_subelements_command ( self )

Build the string to commit to copy the subelements.

References draftguitools.gui_polygons.Polygon.center, draftguitools.gui_arcs.Arc.center, draftguitools.gui_rotate.Rotate.center, draftguitools.gui_offset.Offset.center, draftguitools.gui_dimensions.Dimension.center, draftguitools.gui_scale.Scale.center, draftguitools.gui_scale.Scale.delta, draftguitools.gui_rotate.Rotate.selected_subelements, draftguitools.gui_move.Move.selected_subelements, draftguitools.gui_scale.Scale.selected_subelements, and DraftVecUtils.toString().

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

◆ build_scale_subelements_command()

def draftguitools.gui_scale.Scale.build_scale_subelements_command ( self )

Build the strings to commit to scale the subelements.

References draftguitools.gui_polygons.Polygon.center, draftguitools.gui_arcs.Arc.center, draftguitools.gui_rotate.Rotate.center, draftguitools.gui_offset.Offset.center, draftguitools.gui_dimensions.Dimension.center, draftguitools.gui_scale.Scale.center, draftguitools.gui_scale.Scale.delta, draftguitools.gui_rotate.Rotate.selected_subelements, draftguitools.gui_move.Move.selected_subelements, draftguitools.gui_scale.Scale.selected_subelements, and DraftVecUtils.toString().

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

◆ finish()

def draftguitools.gui_scale.Scale.finish	(	self,
		closed = `False`,
		cont = `False`
	)

Terminate the operation.

References draftguitools.gui_rotate.Rotate.ghosts, draftguitools.gui_move.Move.ghosts, and draftguitools.gui_scale.Scale.ghosts.

◆ get_object_selection()

def draftguitools.gui_scale.Scale.get_object_selection ( self )

Get object selection and proceed if successful.

References draftguitools.gui_facebinders.Facebinder.proceed(), draftguitools.gui_downgrade.Downgrade.proceed(), draftguitools.gui_draft2sketch.Draft2Sketch.proceed(), draftguitools.gui_mirror.Mirror.proceed(), draftguitools.gui_join.Join.proceed(), draftguitools.gui_rotate.Rotate.proceed(), draftguitools.gui_array_simple.Array.proceed(), draftguitools.gui_clone.Clone.proceed(), draftguitools.gui_offset.Offset.proceed(), draftguitools.gui_move.Move.proceed(), draftguitools.gui_scale.Scale.proceed(), draftguitools.gui_drawing.Drawing.proceed(), draftguitools.gui_groups.AddToGroup.proceed(), draftguitools.gui_pointarray.PointArray.proceed(), draftguitools.gui_patharray.PathArray.proceed(), draftguitools.gui_edit.Edit.proceed(), draftguitools.gui_groups.SetAutoGroup.proceed(), 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::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_scale.Scale.GetResources ( self )

Set icon, menu and tooltip.

◆ handle_mouse_click_event()

def draftguitools.gui_scale.Scale.handle_mouse_click_event ( self )

Handle the mouse click event.

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

◆ handle_mouse_move_event()

def draftguitools.gui_scale.Scale.handle_mouse_move_event	(	self,
		arg
	)

Handle the mouse event of movement.

References draftguitools.gui_rotate.Rotate.ghosts, draftguitools.gui_move.Move.ghosts, draftguitools.gui_scale.Scale.ghosts, Gui::PickedPoint.point, FaceQuadStruct::Side::Contact.point, Gui::DAG::VertexProperty.point, draftguitools.gui_base_original.DraftTool.point, and draftguitools.gui_arcs.Arc.point.

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

◆ is_scalable()

def draftguitools.gui_scale.Scale.is_scalable	(	self,
		obj
	)

Return True only for the supported objects.

Currently it only supports `Rectangle`, `Wire`, `Annotation`
and `BSpline`.

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

◆ numericInput()

def draftguitools.gui_scale.Scale.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().

◆ pickRef()

def draftguitools.gui_scale.Scale.pickRef ( self )

Pick a point of reference.

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, and draftguitools.gui_scale.Scale.pickmode.

◆ proceed()

def draftguitools.gui_scale.Scale.proceed ( self )

Proceed with execution of the command after selection.

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_scale.Scale.get_object_selection(), and draftguitools.gui_subelements.SubelementHighlight.get_selection().

◆ scale()

def draftguitools.gui_scale.Scale.scale ( self )

Perform the scale of the object.

Scales the subelements, or with a clone, or just general scaling.

◆ scale_object()

def draftguitools.gui_scale.Scale.scale_object ( self )

Scale the object.

References draftguitools.gui_polygons.Polygon.center, draftguitools.gui_arcs.Arc.center, draftguitools.gui_rotate.Rotate.center, draftguitools.gui_offset.Offset.center, draftguitools.gui_dimensions.Dimension.center, draftguitools.gui_scale.Scale.center, Gui::MacroManager.commit(), draftguitools.gui_base_original.DraftTool.commit(), draftguitools.gui_base.GuiCommandBase.commit(), draftguitools.gui_scale.Scale.delta, draftguitools.gui_scale.Scale.is_scalable(), draftguitools.gui_rotate.Rotate.selected_objects, draftguitools.gui_move.Move.selected_objects, draftguitools.gui_scale.Scale.selected_objects, draftguitools.gui_scale.Scale.task, and DraftVecUtils.toString().

◆ scale_subelements()

def draftguitools.gui_scale.Scale.scale_subelements ( self )

Scale only the subelements if the appropriate option is set.

The subelements operations only really work with polylines (Wires)
because internally the functions `scaleVertex` and `scaleEdge`
only work with polylines that have a `Points` property.

BUG: the code should not cause an error. It should check that
the selected object is not a rectangle or another object
that can't be used with `scaleVertex` and `scaleEdge`.

References draftguitools.gui_move.Move.build_copy_subelements_command(), draftguitools.gui_scale.Scale.build_copy_subelements_command(), draftguitools.gui_rotate.Rotate.build_copy_subelements_command(), draftguitools.gui_scale.Scale.build_scale_subelements_command(), Gui::MacroManager.commit(), draftguitools.gui_base_original.DraftTool.commit(), draftguitools.gui_base.GuiCommandBase.commit(), and draftguitools.gui_scale.Scale.task.

◆ scale_with_clone()

def draftguitools.gui_scale.Scale.scale_with_clone ( self )

Scale with clone.

References Gui::MacroManager.commit(), draftguitools.gui_base_original.DraftTool.commit(), draftguitools.gui_base.GuiCommandBase.commit(), draftguitools.gui_scale.Scale.delta, draftguitools.gui_rotate.Rotate.selected_objects, draftguitools.gui_move.Move.selected_objects, draftguitools.gui_scale.Scale.selected_objects, draftguitools.gui_scale.Scale.task, and DraftVecUtils.toString().

◆ scaleGhost()

def draftguitools.gui_scale.Scale.scaleGhost	(	self,
		x,
		y,
		z,
		rel
	)

Scale the preview of the object.

References draftguitools.gui_rotate.Rotate.ghosts, draftguitools.gui_move.Move.ghosts, draftguitools.gui_scale.Scale.ghosts, Gui::Dialog::Clipping::Private.node, draftguitools.gui_base_original.DraftTool.node, Gui::AxisOrigin.node, uvPtStruct.node, StdMeshers_Quadrangle_2D::ForcedPoint.node, and draftguitools.gui_arcs.Arc.node.

◆ set_ghosts()

def draftguitools.gui_scale.Scale.set_ghosts ( self )

Set the previews of the objects to scale.

References draftguitools.gui_rotate.Rotate.ghosts, draftguitools.gui_move.Move.ghosts, draftguitools.gui_scale.Scale.ghosts, draftguitools.gui_rotate.Rotate.selected_objects, draftguitools.gui_move.Move.selected_objects, draftguitools.gui_scale.Scale.selected_objects, draftguitools.gui_scale.Scale.set_subelement_ghosts(), draftguitools.gui_move.Move.set_subelement_ghosts(), draftguitools.gui_rotate.Rotate.set_subelement_ghosts(), 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::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, 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_scale.Scale.handle_mouse_click_event().

◆ set_subelement_ghosts()

def draftguitools.gui_scale.Scale.set_subelement_ghosts ( self )

Set the previews of the subelements from an object to scale.

References draftguitools.gui_rotate.Rotate.ghosts, draftguitools.gui_move.Move.ghosts, draftguitools.gui_scale.Scale.ghosts, draftguitools.gui_rotate.Rotate.selected_subelements, draftguitools.gui_scale.Scale.selected_subelements, and draftguitools.gui_move.Move.selected_subelements.

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

Member Data Documentation

◆ call

draftguitools.gui_scale.Scale.call

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

◆ center

draftguitools.gui_scale.Scale.center

◆ delta

draftguitools.gui_scale.Scale.delta

Referenced by draftguitools.gui_scale.Scale.build_copy_subelements_command(), draftguitools.gui_scale.Scale.build_scale_subelements_command(), draftguitools.gui_scale.Scale.scale_object(), draftguitools.gui_scale.Scale.scale_with_clone(), Mod.Test.UnitTests.UnitBasicCases.testEnergy(), Mod.Test.UnitTests.UnitBasicCases.testImperial(), Mod.Test.UnitTests.UnitBasicCases.testSchemes(), and Mod.Test.UnitTests.UnitBasicCases.testVoltage().

◆ ghosts

draftguitools.gui_scale.Scale.ghosts

Referenced by draftguitools.gui_scale.Scale.finish(), draftguitools.gui_scale.Scale.handle_mouse_click_event(), draftguitools.gui_scale.Scale.handle_mouse_move_event(), draftguitools.gui_scale.Scale.scaleGhost(), draftguitools.gui_scale.Scale.set_ghosts(), and draftguitools.gui_scale.Scale.set_subelement_ghosts().

◆ name

draftguitools.gui_scale.Scale.name

Referenced by prototype.Node.addtofreecad(), drafttaskpanels.task_polararray.TaskPanelPolarArray.create_object(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.create_object(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.create_object(), gzip_utf8.GzipFile.filename(), ifc4.ifcapproval.hasidentifierorname(), femsolver.elmer.sifio.Section.keys(), automotive_design.si_unit.named_unit_dimensions(), Mod.PartDesign.WizardShaft.SegmentFunction.SegmentFunction.output(), prototype.Node.pprint(), prototype.Node.pprint2(), PathScripts.PathSetupSheetGui.OpTaskPanel.propertyGroup(), PathScripts.PathSetupSheetGui.OpTaskPanel.propertyName(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.reject(), drafttaskpanels.task_polararray.TaskPanelPolarArray.reject(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.reject(), ifc2x3.ifcexternalreference.wr1(), ifc4.ifcexternalreference.wr1(), ifc2x3.ifcdocumentreference.wr1(), ifc4.ifcdocumentreference.wr1(), and automotive_design.general_property_association.wr2().

◆ node

draftguitools.gui_scale.Scale.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().

◆ pickmode

draftguitools.gui_scale.Scale.pickmode

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

◆ point

draftguitools.gui_scale.Scale.point

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.action(), PathScripts.PathGetPoint.TaskPanel.getPoint(), and PathScripts.PathGetPoint.TaskPanel.updatePoint().

◆ refs

draftguitools.gui_scale.Scale.refs

◆ selected_objects

draftguitools.gui_scale.Scale.selected_objects

Referenced by draftguitools.gui_scale.Scale.scale_object(), draftguitools.gui_scale.Scale.scale_with_clone(), and draftguitools.gui_scale.Scale.set_ghosts().

◆ selected_subelements

draftguitools.gui_scale.Scale.selected_subelements

Referenced by draftguitools.gui_scale.Scale.build_copy_subelements_command(), draftguitools.gui_scale.Scale.build_scale_subelements_command(), and draftguitools.gui_scale.Scale.set_subelement_ghosts().

◆ task

draftguitools.gui_scale.Scale.task

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.createObject(), draftguitools.gui_scale.Scale.scale_object(), draftguitools.gui_scale.Scale.scale_subelements(), draftguitools.gui_scale.Scale.scale_with_clone(), and drafttaskpanels.task_shapestring.ShapeStringTaskPanel.setPoint().

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

src/Mod/Draft/draftguitools/gui_scale.py

Public Member Functions

Public Attributes