Public Member Functions
def	accept (self)

def	acceptIfcProperties (self)

def	addElement (self)

def	addIfcProperty (self, idx=0, pset=None, prop=None, ptype=None)

def	addIfcPset (self, idx=0)

def	check (self, wid, col)

def	editClass (self)

def	editIfcProperties (self)

def	editObject (self, wid, col)

def	getIcon (self, obj)

def	getStandardButtons (self)

def	isAllowedAlterSelection (self)

def	isAllowedAlterView (self)

def	removeElement (self)

def	removeIfcProperty (self)

def	retranslateUi (self, TaskPanel)

def	update (self)

Public Attributes
	addButton

	attribs

	baseform

	classButton

	delButton

	form

	grid

	ifcButton

	ifcEditor

	ifcModel

	obj

	plabels

	psetdefs

	psetkeys

	ptypes

	title

	tree

Detailed Description

The default TaskPanel for all Arch components.

TODO: outline the purpose of this taskpanel.

Member Function Documentation

◆ accept()

def ArchComponent.ComponentTaskPanel.accept ( self )

This method runs as a callback when the user selects the ok button.

Recomputes the document, and leave edit mode.

Reimplemented in ArchStructure.StructureTaskPanel.

Referenced by femexamples.examplesgui.FemExamples.clicked(), femexamples.examplesgui.FemExamples.double_clicked(), ArchComponent.ComponentTaskPanel.editObject(), and PathScripts.PathToolBitLibraryGui.ToolBitLibrary.toolEdit().

◆ acceptIfcProperties()

def ArchComponent.ComponentTaskPanel.acceptIfcProperties ( self )

This method runs as a callback when the user selects the ok button in the IFC editor.

Scrape through the rows of the IFC editor's items, and compare them to
the object being edited's .IfcData. If the two are different, change
the object's .IfcData to match the editor's items.

◆ addElement()

def ArchComponent.ComponentTaskPanel.addElement ( self )

This method is run as a callback when the user selects the add button.

Get the object selected in the 3D view, and get the attribute folder
selected in the tree widget.

Add the object selected in the 3D view to the attribute associated with
the selected folder, by using function addToComponent().

◆ addIfcProperty()

def ArchComponent.ComponentTaskPanel.addIfcProperty	(	self,
		idx = `0`,
		pset = `None`,
		prop = `None`,
		ptype = `None`
	)

Add an IFC property to the object, within the IFC editor.

This method runs as a callback when the user selects an option in the
Add Property dropdown box in the IFC editor. When used via the
dropdown, it adds a property with the property type selected in the
dropdown.

This method can also be run standalone, outside its function as a
callback.

Unless otherwise specified, the property will be called "New property".
The property will have no value assigned.

Parameters
----------
idx: int, optional
    The index number of the property type selected in the dropdown. If
    idx is not specified, the property's type must be specified in the
    ptype parameter.
pset: str, optional
    The name of the property set this property will be assigned to. If
    not provided, the pset will be determined by which property set has
    been selected within the IFC editor widget.
prop: str, optional
    The name of the property to be created. If left blank, will be set to
    "New Property".
ptype: str, optional
    The name of the property type the new property will be set as. If
    not specified, the the property's type will be determined using the
    idx parameter.

References ArchComponent.ComponentTaskPanel.ifcEditor, ArchComponent.ComponentTaskPanel.ifcModel, ArchComponent.ComponentTaskPanel.plabels, ArchComponent.IfcEditorDelegate.plabels, ArchComponent.ComponentTaskPanel.ptypes, and ArchComponent.IfcEditorDelegate.ptypes.

Referenced by ArchComponent.ComponentTaskPanel.addIfcPset().

◆ addIfcPset()

def ArchComponent.ComponentTaskPanel.addIfcPset	(	self,
		idx = `0`
	)

Add an IFC property set to the object, within the IFC editor.

This method runs as a callback when the user selects a property set
within the Add property set dropdown.

Add the property set selected in the dropdown, then check the property
set definitions for the property set's standard properties, and add
them with blank values to the new property set.

Parameters
----------
idx: int
    The index of the options selected from the Add property set
    dropdown.

References ArchComponent.ComponentTaskPanel.addIfcProperty(), ArchComponent.ComponentTaskPanel.ifcEditor, ArchComponent.ComponentTaskPanel.ifcModel, ArchComponent.ComponentTaskPanel.psetdefs, and ArchComponent.ComponentTaskPanel.psetkeys.

◆ check()

def ArchComponent.ComponentTaskPanel.check	(	self,
		wid,
		col
	)

This method is run as the callback when the user selects an item in the tree.

Enable and disable the add and remove buttons depending on what the
user has selected.

If they have selected one of the root attribute folders, disable the
remove button. If they have separately selected an object in the 3D
view, enable the add button, allowing the user to add that object to
the root attribute folder.

If they have selected one of the items inside a root attribute folder,
enable the remove button, allowing the user to remove the object from
that attribute.

Parameters
----------
wid: <PySide2.QtWidgets.QTreeWidgetItem>
    Qt object the user has selected in the tree widget.

Referenced by femsolver.run.Machine.reset().

◆ editClass()

def ArchComponent.ComponentTaskPanel.editClass ( self )

Simple wrapper for BIM_Classification Gui command.

This method is called when the Edit class button is selected
in the IFC editor. It relies on the presence of the BIM module.

◆ editIfcProperties()

def ArchComponent.ComponentTaskPanel.editIfcProperties ( self )

Open the IFC editor dialog box.

This is the method that runs as a callback when the Edit IFC properties
button is selected by the user.

Defines the editor's structure, fill it with data, add a callback for
the buttons and other interactions, and show it.

◆ editObject()

def ArchComponent.ComponentTaskPanel.editObject	(	self,
		wid,
		col
	)

This method is run when the user double clicks on an item in the tree widget.

If the item in the tree has a corresponding object in the document,
enter edit mode for that associated object.

At the same time, make the object this task panel was opened for
transparent and unselectable.

Parameters
----------
wid: <PySide2.QtWidgets.QTreeWidgetItem>
    Qt object the user has selected in the tree widget.

◆ getIcon()

def ArchComponent.ComponentTaskPanel.getIcon	(	self,
		obj
	)

Get the path to the icons, of the items that fill the tree widget.

Parameters
---------
obj: <App::DocumentObject>
    The object being edited.

Referenced by ArchAxisSystem.AxisSystemTaskPanel.update(), ArchComponent.ComponentTaskPanel.update(), and ArchSectionPlane.SectionPlaneTaskPanel.update().

◆ getStandardButtons()

def ArchComponent.ComponentTaskPanel.getStandardButtons ( self )

Add the standard ok button.

◆ isAllowedAlterSelection()

def ArchComponent.ComponentTaskPanel.isAllowedAlterSelection ( self )

Indicate whether this task dialog allows other commands to modify
the selection while it is open.

Returns
-------
bool
    If alteration of the selection should be allowed.

◆ isAllowedAlterView()

def ArchComponent.ComponentTaskPanel.isAllowedAlterView ( self )

Indicate whether this task dialog allows other commands to modify
the 3D view while it is open.

Returns
-------
bool
    If alteration of the 3D view should be allowed.

◆ removeElement()

def ArchComponent.ComponentTaskPanel.removeElement ( self )

This method is run as a callback when the user selects the remove button.

Get the object selected in the tree widget. If there is an object in
the document with the same Name as the selected item in the tree,
remove it from the object being edited, with the removeFromComponent()
function.

◆ removeIfcProperty()

def ArchComponent.ComponentTaskPanel.removeIfcProperty ( self )

Remove an IFC property or property set from the object, within the IFC editor.

This method runs as a callback when the user selects the Delete
selected property/set button within the IFC editor.

Find the selected property, and delete it. If it's a property set,
delete the children properties as well.

References ArchComponent.ComponentTaskPanel.ifcEditor, and ArchComponent.ComponentTaskPanel.ifcModel.

◆ retranslateUi()

def ArchComponent.ComponentTaskPanel.retranslateUi	(	self,
		TaskPanel
	)

Add the text of the task panel, in translated form.

References Gui::Dialog::Ui_DlgChooseIcon.addButton, Gui::Dialog::IconFolders.addButton, Gui::ActionSelector.addButton, ArchAxis._AxisTaskPanel.addButton, ArchAxisSystem.AxisSystemTaskPanel.addButton, ArchCommands.SurveyTaskPanel.addButton, ArchComponent.ComponentTaskPanel.addButton, ArchSectionPlane.SectionPlaneTaskPanel.addButton, ArchWindow._ArchWindowTaskPanel.addButton, DraftGui.FacebinderTaskPanel.addButton, ArchComponent.SelectionTaskPanel.baseform, ArchComponent.ComponentTaskPanel.baseform, ArchWindow._ArchWindowTaskPanel.baseform, ArchComponent.ComponentTaskPanel.classButton, ArchAxis._AxisTaskPanel.delButton, ArchAxisSystem.AxisSystemTaskPanel.delButton, ArchComponent.ComponentTaskPanel.delButton, ArchSectionPlane.SectionPlaneTaskPanel.delButton, ArchWindow._ArchWindowTaskPanel.delButton, DraftGui.FacebinderTaskPanel.delButton, ArchComponent.ComponentTaskPanel.ifcButton, ArchAxis._AxisTaskPanel.title, ArchAxisSystem.AxisSystemTaskPanel.title, ArchComponent.ComponentTaskPanel.title, ArchCutPlane._CutPlaneTaskPanel.title, ArchGrid.ArchGridTaskPanel.title, ArchRoof._RoofTaskPanel.title, ArchSectionPlane.SectionPlaneTaskPanel.title, ArchWindow._ArchWindowTaskPanel.title, DraftGui.DraftToolBar.title, DraftGui.FacebinderTaskPanel.title, DrawingGui::OrthoViews.title, ifc2x3.ifcclassificationitem.title, Mod.PartDesign.WizardShaft.ShaftDiagram.Diagram.title, PathScripts.PathOpGui.TaskPanelPage.title, PathScripts.PathToolBitLibraryGui.ToolBitSelector.title, PathScripts.PathToolBitLibraryGui.ToolBitLibrary.title, TaskPanel.TaskWatcher.title, and TaskPanel.TaskWatcherFilter.title.

Referenced by ArchGrid.ArchGridTaskPanel.addColumn(), ArchGrid.ArchGridTaskPanel.addRow(), ArchGrid.ArchGridTaskPanel.delColumn(), ArchGrid.ArchGridTaskPanel.delRow(), DraftGui.DraftToolBar.taskUi(), ArchAxisSystem.AxisSystemTaskPanel.update(), ArchComponent.ComponentTaskPanel.update(), ArchSectionPlane.SectionPlaneTaskPanel.update(), and DraftGui.FacebinderTaskPanel.update().

◆ update()

def ArchComponent.ComponentTaskPanel.update ( self )

Populate the treewidget with its various items.

Check if the object being edited has attributes relevant to subobjects.
IE: Additions, Subtractions, etc.

Populate the tree with these subobjects, under folders named after the
attributes they are listed in.

Finally, run method .retranslateUi().