draftviewproviders.view_dimension.ViewProviderDimensionBase Class Reference

Public Member Functions

def doubleClicked (self, vobj)
 
def getDefaultDisplayMode (self)
 
def getDisplayModes (self, vobj)
 
def getIcon (self)
 
def onChanged (self, vobj, prop)
 
def set_graphics_properties (self, vobj, properties)
 
def set_properties (self, vobj)
 
def set_text_properties (self, vobj, properties)
 
def set_units_properties (self, vobj, properties)
 
def setDisplayMode (self, mode)
 
def updateData (self, obj, prop)
 

Public Attributes

 defaultmode
 
 Object
 

Detailed Description

The base viewprovider for the Draft Dimensions object.

This class is not used directly, but inherited by dimension
viewproviders like linear, radial, and angular.

Dimension nomeclature
---------------------
The dimension object depends on various variables to draw the lines
that are drawn on 3D view.
::
        |              txt               |      e
    ----b---------a----------------------b----
        |                                |
        |                                |      d
        |                                |

    c  (t)                              (t)   c

From the object class

* `a`, `Dimline`, point through which the dimension line goes through

From the viewprovider class

* `b`, `ArrowType` and `ArrowSize`, the symbol shown on the endpoints
* `c`, `DimOvershoot`, extension to the dimension line going through `a`
* `d`, `ExtLines`, distance to target `(t)`
* `e`, `ExtOvershoot`, extension in the opposite direction to `(t)`
* `txt`, text label showing the value of the measurement

Coin object structure
---------------------
The scenegraph is set from two main nodes.
::
    vobj.node.color
             .drawstyle
             .lineswitch1.coords
                         .line
                         .marks
                         .marksDimOvershoot
                         .marksExtOvershoot
             .label.textpos
                   .color
                   .font
                   .text

    vobj.node3d.color
               .drawstyle
               .lineswitch3.coords
                           .line
                           .marks
                           .marksDimOvershoot
                           .marksExtOvershoot
               .label3d.textpos
                       .color
                       .font3d
                       .text3d

Member Function Documentation

◆ doubleClicked()

def draftviewproviders.view_dimension.ViewProviderDimensionBase.doubleClicked (   self,
  vobj 
)
Execute when double clicking the icon in the tree view.

References Gui::Document.setEdit(), Gui::ViewProvider.setEdit(), Gui::ViewProviderAnnotationLabel.setEdit(), Gui::ViewProviderPythonFeatureImp.setEdit(), DrawingGui::ViewProviderDrawingPage.setEdit(), FemGui::ViewProviderFemAnalysis.setEdit(), FemGui::ViewProviderFemConstraint.setEdit(), FemGui::ViewProviderFemConstraintBearing.setEdit(), FemGui::ViewProviderFemConstraintContact.setEdit(), FemGui::ViewProviderFemConstraintDisplacement.setEdit(), FemGui::ViewProviderFemConstraintFixed.setEdit(), FemGui::ViewProviderFemConstraintFluidBoundary.setEdit(), FemGui::ViewProviderFemConstraintForce.setEdit(), FemGui::ViewProviderFemConstraintGear.setEdit(), FemGui::ViewProviderFemConstraintHeatflux.setEdit(), FemGui::ViewProviderFemConstraintInitialTemperature.setEdit(), FemGui::ViewProviderFemConstraintPlaneRotation.setEdit(), FemGui::ViewProviderFemConstraintPressure.setEdit(), FemGui::ViewProviderFemConstraintPulley.setEdit(), FemGui::ViewProviderFemConstraintTemperature.setEdit(), FemGui::ViewProviderFemConstraintTransform.setEdit(), FemGui::ViewProviderFemMeshShapeNetgen.setEdit(), FemGui::ViewProviderFemPostFunction.setEdit(), FemGui::ViewProviderFemPostObject.setEdit(), FemGui::ViewProviderSetElements.setEdit(), FemGui::ViewProviderSetFaces.setEdit(), FemGui::ViewProviderSetGeometry.setEdit(), FemGui::ViewProviderSetNodes.setEdit(), MeshGui::ViewProviderMesh.setEdit(), PartGui::ViewProvider2DObjectGrid.setEdit(), PartGui::ViewProviderCurveNet.setEdit(), PartGui::ViewProviderImport.setEdit(), PartGui::ViewProviderMirror.setEdit(), PartGui::ViewProviderFillet.setEdit(), PartGui::ViewProviderChamfer.setEdit(), PartGui::ViewProviderOffset.setEdit(), PartGui::ViewProviderThickness.setEdit(), PartGui::ViewProviderPrimitive.setEdit(), PartDesignGui::ViewProviderBase.setEdit(), PartDesignGui::ViewProviderDressUp.setEdit(), PartDesignGui::ViewProviderHelix.setEdit(), PartDesignGui::ViewProviderHole.setEdit(), PartDesignGui::ViewProviderLoft.setEdit(), PartDesignGui::ViewProviderPipe.setEdit(), PartDesignGui::ViewProviderPrimitive.setEdit(), PathGui::ViewProviderPathCompound.setEdit(), PointsGui::ViewProviderPoints.setEdit(), RaytracingGui::ViewProviderLux.setEdit(), RaytracingGui::ViewProviderPovray.setEdit(), RobotGui::ViewProviderEdge2TracObject.setEdit(), RobotGui::ViewProviderTrajectoryCompound.setEdit(), RobotGui::ViewProviderTrajectoryDressUp.setEdit(), SurfaceGui::ViewProviderFilling.setEdit(), SurfaceGui::ViewProviderGeomFillSurface.setEdit(), SurfaceGui::ViewProviderSections.setEdit(), TechDrawGui::ViewProviderBalloon.setEdit(), TechDrawGui::ViewProviderDimension.setEdit(), TechDrawGui::ViewProviderLeader.setEdit(), TechDrawGui::ViewProviderProjGroup.setEdit(), TechDrawGui::ViewProviderProjGroupItem.setEdit(), TechDrawGui::ViewProviderRichAnno.setEdit(), TechDrawGui::ViewProviderViewPart.setEdit(), TechDrawGui::ViewProviderViewSection.setEdit(), TechDrawGui::ViewProviderWeld.setEdit(), Gui::ViewProviderDragger.setEdit(), Gui::ViewProviderLink.setEdit(), Gui::ViewProviderPythonFeatureT< ViewProviderT >.setEdit(), PartGui::ViewProviderPartExt.setEdit(), PartDesignGui::ViewProvider.setEdit(), PartDesignGui::ViewProviderBoolean.setEdit(), PartDesignGui::ViewProviderDatum.setEdit(), PartDesignGui::ViewProviderShapeBinder.setEdit(), PartDesignGui::ViewProviderSubShapeBinder.setEdit(), PartDesignGui::ViewProviderTransformed.setEdit(), SketcherGui::ViewProviderSketch.setEdit(), SpreadsheetGui::ViewProviderSheet.setEdit(), TechDrawGui::ViewProviderGeomHatch.setEdit(), TechDrawGui::ViewProviderHatch.setEdit(), TechDrawGui::ViewProviderPage.setEdit(), MeshGui::ViewProviderMeshNode.setEdit(), Gui::ViewProviderOriginFeature.setEdit(), Gui::DocumentPy.setEdit(), ArchIFCView.IfcContextView.setEdit(), BasicShapes.ViewProviderShapes.ViewProviderTube.setEdit(), ArchComponent.ViewProviderComponent.setEdit(), ArchMaterial._ViewProviderArchMaterial.setEdit(), ArchPanel.ViewProviderPanelSheet.setEdit(), ArchPrecast._ViewProviderPrecast.setEdit(), ArchProfile.ViewProviderProfile.setEdit(), ArchRebar._ViewProviderRebar.setEdit(), ArchSectionPlane._ViewProviderSectionPlane.setEdit(), ArchSite._ViewProviderSite.setEdit(), ArchSpace._ViewProviderSpace.setEdit(), ArchStructure._ViewProviderStructure.setEdit(), ArchWindow._ViewProviderWindow.setEdit(), draftviewproviders.view_facebinder.ViewProviderFacebinder.setEdit(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.setEdit(), JoinFeatures._ViewProviderPartJoinFeature.setEdit(), Mod.PartDesign.InvoluteGearFeature._ViewProviderInvoluteGear.setEdit(), Mod.PartDesign.SprocketFeature.ViewProviderSprocket.setEdit(), PathScripts.PathFixture._ViewProviderFixture.setEdit(), PathScripts.PathPlane._ViewProviderPlane.setEdit(), ArchAxis._ViewProviderAxis.setEdit(), ArchAxis._ViewProviderAxisSystem.setEdit(), ArchAxis.ViewProviderArchGrid.setEdit(), ArchMaterial._ViewProviderArchMultiMaterial.setEdit(), ArchReference.ViewProviderArchReference.setEdit(), ArchRoof._ViewProviderRoof.setEdit(), ArchSchedule._ViewProviderArchSchedule.setEdit(), draftviewproviders.view_base.ViewProviderDraft.setEdit(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.setEdit(), femsolver.elmer.equations.equation.ViewProxy.setEdit(), femsolver.solverbase.ViewProxy.setEdit(), femviewprovider.view_constraint_electrostaticpotential.VPConstraintElectroStaticPotential.setEdit(), femviewprovider.view_constraint_flowvelocity.VPConstraintFlowVelocity.setEdit(), femviewprovider.view_constraint_initialflowvelocity.VPConstraintInitialFlowVelocity.setEdit(), femviewprovider.view_constraint_sectionprint.VPConstraintSectionPrint.setEdit(), femviewprovider.view_constraint_tie.VPConstraintTie.setEdit(), femviewprovider.view_element_fluid1D.VPElementFluid1D.setEdit(), femviewprovider.view_element_geometry1D.VPElementGeometry1D.setEdit(), femviewprovider.view_element_geometry2D.VPElementGeometry2D.setEdit(), femviewprovider.view_material_common.VPMaterialCommon.setEdit(), femviewprovider.view_material_reinforced.VPMaterialReinforced.setEdit(), femviewprovider.view_mesh_boundarylayer.VPMeshBoundaryLayer.setEdit(), femviewprovider.view_mesh_group.VPMeshGroup.setEdit(), femviewprovider.view_mesh_region.VPMeshRegion.setEdit(), femviewprovider.view_result_mechanical.VPResultMechanical.setEdit(), femviewprovider.view_solver_ccxtools.VPSolverCcxTools.setEdit(), PathScripts.PathCollision._ViewProviderCollisionSim.setEdit(), PathScripts.PathDressupAxisMap.ViewProviderDressup.setEdit(), PathScripts.PathDressupDogbone.ViewProviderDressup.setEdit(), PathScripts.PathDressupDragknife.ViewProviderDressup.setEdit(), PathScripts.PathDressupLeadInOut.ViewProviderDressup.setEdit(), PathScripts.PathDressupPathBoundaryGui.DressupPathBoundaryViewProvider.setEdit(), PathScripts.PathDressupTagGui.PathDressupTagViewProvider.setEdit(), PathScripts.PathDressupZCorrect.ViewProviderDressup.setEdit(), PathScripts.PathPropertyBagGui.ViewProvider.setEdit(), PathScripts.PathSetupSheetGui.ViewProvider.setEdit(), PathScripts.PathToolBitGui.ViewProvider.setEdit(), Spreadsheet_legacy.ViewProviderSpreadsheet.setEdit(), femviewprovider.view_base_femobject.VPBaseFemObject.setEdit(), PathScripts.PathIconViewProvider.ViewProvider.setEdit(), PathScripts.PathJobGui.ViewProvider.setEdit(), PathScripts.PathOpGui.ViewProvider.setEdit(), PathScripts.PathToolControllerGui.ViewProvider.setEdit(), and Mod.PartDesign.FeatureHole.ViewProviderHole.ViewProviderHole.setEdit().

◆ getDefaultDisplayMode()

def draftviewproviders.view_dimension.ViewProviderDimensionBase.getDefaultDisplayMode (   self)

◆ getDisplayModes()

def draftviewproviders.view_dimension.ViewProviderDimensionBase.getDisplayModes (   self,
  vobj 
)
Return the display modes that this viewprovider supports.

◆ getIcon()

def draftviewproviders.view_dimension.ViewProviderDimensionBase.getIcon (   self)
Return the path to the icon used by the viewprovider.

Reimplemented in draftviewproviders.view_dimension.ViewProviderAngularDimension, and draftviewproviders.view_dimension.ViewProviderLinearDimension.

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 ArchAxis.AxisSystemTaskPanel.update(), ArchComponent.ComponentTaskPanel.update(), and ArchSectionPlane.SectionPlaneTaskPanel.update().

◆ onChanged()

◆ set_graphics_properties()

def draftviewproviders.view_dimension.ViewProviderDimensionBase.set_graphics_properties (   self,
  vobj,
  properties 
)

◆ set_properties()

◆ set_text_properties()

def draftviewproviders.view_dimension.ViewProviderDimensionBase.set_text_properties (   self,
  vobj,
  properties 
)

◆ set_units_properties()

def draftviewproviders.view_dimension.ViewProviderDimensionBase.set_units_properties (   self,
  vobj,
  properties 
)
Set unit properties only if they don't already exist.

References draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by draftviewproviders.view_dimension.ViewProviderDimensionBase.set_properties().

◆ setDisplayMode()

def draftviewproviders.view_dimension.ViewProviderDimensionBase.setDisplayMode (   self,
  mode 
)
Return the saved display mode.

◆ updateData()

Member Data Documentation

◆ defaultmode

draftviewproviders.view_dimension.ViewProviderDimensionBase.defaultmode

◆ Object

draftviewproviders.view_dimension.ViewProviderDimensionBase.Object

Referenced by draftviewproviders.view_layer.ViewProviderLayer.activate(), ArchPanel.CommandPanelSheet.Activated(), OpenSCADFeatures.ViewProviderTree.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(), 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(), 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:
  • Sources/FreeCAD/src/Mod/Draft/draftviewproviders/view_dimension.py