draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation Class Reference

Public Member Functions
def	attach (self, vobj)
def	claimChildren (self)
def	execute (self, vobj)
def	getDisplayModes (self, vobj)
def	getIcon (self)
def	onChanged (self, vobj, prop)
def	set_annotation_properties (self, vobj, properties)
def	set_graphics_properties (self, vobj, properties)
def	set_properties (self, vobj)
def	setDisplayMode (self, mode)
def	setEdit (self, vobj, mode=0)
def	unsetEdit (self, vobj, mode=0)
def	updateData (self, obj, prop)

Public Attributes
	Object

Detailed Description

The base class for Draft Annotation viewproviders.

This class is intended to be inherited by more specialized viewproviders,
for example, `Text`, `LinearDimension`, `RadialDimension`, and `Label`.

Member Function Documentation

attach()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.attach	(		self,
			vobj
	)

Set up the scene sub-graph of the view provider.

References Base::XMLReader::FileEntry.Object, Base::Writer::FileEntry.Object, Py::Object.Object(), Gui::SelectionChanges.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, ArchComponent.ViewProviderComponent.Object, ArchEquipment._ViewProviderEquipment.Object, ArchFloor._Floor.Object, ArchFloor._ViewProviderFloor.Object, ArchMaterial._ViewProviderArchMaterialContainer.Object, ArchMaterial._ViewProviderArchMaterial.Object, ArchReference.ViewProviderArchReference.Object, ArchRoof._ViewProviderRoof.Object, ArchSchedule._ViewProviderArchSchedule.Object, ArchSectionPlane._ViewProviderSectionPlane.Object, ArchSite._ViewProviderSite.Object, ArchSpace._ViewProviderSpace.Object, ArchStructure.StructureTaskPanel.Object, ArchWall._ViewProviderWall.Object, draftobjects.layer.Layer.Object, draftviewproviders.view_base.ViewProviderDraft.Object, draftviewproviders.view_dimension.ViewProviderDimensionBase.Object, draftviewproviders.view_dimension.ViewProviderLinearDimension.Object, draftviewproviders.view_dimension.ViewProviderAngularDimension.Object, draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.Object, draftviewproviders.view_label.ViewProviderLabel.Object, draftviewproviders.view_layer.ViewProviderLayer.Object, draftviewproviders.view_layer.ViewProviderLayerContainer.Object, draftviewproviders.view_text.ViewProviderText.Object, draftviewproviders.view_wire.ViewProviderWire.Object, draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.Object, femviewprovider.view_base_femconstraint.VPBaseFemConstraint.Object, femviewprovider.view_base_femobject.VPBaseFemObject.Object, femviewprovider.view_mesh_gmsh.VPMeshGmsh.Object, OpenSCADFeatures.ViewProviderTree.Object, BOPTools.JoinFeatures.ViewProviderConnect.Object, BOPTools.JoinFeatures.ViewProviderEmbed.Object, BOPTools.JoinFeatures.ViewProviderCutout.Object, BOPTools.SplitFeatures.ViewProviderBooleanFragments.Object, BOPTools.SplitFeatures.ViewProviderSlice.Object, BOPTools.SplitFeatures.ViewProviderXOR.Object, CompoundTools.CompoundFilter._ViewProviderCompoundFilter.Object, JoinFeatures._ViewProviderPartJoinFeature.Object, Mod.PartDesign.FeatureHole.ViewProviderHole.ViewProviderHole.Object, Mod.PartDesign.InvoluteGearFeature._ViewProviderInvoluteGear.Object, Mod.PartDesign.SprocketFeature.ViewProviderSprocket.Object, PathScripts.PathArray.ViewProviderArray.Object, PathScripts.PathCollision._ViewProviderCollisionSim.Object, PathScripts.PathCopy.ViewProviderPathCopy.Object, PathScripts.PathDressupDragknife.ViewProviderDressup.Object, PathScripts.PathHop.ViewProviderPathHop.Object, PathScripts.PathOpGui.ViewProvider.Object, Mod.Show.Containers.Container.Object, Spreadsheet_legacy.Spreadsheet.Object, Spreadsheet_legacy.ViewProviderSpreadsheet.Object, DocumentObject.ViewProvider.Object(), and Mod.Test.Document.DocumentBasicCases.Object.

claimChildren()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.claimChildren

(

self

)

Return objects that will be placed under it in the tree view.

Editor: perhaps this is not useful???

References Base::XMLReader::FileEntry.Object, Base::Writer::FileEntry.Object, Py::Object.Object(), Gui::SelectionChanges.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, ArchComponent.ViewProviderComponent.Object, ArchEquipment._ViewProviderEquipment.Object, ArchFloor._Floor.Object, ArchFloor._ViewProviderFloor.Object, ArchMaterial._ViewProviderArchMaterialContainer.Object, ArchMaterial._ViewProviderArchMaterial.Object, ArchReference.ViewProviderArchReference.Object, ArchRoof._ViewProviderRoof.Object, ArchSchedule._ViewProviderArchSchedule.Object, ArchSectionPlane._ViewProviderSectionPlane.Object, ArchSite._ViewProviderSite.Object, ArchSpace._ViewProviderSpace.Object, ArchStructure.StructureTaskPanel.Object, ArchWall._ViewProviderWall.Object, draftobjects.layer.Layer.Object, draftviewproviders.view_base.ViewProviderDraft.Object, draftviewproviders.view_dimension.ViewProviderDimensionBase.Object, draftviewproviders.view_dimension.ViewProviderLinearDimension.Object, draftviewproviders.view_dimension.ViewProviderAngularDimension.Object, draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.Object, draftviewproviders.view_label.ViewProviderLabel.Object, draftviewproviders.view_layer.ViewProviderLayer.Object, draftviewproviders.view_layer.ViewProviderLayerContainer.Object, draftviewproviders.view_text.ViewProviderText.Object, draftviewproviders.view_wire.ViewProviderWire.Object, draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.Object, femviewprovider.view_base_femconstraint.VPBaseFemConstraint.Object, femviewprovider.view_base_femobject.VPBaseFemObject.Object, femviewprovider.view_mesh_gmsh.VPMeshGmsh.Object, OpenSCADFeatures.ViewProviderTree.Object, BOPTools.JoinFeatures.ViewProviderConnect.Object, BOPTools.JoinFeatures.ViewProviderEmbed.Object, BOPTools.JoinFeatures.ViewProviderCutout.Object, BOPTools.SplitFeatures.ViewProviderBooleanFragments.Object, BOPTools.SplitFeatures.ViewProviderSlice.Object, BOPTools.SplitFeatures.ViewProviderXOR.Object, CompoundTools.CompoundFilter._ViewProviderCompoundFilter.Object, JoinFeatures._ViewProviderPartJoinFeature.Object, Mod.PartDesign.FeatureHole.ViewProviderHole.ViewProviderHole.Object, Mod.PartDesign.InvoluteGearFeature._ViewProviderInvoluteGear.Object, Mod.PartDesign.SprocketFeature.ViewProviderSprocket.Object, PathScripts.PathArray.ViewProviderArray.Object, PathScripts.PathCollision._ViewProviderCollisionSim.Object, PathScripts.PathCopy.ViewProviderPathCopy.Object, PathScripts.PathDressupDragknife.ViewProviderDressup.Object, PathScripts.PathHop.ViewProviderPathHop.Object, PathScripts.PathOpGui.ViewProvider.Object, Mod.Show.Containers.Container.Object, Spreadsheet_legacy.Spreadsheet.Object, Spreadsheet_legacy.ViewProviderSpreadsheet.Object, DocumentObject.ViewProvider.Object(), and Mod.Test.Document.DocumentBasicCases.Object.

Referenced by femviewprovider.view_mesh_gmsh.VPMeshGmsh.onDelete(), femviewprovider.view_result_mechanical.VPResultMechanical.onDelete(), BOPTools.JoinFeatures.ViewProviderConnect.onDelete(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.onDelete(), BOPTools.SplitFeatures.ViewProviderSlice.onDelete(), and BOPTools.SplitFeatures.ViewProviderXOR.onDelete().

execute()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.execute	(		self,
			vobj
	)

Execute when the object is created or recomputed.

Referenced by draftobjects.facebinder.Facebinder.addSubobjects(), PathScripts.PathDressupDogbone.ObjectDressup.boneStateList(), ArchSite.Compass.buildCoordinates(), PathScripts.PathDressupHoldingTags.ObjectTagDressup.generateTags(), ArchPanel.PanelCut.getWires(), ArchSchedule.CommandArchSchedule.IsActive(), Mod.PartDesign.Scripts.DistanceBolt.DistanceBolt.onChanged(), Mod.PartDesign.Scripts.Epitrochoid.Epitrochoid.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.Parallelepiped.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.BoxCylinder.onChanged(), Mod.PartDesign.Scripts.Spring.MySpring.onChanged(), FeaturePython.DistanceBolt.onChanged(), PathScripts.PathStock.StockFromBase.onChanged(), PathScripts.PathStock.StockCreateBox.onChanged(), PathScripts.PathStock.StockCreateCylinder.onChanged(), draftobjects.draftlink.DraftLink.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), and draftobjects.pathtwistedarray.PathTwistedArray.onDocumentRestored().

getDisplayModes()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.getDisplayModes	(		self,
			vobj
	)

Return the display modes that this viewprovider supports.

getIcon()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.getIcon

(

self

)

Return the path to the icon used by the view provider.

Referenced by ArchAxisSystem.AxisSystemTaskPanel.update(), ArchComponent.ComponentTaskPanel.update(), and ArchSectionPlane.SectionPlaneTaskPanel.update().

onChanged()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.onChanged	(		self,
			vobj,
			prop
	)

Execute when a view property is changed.

Referenced by ArchStructure.CommandStructuralSystem.Activated(), draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), draftobjects.wire.Wire.execute(), ArchBuildingPart.ViewProviderBuildingPart.updateData(), ArchPanel.ViewProviderPanelCut.updateData(), ArchPanel.ViewProviderPanelSheet.updateData(), draftviewproviders.view_label.ViewProviderLabel.updateData(), draftviewproviders.view_layer.ViewProviderLayer.updateData(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.updateData().

set_annotation_properties()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.set_annotation_properties	(		self,
			vobj,
			properties
	)

Set annotation properties only if they don't already exist.

References draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.set_properties().

set_graphics_properties()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.set_graphics_properties	(		self,
			vobj,
			properties
	)

Set graphics properties only if they don't already exist.

References draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by draftviewproviders.view_dimension.ViewProviderDimensionBase.set_properties(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.set_properties(), and draftviewproviders.view_label.ViewProviderLabel.set_properties().

set_properties()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.set_properties	(		self,
			vobj
	)

Set the properties only if they don't already exist.

References draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.set_annotation_properties(), draftviewproviders.view_dimension.ViewProviderDimensionBase.set_graphics_properties(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.set_graphics_properties(), and draftviewproviders.view_label.ViewProviderLabel.set_graphics_properties().

Referenced by draftobjects.array.Array.attach(), draftobjects.patharray.PathArray.attach(), draftobjects.pathtwistedarray.PathTwistedArray.attach(), draftobjects.pointarray.PointArray.attach(), draftobjects.layer.Layer.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), draftobjects.pathtwistedarray.PathTwistedArray.onDocumentRestored(), and draftobjects.pointarray.PointArray.onDocumentRestored().

setDisplayMode()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.setDisplayMode	(		self,
			mode
	)

Return the saved display mode.

setEdit()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.setEdit	(		self,
			vobj,
			mode = 0
	)

Execute the code when entering the specific edit mode.

Currently only mode 0 works.

Referenced by ArchGrid.ViewProviderArchGrid.doubleClicked(), ArchReference.ViewProviderArchReference.doubleClicked(), draftviewproviders.view_dimension.ViewProviderDimensionBase.doubleClicked(), draftviewproviders.view_hatch.ViewProviderDraftHatch.doubleClicked(), draftviewproviders.view_text.ViewProviderText.doubleClicked(), PathScripts.PathPropertyBagGui.ViewProvider.doubleClicked(), PathScripts.PathSetupSheetGui.ViewProvider.doubleClicked(), PathScripts.PathToolBitGui.ViewProvider.doubleClicked(), Spreadsheet_legacy.ViewProviderSpreadsheet.doubleClicked(), ArchSchedule.CommandArchSchedule.IsActive(), PathScripts.PathIconViewProvider.ViewProvider.setupContextMenu(), PathScripts.PathJobGui.ViewProvider.setupContextMenu(), PathScripts.PathOpGui.ViewProvider.setupContextMenu(), and PathScripts.PathToolControllerGui.ViewProvider.setupContextMenu().

unsetEdit()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.unsetEdit	(		self,
			vobj,
			mode = 0
	)

Execute the code when leaving the specific edit mode.

Currently only mode 0 works.
It runs the finish method of the currently active command, and close
the task panel if any.

Referenced by PathScripts.PathJobGui.ViewProvider.uneditObject().

updateData()

def draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.updateData	(		self,
			obj,
			prop
	)

Execute when a property from the Proxy class is changed.

Referenced by ArchStructure.CommandStructuralSystem.Activated(), PathScripts.PathJobDlg.JobCreate.exec_(), draftviewproviders.view_dimension.ViewProviderLinearDimension.onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension.onChanged(), draftviewproviders.view_wire.ViewProviderWire.onChanged(), PathScripts.PathOpGui.TaskPanelPage.pageUpdateData(), PathScripts.PathPropertyBagGui.TaskPanel.setupUi(), and PathScripts.PathSetupSheetGui.OpTaskPanel.setupUi().

Member Data Documentation

Object

draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.Object

Referenced by draftviewproviders.view_layer.ViewProviderLayer.activate(), ArchPanel.CommandPanelSheet.Activated(), ArchStructure.CommandStructuralSystem.Activated(), OpenSCADFeatures.ViewProviderTree.attach(), ArchComponent.ViewProviderComponent.attach(), draftviewproviders.view_base.ViewProviderDraft.attach(), draftviewproviders.view_dimension.ViewProviderLinearDimension.attach(), draftviewproviders.view_dimension.ViewProviderAngularDimension.attach(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.attach(), draftviewproviders.view_layer.ViewProviderLayer.attach(), draftviewproviders.view_layer.ViewProviderLayerContainer.attach(), PathScripts.PathArray.ViewProviderArray.attach(), PathScripts.PathCopy.ViewProviderPathCopy.attach(), PathScripts.PathDressupDragknife.ViewProviderDressup.attach(), PathScripts.PathHop.ViewProviderPathHop.attach(), PathScripts.PathOpGui.ViewProvider.attach(), ArchSite.Compass.buildCoordinates(), ArchReference.ViewProviderArchReference.checkChanges(), ArchComponent.ViewProviderComponent.claimChildren(), draftviewproviders.view_base.ViewProviderDraft.claimChildren(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.claimChildren(), draftviewproviders.view_draftlink.ViewProviderDraftLink.claimChildren(), draftviewproviders.view_layer.ViewProviderLayer.claimChildren(), draftviewproviders.view_wire.ViewProviderWire.claimChildren(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.claimChildren(), femviewprovider.view_result_mechanical.VPResultMechanical.claimChildren(), OpenSCADFeatures.ViewProviderTree.claimChildren(), BOPTools.JoinFeatures.ViewProviderConnect.claimChildren(), BOPTools.JoinFeatures.ViewProviderEmbed.claimChildren(), BOPTools.JoinFeatures.ViewProviderCutout.claimChildren(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.claimChildren(), BOPTools.SplitFeatures.ViewProviderSlice.claimChildren(), BOPTools.SplitFeatures.ViewProviderXOR.claimChildren(), PathScripts.PathArray.ViewProviderArray.claimChildren(), PathScripts.PathDressupDragknife.ViewProviderDressup.claimChildren(), Spreadsheet_legacy.ViewProviderSpreadsheet.claimChildren(), PathScripts.PathOpGui.ViewProvider.clearTaskPanel(), ArchBuildingPart.ViewProviderBuildingPart.cloneUp(), ArchStructure.StructureTaskPanel.connectNodes(), ArchBuildingPart.ViewProviderBuildingPart.createGroup(), draftviewproviders.view_text.ViewProviderText.createObject(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.doubleClicked(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.dragObject(), BOPTools.JoinFeatures.ViewProviderConnect.dragObject(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.dragObject(), BOPTools.SplitFeatures.ViewProviderXOR.dragObject(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.dropObject(), BOPTools.JoinFeatures.ViewProviderConnect.dropObject(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.dropObject(), BOPTools.SplitFeatures.ViewProviderXOR.dropObject(), ArchStructure.StructureTaskPanel.extendNodes(), draftviewproviders.view_wire.ViewProviderWire.flatten(), Mod.Show.Containers.Container.getCSChildren(), Mod.Show.Containers.Container.getDynamicChildren(), ArchBuildingPart.ViewProviderBuildingPart.getIcon(), ArchComponent.ViewProviderComponent.getIcon(), draftviewproviders.view_array.ViewProviderDraftArray.getIcon(), draftviewproviders.view_base.ViewProviderDraft.getIcon(), draftviewproviders.view_dimension.ViewProviderDimensionBase.getIcon(), draftviewproviders.view_draftlink.ViewProviderDraftLink.getIcon(), femviewprovider.view_base_femobject.VPBaseFemObject.getIcon(), femviewprovider.view_material_common.VPMaterialCommon.getIcon(), OpenSCADFeatures.ViewProviderTree.getIcon(), PathScripts.PathOpGui.ViewProvider.getIcon(), Mod.Show.Containers.Container.getStaticChildren(), Mod.Show.Containers.Container.getVisGroupChildren(), Mod.Show.Containers.Container.hasObjectRecursive(), draftviewproviders.view_dimension.ViewProviderLinearDimension.is_linked_to_circle(), Mod.Show.Containers.Container.isACS(), ArchSchedule.CommandArchSchedule.IsActive(), Mod.Show.Containers.Container.isAVisGroup(), Mod.Show.Containers.Container.isChildVisible(), draftviewproviders.view_layer.ViewProviderLayerContainer.merge_by_name(), draftviewproviders.view_base.ViewProviderDraft.onChanged(), BOPTools.JoinFeatures.ViewProviderEmbed.onDelete(), BOPTools.JoinFeatures.ViewProviderCutout.onDelete(), ArchReference.ViewProviderArchReference.onOpen(), ArchReference.ViewProviderArchReference.onReload(), ArchBuildingPart.ViewProviderBuildingPart.reorder(), ArchStructure.StructureTaskPanel.resetNodes(), draftviewproviders.view_layer.ViewProviderLayer.select_contents(), Mod.Show.Containers.Container.self_check(), ArchComponent.ViewProviderComponent.setDisplayMode(), ArchComponent.ViewProviderComponent.setEdit(), Mod.PartDesign.SprocketFeature.ViewProviderSprocket.setEdit(), ArchStructure.StructureTaskPanel.setSelectionFromTool(), ArchStructure.StructureTaskPanel.setToolFromSelection(), PathScripts.PathOpGui.ViewProvider.setupTaskPanel(), ArchBuildingPart.ViewProviderBuildingPart.setWorkingPlane(), femviewprovider.view_result_mechanical.VPResultMechanical.unsetEdit(), ArchBuildingPart.ViewProviderBuildingPart.writeCamera(), draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.writeCamera(), ArchBuildingPart.ViewProviderBuildingPart.writeInventor(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.writeState().

---

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

• FreeCAD/src/Mod/Draft/draftviewproviders/view_draft_annotation.py