draftobjects.draft_annotation.DraftAnnotation Class Reference

Public Member Functions
def	add_missing_properties_0v19 (self, obj, vobj)
def	execute (self, obj)
def	onChanged (self, obj, prop)
def	onDocumentRestored (self, obj)

Public Attributes
	Type

Detailed Description

The Draft Annotation Base object.

This class is not used directly, but inherited by all Draft annotation
objects.

LinearDimension through DimensionBase
AngularDimension through DimensionBase
Label
Text

Member Function Documentation

add_missing_properties_0v19()

def draftobjects.draft_annotation.DraftAnnotation.add_missing_properties_0v19	(		self,
			obj,
			vobj
	)

Provide missing annotation properties, if they don't exist.

References draftutils.translate.QT_TRANSLATE_NOOP, App::FeaturePythonPyT< FeaturePyT >.Type, App::Part.Type, App::PropertyData::PropertySpec.Type, Base::PyObjectBase.Type, Base::Type.Type(), Py::Type.Type(), Gui::SelectionChanges.Type, ArchAxis._Axis.Type, ArchAxisSystem._AxisSystem.Type, ArchBuilding._Building.Type, ArchBuildingPart.BuildingPart.Type, ArchComponent.Component.Type, ArchEquipment._Equipment.Type, ArchFence._Fence.Type, ArchFloor._Floor.Type, ArchFrame._Frame.Type, ArchGrid.ArchGrid.Type, ArchMaterial._ArchMaterialContainer.Type, ArchMaterial._ArchMaterial.Type, ArchMaterial._ArchMultiMaterial.Type, ArchPanel._Panel.Type, ArchPanel.PanelView.Type, ArchPanel.PanelCut.Type, ArchPanel.PanelSheet.Type, ArchPipe._ArchPipe.Type, ArchPipe._ArchPipeConnector.Type, ArchPrecast._Precast.Type, ArchProject._Project.Type, ArchRebar._Rebar.Type, ArchReference.ArchReference.Type, ArchRoof._Roof.Type, ArchSchedule._ArchSchedule.Type, ArchSectionPlane._SectionPlane.Type, ArchSectionPlane._ArchDrawingView.Type, ArchSite._Site.Type, ArchSpace._Space.Type, ArchStairs._Stairs.Type, ArchStructure._Structure.Type, ArchStructure._StructuralSystem.Type, ArchTruss.Truss.Type, ArchWall._Wall.Type, ArchWindow._Window.Type, draftobjects.base.DraftObject.Type, draftobjects.draft_annotation.DraftAnnotation.Type, draftobjects.hatch.Hatch.Type, draftobjects.layer.Layer.Type, draftobjects.layer.LayerContainer.Type, draftobjects.wpproxy.WorkingPlaneProxy.Type, femobjects.constant_vacuumpermittivity.ConstantVacuumPermittivity.Type, femobjects.constraint_bodyheatsource.ConstraintBodyHeatSource.Type, femobjects.constraint_centrif.ConstraintCentrif.Type, femobjects.constraint_electrostaticpotential.ConstraintElectrostaticPotential.Type, femobjects.constraint_flowvelocity.ConstraintFlowVelocity.Type, femobjects.constraint_initialflowvelocity.ConstraintInitialFlowVelocity.Type, femobjects.constraint_sectionprint.ConstraintSectionPrint.Type, femobjects.constraint_selfweight.ConstraintSelfWeight.Type, femobjects.constraint_tie.ConstraintTie.Type, femobjects.element_fluid1D.ElementFluid1D.Type, femobjects.element_geometry1D.ElementGeometry1D.Type, femobjects.element_geometry2D.ElementGeometry2D.Type, femobjects.element_rotation1D.ElementRotation1D.Type, femobjects.material_common.MaterialCommon.Type, femobjects.material_mechanicalnonlinear.MaterialMechanicalNonlinear.Type, femobjects.material_reinforced.MaterialReinforced.Type, femobjects.mesh_boundarylayer.MeshBoundaryLayer.Type, femobjects.mesh_gmsh.MeshGmsh.Type, femobjects.mesh_group.MeshGroup.Type, femobjects.mesh_region.MeshRegion.Type, femobjects.mesh_result.MeshResult.Type, femobjects.result_mechanical.ResultMechanical.Type, femobjects.solver_ccxtools.SolverCcxTools.Type, femsolver.calculix.solver.Proxy.Type, femsolver.elmer.equations.elasticity.Proxy.Type, femsolver.elmer.equations.electricforce.Proxy.Type, femsolver.elmer.equations.electrostatic.Proxy.Type, femsolver.elmer.equations.flow.Proxy.Type, femsolver.elmer.equations.flux.Proxy.Type, femsolver.elmer.equations.heat.Proxy.Type, femsolver.elmer.solver.Proxy.Type, femsolver.mystran.solver.Proxy.Type, femsolver.z88.solver.Proxy.Type, FemGui::FemSelectionGate.Type, Import::FeatureImportIges.Type(), Import::FeatureImportStep.Type(), BOPTools.JoinFeatures.FeatureConnect.Type, BOPTools.JoinFeatures.FeatureEmbed.Type, BOPTools.JoinFeatures.FeatureCutout.Type, BOPTools.SplitFeatures.FeatureBooleanFragments.Type, BOPTools.SplitFeatures.FeatureSlice.Type, BOPTools.SplitFeatures.FeatureXOR.Type, CompoundTools.CompoundFilter._CompoundFilter.Type, JoinFeatures._PartJoinFeature.Type, PartDesign::Boolean.Type, PartDesign::FeatureExtrude.Type, Mod.PartDesign.InvoluteGearFeature._InvoluteGear.Type, Mod.PartDesign.SprocketFeature.Sprocket.Type, Path::Tool.Type, Robot::Waypoint.Type, Sketcher::ConstraintIds.Type, Sketcher::Constraint.Type, SketcherGui::AutoConstraint.Type, Spreadsheet_legacy.Spreadsheet.Type, Spreadsheet_legacy.SpreadsheetController.Type, Spreadsheet_legacy.SpreadsheetPropertyController.Type, TechDraw::DrawProjGroupItem.Type, TechDraw::DrawViewDimension.Type, TechDrawGui::QGCustomBorder.Type, TechDrawGui::QGCustomClip.Type, TechDrawGui::QGCustomImage.Type, TechDrawGui::QGCustomLabel.Type, TechDrawGui::QGCustomRect.Type, TechDrawGui::QGCustomSvg.Type, TechDrawGui::QGCustomText.Type, TechDrawGui::QGDisplayArea.Type, TechDrawGui::QGMarker.Type, TechDrawGui::QGEPath.Type, TechDrawGui::QGIArrow.Type, TechDrawGui::QGICaption.Type, TechDrawGui::QGICenterLine.Type, TechDrawGui::QGICMark.Type, TechDrawGui::QGIDecoration.Type, TechDrawGui::QGIDimLines.Type, TechDrawGui::QGIDrawingTemplate.Type, TechDrawGui::QGIEdge.Type, TechDrawGui::QGIFace.Type, TechDrawGui::QGIGhostHighlight.Type, TechDrawGui::QGIHighlight.Type, TechDrawGui::QGILeaderLine.Type, TechDrawGui::QGIMatting.Type, TechDrawGui::QGIPrimPath.Type, TechDrawGui::QGIProjGroup.Type, TechDrawGui::QGIRichAnno.Type, TechDrawGui::QGISectionLine.Type, TechDrawGui::QGISVGTemplate.Type, TechDrawGui::QGITemplate.Type, TechDrawGui::QGITile.Type, TechDrawGui::QGIVertex.Type, TechDrawGui::QGIView.Type, TechDrawGui::QGIViewAnnotation.Type, TechDrawGui::QGIBalloonLabel.Type, TechDrawGui::QGIViewBalloon.Type, TechDrawGui::QGIViewClip.Type, TechDrawGui::QGIViewCollection.Type, TechDrawGui::QGIDatumLabel.Type, TechDrawGui::QGIViewDimension.Type, TechDrawGui::QGIViewImage.Type, TechDrawGui::QGIViewPart.Type, TechDrawGui::QGIViewSection.Type, TechDrawGui::QGIViewSpreadsheet.Type, TechDrawGui::QGIViewSymbol.Type, TechDrawGui::QGIWeldSymbol.Type, TechDrawGui::QGMText.Type, TechDrawGui::QGTracker.Type, TechDrawGui::TemplateTextField.Type, DocumentObject.DocumentObject.Type(), and DocumentObject.ViewProvider.Type().

Referenced by draftobjects.draft_annotation.DraftAnnotation.onDocumentRestored().

execute()

def draftobjects.draft_annotation.DraftAnnotation.execute	(		self,
			obj
	)

Execute when the object is created or recomputed.

Does nothing.

Reimplemented in draftobjects.dimension.LinearDimension, draftobjects.dimension.AngularDimension, and draftobjects.label.Label.

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().

onChanged()

def draftobjects.draft_annotation.DraftAnnotation.onChanged	(		self,
			obj,
			prop
	)

Execute when a property is changed.

Does nothing.

Reimplemented in draftobjects.dimension.LinearDimension, draftobjects.dimension.AngularDimension, and draftobjects.label.Label.

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().

onDocumentRestored()

def draftobjects.draft_annotation.DraftAnnotation.onDocumentRestored	(		self,
			obj
	)

Execute code when the document is restored.

Check if new properties are present after the object is restored
in order to migrate older objects.

Reimplemented in draftobjects.dimension.DimensionBase, draftobjects.dimension.LinearDimension, draftobjects.dimension.AngularDimension, draftobjects.label.Label, and draftobjects.text.Text.

References draftobjects.draft_annotation.DraftAnnotation.add_missing_properties_0v19().

Member Data Documentation

Type

draftobjects.draft_annotation.DraftAnnotation.Type

Referenced by ArchPanel.CommandPanelSheet.Activated(), ArchStructure.CommandStructuralSystem.Activated(), draftobjects.draft_annotation.DraftAnnotation.add_missing_properties_0v19(), ArchStructure.StructSelectionObserver.addSelection(), ArchSite.Compass.buildCoordinates(), ArchComponent.Component.execute(), draftobjects.layer.LayerContainer.execute(), ArchSchedule.CommandArchSchedule.IsActive(), draftobjects.layer.Layer.set_properties(), and ArchReference.ArchReference.setProperties().

---

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

• FreeCAD/src/Mod/Draft/draftobjects/draft_annotation.py