Public Member Functions
def	action (self, arg)

def	Activated (self)

def	createObject (self)

def	createOnMeasures (self)

def	finish (self, closed=False)

def	GetResources (self)

def	hasMeasures (self)

def	numericInput (self, numx, numy, numz)

def	selectEdge (self)

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

def	IsActive (self)

Public Attributes
	altdown

	angledata

	arcmode

	arctrack

	call

	center

	cont

	dimtrack

	dir

	edges

	force

	indices

	info

	link

	max

	node

	point

	point2

	pts

	selectmode

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

This includes at the moment linear, radial, diametrical,
and angular dimensions depending on the selected object
and the modifier key (ALT) used.

Maybe in the future each type can be in its own class,
and they can inherit their basic properties from a parent class.

Member Function Documentation

◆ action()

def draftguitools.gui_dimensions.Dimension.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_dimensions.Dimension.Activated ( self )

Execute when the command is called.

◆ createObject()

def draftguitools.gui_dimensions.Dimension.createObject ( self )

Create the actual object in the current document.

References draftguitools.gui_dimensions.Dimension.angledata, draftguitools.gui_dimensions.Dimension.arcmode, draftguitools.gui_arcs.Arc.center, draftguitools.gui_dimensions.Dimension.center, Gui::MacroManager.commit(), draftguitools.gui_base_original.DraftTool.commit(), draftguitools.gui_base.GuiCommandBase.commit(), draftguitools.gui_dimensions.Dimension.cont, Gui::NetworkRetrieverP.dir, draftguitools.gui_dimensions.Dimension.dir, draftguitools.gui_dimensions.Dimension.edges, draftguitools.gui_dimensions.Dimension.force, draftguitools.gui_dimensions.Dimension.link, Gui::PropertyEditor::LinkSelection.link, Gui::PropertyEditor::LinkLabel.link, 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, 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::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, 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.

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.accept(), draftguitools.gui_ellipses.Ellipse.appendPoint(), draftguitools.gui_rectangles.Rectangle.appendPoint(), and draftguitools.gui_dimensions.Dimension.numericInput().

◆ createOnMeasures()

def draftguitools.gui_dimensions.Dimension.createOnMeasures ( self )

Create on measurement objects.

References Gui::MacroManager.commit(), draftguitools.gui_base_original.DraftTool.commit(), draftguitools.gui_base.GuiCommandBase.commit(), and DraftVecUtils.toString().

◆ finish()

def draftguitools.gui_dimensions.Dimension.finish	(	self,
		closed = `False`
	)

Terminate the operation.

Reimplemented from draftguitools.gui_base_original.DraftTool.

References draftguitools.gui_arcs.Arc.arctrack, draftguitools.gui_dimensions.Dimension.arctrack, draftguitools.gui_dimensions.Dimension.cont, draftguitools.gui_dimensions.Dimension.dimtrack, Gui::NetworkRetrieverP.dir, draftguitools.gui_dimensions.Dimension.dir, 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.

◆ GetResources()

def draftguitools.gui_dimensions.Dimension.GetResources ( self )

Set icon, menu and tooltip.

◆ hasMeasures()

def draftguitools.gui_dimensions.Dimension.hasMeasures ( self )

Check if measurement objects are selected.

Referenced by draftguitools.gui_dimensions.Dimension.Activated().

◆ numericInput()

def draftguitools.gui_dimensions.Dimension.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.

References draftguitools.gui_dimensions.Dimension.cont, draftguitools.gui_dimensions.Dimension.createObject(), draftguitools.gui_dimensions.Dimension.dimtrack, 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(), Gui::SoFCSelectionColorAction.finish(), draftguitools.gui_base_original.DraftTool.finish(), Gui::SoFCSeparator.finish(), draftguitools.gui_base.GuiCommandBase.finish(), Gui::SoFCHighlightColorAction.finish(), Gui::SoFCSelectionRoot.finish(), Gui::SoFCDocumentAction.finish(), Gui::ManualAlignment.finish(), Gui::SoFCDocumentObjectAction.finish(), Gui::SoUpdateVBOAction.finish(), DraftGui.DraftToolBar.finish(), ifc4.ifcworktime.finish, 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::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.handle_mouse_click_event().

◆ selectEdge()

def draftguitools.gui_dimensions.Dimension.selectEdge ( self )

Toggle the select mode to the opposite state.

References draftguitools.gui_dimensions.Dimension.selectmode.

◆ setFromSelection()

def draftguitools.gui_dimensions.Dimension.setFromSelection ( self )

Fill the nodes according to the selected geometry.

References draftguitools.gui_dimensions.Dimension.arcmode, draftguitools.gui_dimensions.Dimension.edges, draftguitools.gui_dimensions.Dimension.indices, Gui::SoGLSelectAction.indices, draftguitools.gui_dimensions.Dimension.link, Gui::PropertyEditor::LinkSelection.link, Gui::PropertyEditor::LinkLabel.link, 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.

Member Data Documentation

◆ altdown

draftguitools.gui_dimensions.Dimension.altdown

Referenced by draftguitools.gui_dimensions.Dimension.action().

◆ angledata

draftguitools.gui_dimensions.Dimension.angledata

Referenced by draftguitools.gui_dimensions.Dimension.action(), and draftguitools.gui_dimensions.Dimension.createObject().

◆ arcmode

draftguitools.gui_dimensions.Dimension.arcmode

Referenced by draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_dimensions.Dimension.createObject(), and draftguitools.gui_dimensions.Dimension.setFromSelection().

◆ arctrack

draftguitools.gui_dimensions.Dimension.arctrack

Referenced by draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_dimensions.Dimension.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_dimensions.Dimension.call

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

◆ center

draftguitools.gui_dimensions.Dimension.center

◆ cont

draftguitools.gui_dimensions.Dimension.cont

Referenced by draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_dimensions.Dimension.Activated(), draftguitools.gui_dimensions.Dimension.createObject(), draftguitools.gui_dimensions.Dimension.finish(), and draftguitools.gui_dimensions.Dimension.numericInput().

◆ dimtrack

draftguitools.gui_dimensions.Dimension.dimtrack

Referenced by draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_dimensions.Dimension.finish(), and draftguitools.gui_dimensions.Dimension.numericInput().

◆ dir

draftguitools.gui_dimensions.Dimension.dir

Referenced by draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_dimensions.Dimension.createObject(), and draftguitools.gui_dimensions.Dimension.finish().

◆ edges

draftguitools.gui_dimensions.Dimension.edges

Referenced by draftguitools.gui_dimensions.Dimension.action(), PathScripts.PathDressupHoldingTags.MapWireToTag.addEdge(), PathScripts.PathDressupHoldingTags.MapWireToTag.commandsForEdges(), draftguitools.gui_dimensions.Dimension.createObject(), PathScripts.PathDressupTag.ObjectDressup.execute(), PathScripts.PathDressupTag.ObjectDressup.pointIsOnPath(), draftguitools.gui_trimex.Trimex.redraw(), draftguitools.gui_dimensions.Dimension.setFromSelection(), and PathScripts.PathDressupHoldingTags.MapWireToTag.shell().

◆ force

draftguitools.gui_dimensions.Dimension.force

Referenced by draftguitools.gui_dimensions.Dimension.createObject(), draftguitools.gui_trimex.Trimex.finish(), draftguitools.gui_trimex.Trimex.numericRadius(), draftguitools.gui_trimex.Trimex.redraw(), PathScripts.PathJobGui.StockFromBaseBoundBoxEdit.setFields(), PathScripts.PathJobGui.StockCreateBoxEdit.setFields(), and PathScripts.PathJobGui.StockCreateCylinderEdit.setFields().

◆ indices

draftguitools.gui_dimensions.Dimension.indices

Referenced by draftguitools.gui_dimensions.Dimension.setFromSelection().

◆ info

draftguitools.gui_dimensions.Dimension.info

Referenced by draftguitools.gui_dimensions.Dimension.action(), and PathScripts.PathSetupSheetOpPrototype.Property.setupProperty().

◆ link

draftguitools.gui_dimensions.Dimension.link

Referenced by draftguitools.gui_dimensions.Dimension.createObject(), and draftguitools.gui_dimensions.Dimension.setFromSelection().

◆ max

draftguitools.gui_dimensions.Dimension.max

◆ node

draftguitools.gui_dimensions.Dimension.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().

◆ point

draftguitools.gui_dimensions.Dimension.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().

◆ point2

draftguitools.gui_dimensions.Dimension.point2