draftobjects.draftlink.DraftLink Class Reference

Public Member Functions
def attach (self, obj)
def buildShape (self, obj, pl, pls)
def canLinkProperties (self, _obj)
def getViewProviderName (self, _obj)
def linkSetup (self, obj)
def migrate_attributes (self, obj)
def onChanged (self, obj, prop)
def onDocumentRestored (self, obj)
Public Member Functions inherited from draftobjects.base.DraftObject
def execute (self, obj)

Public Attributes
use_link
Public Attributes inherited from draftobjects.base.DraftObject
Type

Detailed Description

New class to use the App::Link objects in arrays.

Introduced by realthunder.
This is subclassed by `draftobjects.array.Array`
and by `draftobjects.patharray.PathArray`.

Member Function Documentation

attach()

def draftobjects.draftlink.DraftLink.attach	(		self,
			obj
	)

Set up the properties when the object is attached.

Reimplemented in draftobjects.patharray.PathArray, and draftobjects.array.Array.

References draftobjects.draftlink.DraftLink.linkSetup(), draftobjects.array.Array.linkSetup(), draftobjects.draftlink.DraftLink.use_link, draftguitools.gui_array_simple.Array.use_link, and draftguitools.gui_patharray.PathArray.use_link.

buildShape()

def draftobjects.draftlink.DraftLink.buildShape	(		self,
			obj,
			pl,
			pls
	)

Build the shape of the link object.

References draftobjects.draftlink.DraftLink.use_link, draftguitools.gui_array_simple.Array.use_link, and draftguitools.gui_patharray.PathArray.use_link.

Referenced by draftobjects.patharray.PathArray.execute(), draftobjects.array.Array.execute(), draftobjects.draftlink.DraftLink.onDocumentRestored(), and draftobjects.patharray.PathArray.onDocumentRestored().

canLinkProperties()

def draftobjects.draftlink.DraftLink.canLinkProperties	(		self,
			_obj
	)

Link properties. TODO: add more explanation. C++ override???

getViewProviderName()

def draftobjects.draftlink.DraftLink.getViewProviderName	(		self,
			_obj
	)

Override the view provider name.

References draftobjects.draftlink.DraftLink.use_link, draftguitools.gui_array_simple.Array.use_link, and draftguitools.gui_patharray.PathArray.use_link.

linkSetup()

def draftobjects.draftlink.DraftLink.linkSetup	(		self,
			obj
	)

Set up the link properties on attachment.

Reimplemented in draftobjects.array.Array, and draftobjects.patharray.PathArray.

Referenced by draftobjects.draftlink.DraftLink.attach(), draftobjects.draftlink.DraftLink.onDocumentRestored(), and draftobjects.patharray.PathArray.onDocumentRestored().

migrate_attributes()

def draftobjects.draftlink.DraftLink.migrate_attributes	(		self,
			obj
	)

Migrate old attribute names to new names if they exist. This is done to comply with Python guidelines or fix small issues in older code.

References draftobjects.draftlink.DraftLink.use_link, draftguitools.gui_array_simple.Array.use_link, and draftguitools.gui_patharray.PathArray.use_link.

Referenced by draftobjects.draftlink.DraftLink.onDocumentRestored(), and draftobjects.patharray.PathArray.onDocumentRestored().

onChanged()

def draftobjects.draftlink.DraftLink.onChanged	(		self,
			obj,
			prop
	)

Execute when a property changes.

Reimplemented from draftobjects.base.DraftObject.

Reimplemented in draftobjects.patharray.PathArray, and draftobjects.array.Array.

Referenced by draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), ArchAxis.CommandArchGrid.IsActive(), draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.updateData(), and draftviewproviders.view_label.ViewProviderLabel.updateData().

onDocumentRestored()

def draftobjects.draftlink.DraftLink.onDocumentRestored	(		self,
			obj
	)

Execute code when the document in restored.

Reimplemented in draftobjects.patharray.PathArray.

References draftobjects.draftlink.DraftLink.buildShape(), ArchFence._Fence.execute(), App::FeaturePythonImp.execute(), importIFCHelper.ProjectImporter.execute(), ArchPrecast._Precast.execute(), App::FeatureCustomT< FeatureT >.execute(), App::VRMLObject.execute(), App::InventorObject.execute(), App::MeasureDistance.execute(), ArchPrecast._PrecastBeam.execute(), draftobjects.base.DraftObject.execute(), DraftLayer.Layer.execute(), ArchFrame._Frame.execute(), App::PropertyExpressionEngine.execute(), ArchReference.ArchReference.execute(), App::FeatureTest.execute(), App::FeatureTestException.execute(), ArchSchedule._ArchSchedule.execute(), App::Origin.execute(), ArchMaterial._ArchMaterialContainer.execute(), App::FeaturePythonT< FeatureT >.execute(), ArchPipe._ArchPipe.execute(), ArchTruss.Truss.execute(), ArchAxis._Axis.execute(), ArchPrecast._PrecastIbeam.execute(), ArchComponent.Component.execute(), ArchProfile._ProfileC.execute(), ArchFloor._Floor.execute(), ArchCurtainWall.CurtainWall.execute(), ArchProfile._ProfileH.execute(), ArchPrecast._PrecastPillar.execute(), ArchRebar._Rebar.execute(), ArchSpace._Space.execute(), ArchProfile._ProfileR.execute(), ArchEquipment._Equipment.execute(), ArchProfile._ProfileRH.execute(), draftobjects.array.Array.execute(), ArchMaterial._ArchMaterial.execute(), ArchProfile._ProfileU.execute(), ArchPipe._ArchPipeConnector.execute(), DraftLayer.LayerContainer.execute(), ArchBuildingPart.BuildingPart.execute(), ArchStairs._Stairs.execute(), ArchPrecast._PrecastPanel.execute(), ArchPanel._Panel.execute(), ArchPrecast._PrecastSlab.execute(), ArchRoof._Roof.execute(), App::DocumentObject.execute(), ArchStructure._Structure.execute(), ArchPrecast._PrecastStairs.execute(), ArchSite._Site.execute(), ArchWall._Wall.execute(), ArchWindow._Window.execute(), ArchAxis._AxisSystem.execute(), ArchPanel.PanelView.execute(), ArchSectionPlane._SectionPlane.execute(), ArchPanel.PanelCut.execute(), ArchAxis.ArchGrid.execute(), ArchSectionPlane._ArchDrawingView.execute(), ArchStructure._StructuralSystem.execute(), ArchPanel.PanelSheet.execute(), draftobjects.draftlink.DraftLink.linkSetup(), draftobjects.array.Array.linkSetup(), draftobjects.draftlink.DraftLink.migrate_attributes(), draftobjects.draftlink.DraftLink.use_link, draftguitools.gui_array_simple.Array.use_link, and draftguitools.gui_patharray.PathArray.use_link.

Member Data Documentation

use_link

draftobjects.draftlink.DraftLink.use_link

Referenced by draftobjects.draftlink.DraftLink.attach(), draftobjects.draftlink.DraftLink.buildShape(), drafttaskpanels.task_polararray.TaskPanelPolarArray.create_object(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.create_object(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.create_object(), draftobjects.draftlink.DraftLink.getViewProviderName(), draftobjects.draftlink.DraftLink.migrate_attributes(), draftobjects.draftlink.DraftLink.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), drafttaskpanels.task_polararray.TaskPanelPolarArray.print_messages(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.print_messages(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.print_messages(), draftobjects.patharray.PathArray.set_general_properties(), drafttaskpanels.task_polararray.TaskPanelPolarArray.set_link(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.set_link(), drafttaskpanels.task_circulararray.TaskPanelCircularArray.set_link(), draftobjects.array.Array.set_link_properties(), drafttaskpanels.task_polararray.TaskPanelPolarArray.validate_input(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray.validate_input(), and drafttaskpanels.task_circulararray.TaskPanelCircularArray.validate_input().

---

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

• src/Mod/Draft/draftobjects/draftlink.py