draftobjects.dimension.LinearDimension Class Reference

Public Member Functions
def	execute (self, obj)
def	onChanged (self, obj, prop)
def	onDocumentRestored (self, obj)
def	set_properties (self, obj)
def	onDocumentRestored (self, obj)
def	set_properties (self, obj)
Public Member Functions inherited from draftobjects.draft_annotation.DraftAnnotation
def	add_missing_properties_0v19 (self, obj, vobj)
def	execute (self, obj)
def	onChanged (self, obj, prop)
def	onDocumentRestored (self, obj)

Additional Inherited Members
Public Attributes inherited from draftobjects.draft_annotation.DraftAnnotation
	Type

Detailed Description

The linear dimension object.

This inherits `DimensionBase` to provide the basic functionality of
a dimension.

This linear dimension includes measurements between two vertices,
but also a radial dimension of a circular edge or arc.

Member Function Documentation

execute()

def draftobjects.dimension.LinearDimension.execute	(		self,
			obj
	)

Execute when the object is created or recomputed.

Set start point and end point according to the linked geometry
and the number of subelements.

If it has one subelement, we assume a straight edge or a circular edge.
If it has two subelements, we assume a straight edge (two vertices).

Reimplemented from draftobjects.draft_annotation.DraftAnnotation.

References draftobjects.dimension.measure_one_obj_edge(), draftobjects.dimension.measure_one_obj_vertices(), and draftobjects.dimension.measure_two_objects().

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.dimension.LinearDimension.onChanged	(		self,
			obj,
			prop
	)

Execute when a property is changed.

It just sets some properties to be read-only or hidden,
as they aren't used.

Reimplemented from draftobjects.draft_annotation.DraftAnnotation.

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.dimension.LinearDimension.onDocumentRestored	(		self,
			obj
	)

Execute code when the document is restored.

It calls the parent class to add missing dimension properties.

Reimplemented from draftobjects.dimension.DimensionBase.

References draftobjects.dimension.LinearDimension.onDocumentRestored().

Referenced by draftobjects.dimension.LinearDimension.onDocumentRestored().

set_properties()

def draftobjects.dimension.LinearDimension.set_properties	(		self,
			obj
	)

Set basic properties only if they don't exist.

Reimplemented from draftobjects.dimension.DimensionBase.

References draftutils.translate.QT_TRANSLATE_NOOP.

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

---

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

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