draftguitools.gui_subelements.SubelementHighlight Class Reference

Public Member Functions
def	action (self, event)
def	Activated (self)
def	finish (self)
def	get_editable_objects_from_selection (self)
def	get_selection (self)
def	GetResources (self)
def	highlight_editable_objects (self)
def	proceed (self)
def	remove_view_callback (self)
def	restore_editable_objects_graphics (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
	editable_objects
	is_running
	original_view_settings
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 SubelementHighlight tool.

Member Function Documentation

action()

def draftguitools.gui_subelements.SubelementHighlight.action	(		self,
			event
	)

Handle the 3D scene events.

This is installed as an EventCallback in the Inventor view.

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

References 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(), and ifc4.ifcworktime.finish.

Activated()

def draftguitools.gui_subelements.SubelementHighlight.Activated

(

self

)

Execute when the command is called.

References 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_subelements.SubelementHighlight.get_selection(), and draftguitools.gui_subelements.SubelementHighlight.is_running.

finish()

def draftguitools.gui_subelements.SubelementHighlight.finish

(

self

)

Terminate the operation.

Re-initialize by running __init__ again at the end.

References InitGui.CloudWorkbench.__init__(), ArchFence._Fence.__init__(), InitGui.ArchWorkbench.__init__(), RemoteDebugger.RemoteDebugger.__init__(), Dice3DS.dom3ds.File3dsFormatError.__init__(), lazy_loader.lazy_loader.LazyLoader.__init__(), ArchIFCView.IfcContextUI.__init__(), addonmanager_macro.Macro.__init__(), ArchNesting.Nester.__init__(), ArchVRM.Renderer.__init__(), ArchPrecast._Precast.__init__(), draftguitools.gui_arcs.Arc.__init__(), draftguitools.gui_array_simple.Array.__init__(), exportIFCHelper.SIUnitCreator.__init__(), draftguitools.gui_base_original.DraftTool.__init__(), importIFCHelper.ProjectImporter.__init__(), Dice3DS.dom3ds.FileLikeBuffer.__init__(), addonmanager_workers.UpdateWorker.__init__(), draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.__init__(), ArchReference.ArchReference.__init__(), draftguitools.gui_base.GuiCommandSimplest.__init__(), ArchSchedule._ArchSchedule.__init__(), ArchPrecast._PrecastBeam.__init__(), exportIFCHelper.ContextCreator.__init__(), ArchFrame._Frame.__init__(), importSH3D.SH3DHandler.__init__(), draftguitools.gui_array_simple.LinkArray.__init__(), ArchCutPlane._CutPlaneTaskPanel.__init__(), OfflineRenderingUtils.FreeCADGuiHandler.__init__(), ArchTruss.Truss.__init__(), ArchWindow._CommandWindow.__init__(), DraftGui.DraftBaseWidget.__init__(), ArchProject._Project.__init__(), addonmanager_workers.InfoWorker.__init__(), DraftGui.DraftDockWidget.__init__(), Dice3DS.dom3ds.ChunkMetaclass.__init__(), ArchCurtainWall.CurtainWall.__init__(), ArchRebar._Rebar.__init__(), draftguitools.gui_base.GuiCommandBase.__init__(), DraftGui.DraftLineEdit.__init__(), ArchMaterial._ArchMaterialContainer.__init__(), ArchComponent.Component.__init__(), ArchProject._ViewProviderProject.__init__(), ArchRoof._Roof.__init__(), DraftGui.DraftTaskPanel.__init__(), ArchPipe._ArchPipe.__init__(), addonmanager_workers.CheckWBWorker.__init__(), ArchFloor._Floor.__init__(), ArchStructure._CommandStructure.__init__(), ArchMaterial._ViewProviderArchMaterialContainer.__init__(), ArchAxis._Axis.__init__(), ArchPrecast._PrecastIbeam.__init__(), exportIFCHelper.recycler.__init__(), DraftGui.DraftToolBar.__init__(), ArchProfile._Profile.__init__(), ArchFence._ViewProviderFence.__init__(), Dice3DS.dom3ds.ChunkBase.__init__(), ArchProfile._ProfileC.__init__(), addonmanager_workers.FillMacroListWorker.__init__(), ArchFrame._ViewProviderFrame.__init__(), ArchStairs._Stairs.__init__(), ArchSpace._Space.__init__(), ArchBuilding._Building.__init__(), ArchMaterial._ArchMaterial.__init__(), ArchPrecast._PrecastPillar.__init__(), ArchProfile._ProfileH.__init__(), ArchEquipment._Equipment.__init__(), ArchAxis._ViewProviderAxis.__init__(), ArchBuilding._ViewProviderBuilding.__init__(), ArchProfile._ProfileR.__init__(), FreeCADInit.FCADLogger.__init__(), ArchReference.ViewProviderArchReference.__init__(), ArchFloor._ViewProviderFloor.__init__(), ArchBuildingPart.BuildingPart.__init__(), ArchProfile._ProfileRH.__init__(), addonmanager_workers.ShowWorker.__init__(), ArchPipe._ViewProviderPipe.__init__(), ArchEquipment._ViewProviderEquipment.__init__(), ArchPipe._ArchPipeConnector.__init__(), ArchSchedule._ViewProviderArchSchedule.__init__(), ArchSite.Compass.__init__(), ArchProfile._ProfileU.__init__(), ArchMaterial._ViewProviderArchMaterial.__init__(), ArchProfile.ViewProviderProfile.__init__(), ArchPanel._Panel.__init__(), ArchTruss.ViewProviderTruss.__init__(), ArchPrecast._PrecastPanel.__init__(), ArchProfile.ProfileTaskPanel.__init__(), ArchSchedule.ArchScheduleTaskPanel.__init__(), ArchSpace._ViewProviderSpace.__init__(), draftguitools.gui_arcs.Arc_3Points.__init__(), ArchBuildingPart.ViewProviderBuildingPart.__init__(), ArchMaterial._ArchMaterialTaskPanel.__init__(), ArchRebar._ViewProviderRebar.__init__(), ArchPrecast._PrecastSlab.__init__(), ArchWindow._Window.__init__(), addonmanager_workers.GetMacroDetailsWorker.__init__(), Dice3DS.dom3ds.UnknownChunk.__init__(), ArchCurtainWall.ViewProviderCurtainWall.__init__(), Dice3DS.dom3ds.ErrorChunk.__init__(), ArchSite._Site.__init__(), addonmanager_workers.InstallWorker.__init__(), ArchReference.ArchReferenceTaskPanel.__init__(), ArchStructure._Structure.__init__(), ArchPrecast._PrecastStairs.__init__(), ArchAxis._AxisTaskPanel.__init__(), ArchMaterial._ArchMultiMaterial.__init__(), ArchMaterial._ViewProviderArchMultiMaterial.__init__(), ArchWall._Wall.__init__(), ArchMaterial.MultiMaterialDelegate.__init__(), ArchPrecast._ViewProviderPrecast.__init__(), ArchRoof._ViewProviderRoof.__init__(), ArchSpace.SpaceTaskPanel.__init__(), ArchPrecast._PrecastTaskPanel.__init__(), ArchMaterial._ArchMultiMaterialTaskPanel.__init__(), ArchRoof._RoofTaskPanel.__init__(), ArchPanel._ViewProviderPanel.__init__(), addonmanager_workers.CheckSingleWorker.__init__(), ArchAxis._AxisSystem.__init__(), ArchSite._ViewProviderSite.__init__(), ArchPanel.PanelView.__init__(), ArchSectionPlane._SectionPlane.__init__(), ArchAxis._ViewProviderAxisSystem.__init__(), ArchStructure._ViewProviderStructure.__init__(), ArchSectionPlane._ViewProviderSectionPlane.__init__(), ArchPanel.PanelCut.__init__(), ArchAxis.AxisSystemTaskPanel.__init__(), ArchCommands._SurveyObserver.__init__(), ArchWindow._ViewProviderWindow.__init__(), ArchCommands.SurveyTaskPanel.__init__(), ArchStructure.StructureTaskPanel.__init__(), ArchAxis.ArchGrid.__init__(), ArchWindow._ArchWindowTaskPanel.__init__(), ArchPanel.ViewProviderPanelCut.__init__(), ArchComponent.ViewProviderComponent.__init__(), ArchSectionPlane._ArchDrawingView.__init__(), ArchStructure.StructSelectionObserver.__init__(), ArchPanel.PanelSheet.__init__(), ArchStructure._StructuralSystem.__init__(), ArchPrecast._DentsTaskPanel.__init__(), ArchSectionPlane.SectionPlaneTaskPanel.__init__(), ArchAxis.ViewProviderArchGrid.__init__(), ArchAxis.ArchGridTaskPanel.__init__(), ArchPanel.ViewProviderPanelSheet.__init__(), importIFClegacy.IfcSchema.__init__(), ArchStairs._ViewProviderStairs.__init__(), ArchPanel.SheetTaskPanel.__init__(), importIFClegacy.IfcFile.__init__(), ArchWall._ViewProviderWall.__init__(), ArchPanel.NestTaskPanel.__init__(), ArchComponent.ArchSelectionObserver.__init__(), importIFClegacy.IfcEntity.__init__(), ArchComponent.SelectionTaskPanel.__init__(), ArchComponent.ComponentTaskPanel.__init__(), importIFClegacy.IfcDocument.__init__(), importIFClegacy._tempEntityHolder.__init__(), importIFClegacy.IfcWriter.__init__(), DraftGui.FacebinderTaskPanel.__init__(), ArchComponent.IfcEditorDelegate.__init__(), draftguitools.gui_subelements.SubelementHighlight.remove_view_callback(), and draftguitools.gui_subelements.SubelementHighlight.restore_editable_objects_graphics().

Referenced by drafttaskpanels.task_polararray.TaskPanelPolarArray.accept(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.accept(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.accept(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.reject(), drafttaskpanels.task_polararray.TaskPanelPolarArray.reject(), and drafttaskpanels.task_circulararray.TaskPanelCircularArray.reject().

get_editable_objects_from_selection()

def draftguitools.gui_subelements.SubelementHighlight.get_editable_objects_from_selection

(

self

)

Get editable Draft objects for the selection.

References draftguitools.gui_subelements.SubelementHighlight.editable_objects.

Referenced by draftguitools.gui_subelements.SubelementHighlight.proceed().

get_selection()

def draftguitools.gui_subelements.SubelementHighlight.get_selection

(

self

)

Get the selection.

References draftguitools.gui_array_simple.Array.call, draftguitools.gui_arcs.Arc.call, draftguitools.gui_base_original.DraftTool.call, draftguitools.gui_base.GuiCommandBase.call, draftguitools.gui_subelements.SubelementHighlight.proceed(), draftguitools.gui_facebinders.Facebinder.proceed(), draftguitools.gui_downgrade.Downgrade.proceed(), draftguitools.gui_draft2sketch.Draft2Sketch.proceed(), draftguitools.gui_mirror.Mirror.proceed(), draftguitools.gui_shape2dview.Shape2DView.proceed(), draftguitools.gui_stretch.Stretch.proceed(), draftguitools.gui_join.Join.proceed(), draftguitools.gui_array_simple.Array.proceed(), draftguitools.gui_rotate.Rotate.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_split.Split.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::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, 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, Gui::LocationDialogUiImp.ui, 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_subelements.SubelementHighlight.Activated().

GetResources()

def draftguitools.gui_subelements.SubelementHighlight.GetResources

(

self

)

Set icon, menu and tooltip.

highlight_editable_objects()

def draftguitools.gui_subelements.SubelementHighlight.highlight_editable_objects

(

self

)

Highlight editable Draft objects from the selection.

References draftguitools.gui_subelements.SubelementHighlight.editable_objects, and draftguitools.gui_subelements.SubelementHighlight.original_view_settings.

proceed()

def draftguitools.gui_subelements.SubelementHighlight.proceed

(

self

)

Continue with the command.

References draftguitools.gui_subelements.SubelementHighlight.editable_objects, 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, draftguitools.gui_subelements.SubelementHighlight.get_editable_objects_from_selection(), and draftguitools.gui_subelements.SubelementHighlight.remove_view_callback().

Referenced by draftguitools.gui_subelements.SubelementHighlight.get_selection().

remove_view_callback()

def draftguitools.gui_subelements.SubelementHighlight.remove_view_callback

(

self

)

Remove the installed callback if it exists.

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_subelements.SubelementHighlight.finish(), and draftguitools.gui_subelements.SubelementHighlight.proceed().

restore_editable_objects_graphics()

def draftguitools.gui_subelements.SubelementHighlight.restore_editable_objects_graphics

(

self

)

Restore the editable objects' appearance.

References draftguitools.gui_subelements.SubelementHighlight.editable_objects, and draftguitools.gui_subelements.SubelementHighlight.original_view_settings.

Referenced by draftguitools.gui_subelements.SubelementHighlight.finish().

Member Data Documentation

call

draftguitools.gui_subelements.SubelementHighlight.call

Referenced by drafttaskpanels.task_shapestring.ShapeStringTaskPanel.accept(), and drafttaskpanels.task_shapestring.ShapeStringTaskPanel.reject().

editable_objects

draftguitools.gui_subelements.SubelementHighlight.editable_objects

Referenced by draftguitools.gui_subelements.SubelementHighlight.get_editable_objects_from_selection(), draftguitools.gui_subelements.SubelementHighlight.highlight_editable_objects(), draftguitools.gui_subelements.SubelementHighlight.proceed(), and draftguitools.gui_subelements.SubelementHighlight.restore_editable_objects_graphics().

is_running

draftguitools.gui_subelements.SubelementHighlight.is_running

Referenced by draftguitools.gui_subelements.SubelementHighlight.Activated().

original_view_settings

draftguitools.gui_subelements.SubelementHighlight.original_view_settings

Referenced by draftguitools.gui_subelements.SubelementHighlight.highlight_editable_objects(), and draftguitools.gui_subelements.SubelementHighlight.restore_editable_objects_graphics().

---

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

• src/Mod/Draft/draftguitools/gui_subelements.py