draftobjects.array.Array Class Reference

Public Member Functions
def	attach (self, obj)
def	execute (self, obj)
def	linkSetup (self, obj)
def	onChanged (self, obj, prop)
def	set_circular_properties (self, obj)
def	set_general_properties (self, obj)
def	set_link_properties (self, obj)
def	set_ortho_properties (self, obj)
def	set_polar_circular_properties (self, obj)
def	set_polar_properties (self, obj)
def	set_properties (self, obj)
def	show_and_hide (self, obj, prop)
Public Member Functions inherited from draftobjects.draftlink.DraftLink
def	buildShape (self, obj, pl, pls)
def	canLinkProperties (self, _obj)
def	getViewProviderName (self, _obj)
def	migrate_attributes (self, obj)
def	onDocumentRestored (self, obj)

Additional Inherited Members
Public Attributes inherited from draftobjects.draftlink.DraftLink
	use_link
Public Attributes inherited from draftobjects.base.DraftObject
	Type

Detailed Description

The Draft Array object.

To Do
-----
The `Array` class currently handles three types of arrays,
orthogonal, polar, and circular. In the future, probably they should be
split in separate classes so that they are easier to manage.

Member Function Documentation

attach()

def draftobjects.array.Array.attach	(		self,
			obj
	)

Set up the properties when the object is attached.

Reimplemented from draftobjects.draftlink.DraftLink.

References draftobjects.array.Array.set_properties().

execute()

def draftobjects.array.Array.execute	(		self,
			obj
	)

Execture when the object is created or recomputed.

Reimplemented from draftobjects.base.DraftObject.

References draftobjects.draftlink.DraftLink.buildShape(), draftobjects.array.circ_placements(), draftobjects.array.polar_placements(), and draftobjects.array.rect_placements().

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

linkSetup()

def draftobjects.array.Array.linkSetup	(		self,
			obj
	)

Set up the object as a link object.

Reimplemented from draftobjects.draftlink.DraftLink.

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

onChanged()

def draftobjects.array.Array.onChanged	(		self,
			obj,
			prop
	)

Execute when a property is changed.

Reimplemented from draftobjects.draftlink.DraftLink.

References draftobjects.array.Array.show_and_hide().

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

set_circular_properties()

def draftobjects.array.Array.set_circular_properties	(		self,
			obj
	)

Set circular properties only if they don't exist.

Referenced by draftobjects.array.Array.set_properties().

set_general_properties()

def draftobjects.array.Array.set_general_properties	(		self,
			obj
	)

Set general properties only if they don't exist.

Referenced by draftobjects.array.Array.set_properties(), and draftobjects.patharray.PathArray.set_properties().

set_link_properties()

def draftobjects.array.Array.set_link_properties	(		self,
			obj
	)

Set link properties only if they don't exist.

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

Referenced by draftobjects.array.Array.set_properties().

set_ortho_properties()

def draftobjects.array.Array.set_ortho_properties	(		self,
			obj
	)

Set orthogonal properties only if they don't exist.

Referenced by draftobjects.array.Array.set_properties().

set_polar_circular_properties()

def draftobjects.array.Array.set_polar_circular_properties	(		self,
			obj
	)

Set general polar and circular properties if they don't exist.

Referenced by draftobjects.array.Array.set_properties().

set_polar_properties()

def draftobjects.array.Array.set_polar_properties	(		self,
			obj
	)

Set polar properties only if they don't exist.

Referenced by draftobjects.array.Array.set_properties().

set_properties()

def draftobjects.array.Array.set_properties	(		self,
			obj
	)

Set properties only if they don't exist.

References draftobjects.array.Array.set_circular_properties(), draftobjects.array.Array.set_general_properties(), draftobjects.array.Array.set_link_properties(), draftobjects.array.Array.set_ortho_properties(), draftobjects.array.Array.set_polar_circular_properties(), and draftobjects.array.Array.set_polar_properties().

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

show_and_hide()

def draftobjects.array.Array.show_and_hide	(		self,
			obj,
			prop
	)

Show and hide the properties depending on the touched property.

Referenced by draftobjects.array.Array.onChanged(), and draftobjects.patharray.PathArray.onChanged().

---

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

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