ArchComponent.ViewProviderComponent Class Reference

Public Member Functions
def areDifferentColors (self, a, b)
def attach (self, vobj)
def claimChildren (self)
def colorize (self, obj, force=False)
def getDisplayModes (self, vobj)
def getIcon (self)
def onChanged (self, vobj, prop)
def setDisplayMode (self, mode)
def setEdit (self, vobj, mode)
def setProperties (self, vobj)
def setupContextMenu (self, vobj, menu)
def toggleSubcomponents (self)
def unsetEdit (self, vobj, mode)
def updateData (self, obj, prop)

Public Attributes
hiresgroup
meshcolor
meshnode
Object

Detailed Description

A default View Provider for Component objects.

Acts as a base for all other Arch view providers. It's properties and
behaviours are common to all Arch view providers.

Parameters
----------
vobj: <Gui.ViewProviderDocumentObject>
    The view provider to turn into a component view provider.

Member Function Documentation

areDifferentColors()

def ArchComponent.ViewProviderComponent.areDifferentColors	(		self,
			a,
			b
	)

Check if two diffuse colors are almost the same. Parameters ---------- a: tuple The first DiffuseColor value to compare. a: tuple The second DiffuseColor value to compare. Returns ------- bool: True if colors are different, false if they are similar.

Referenced by ArchCurtainWall.ViewProviderCurtainWall.colorize(), and ArchComponent.ViewProviderComponent.colorize().

attach()

def ArchComponent.ViewProviderComponent.attach	(		self,
			vobj
	)

Add display modes' data to the coin scenegraph. Add each display mode as a coin node, whose parent is this view provider. Each display mode's node includes the data needed to display the object in that mode. This might include colors of faces, or the draw style of lines. This data is stored as additional coin nodes which are children of the display mode node. Add the HiRes display mode. Parameters ---------- vobj: <Gui.ViewProviderDocumentObject> The component's view provider object.

Referenced by ArchWall.areSameWallTypes(), ArchRebar.makeRebar(), and ArchSpace.removeSpaceBoundaries().

claimChildren()

def ArchComponent.ViewProviderComponent.claimChildren

(

self

)

Define which objects will appear as children in the tree view. Set the host object's Base object as a child, and set any additions or subtractions as children. Parameters ---------- vobj: <Gui.ViewProviderDocumentObject> The component's view provider object. Returns ------- list of <App::DocumentObject>s: The objects claimed as children.

References Base::Writer::FileEntry.Object, Gui::SelectionChanges.Object, Base::XMLReader::FileEntry.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, and ArchComponent.ViewProviderComponent.Object.

Referenced by ArchFrame.makeFrame(), femviewprovider.view_result_mechanical.VPResultMechanical.onDelete(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.onDelete(), BOPTools.JoinFeatures.ViewProviderConnect.onDelete(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.onDelete(), BOPTools.SplitFeatures.ViewProviderSlice.onDelete(), and BOPTools.SplitFeatures.ViewProviderXOR.onDelete().

colorize()

def ArchComponent.ViewProviderComponent.colorize	(		self,
			obj,
			force = False
	)

If an object is a clone, set it it to copy the color of its parent. Only change the color of the clone if the clone and its parent have colors that are distinguishably different from each other. Parameters ---------- obj: <Part::Feature> The object to change the color of. force: bool If true, forces the colourisation even if the two objects have very similar colors.

Reimplemented in ArchCurtainWall.ViewProviderCurtainWall.

References ArchComponent.ViewProviderComponent.areDifferentColors().

Referenced by ArchCurtainWall.ViewProviderCurtainWall.onChanged(), and ArchCurtainWall.ViewProviderCurtainWall.updateData().

getDisplayModes()

def ArchComponent.ViewProviderComponent.getDisplayModes	(		self,
			vobj
	)

Define the display modes unique to the Arch Component. Define mode HiRes, which displays the component as a mesh, intended as a more visually appealing version of the component. Parameters ---------- vobj: <Gui.ViewProviderDocumentObject> The component's view provider object. Returns ------- list of str List containing the names of the new display modes.

Referenced by ArchWall.areSameWallTypes(), ArchRebar.makeRebar(), and ArchSpace.removeSpaceBoundaries().

getIcon()

def ArchComponent.ViewProviderComponent.getIcon

(

self

)

Return the path to the appropriate icon. If a clone, return the cloned component icon path. Otherwise return the Arch Component icon. Returns ------- str Path to the appropriate icon .svg file.

Reimplemented in ArchCurtainWall.ViewProviderCurtainWall, and ArchTruss.ViewProviderTruss.

References Base::Writer::FileEntry.Object, Gui::SelectionChanges.Object, Base::XMLReader::FileEntry.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, and ArchComponent.ViewProviderComponent.Object.

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

onChanged()

def ArchComponent.ViewProviderComponent.onChanged	(		self,
			vobj,
			prop
	)

Method called when the view provider has a property changed. If DiffuseColor changes, change DiffuseColor to copy the host object's clone, if it exists. If ShapeColor changes, overwrite it with DiffuseColor. If Visibility changes, propagate the change to all view objects that are also hosted by this view object's host. Parameters ---------- vobj: <Gui.ViewProviderDocumentObject> The component's view provider object. prop: string The name of the property that has changed.

Reimplemented in ArchCurtainWall.ViewProviderCurtainWall.

Referenced by draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), draftobjects.wire.Wire.execute(), ArchAxis.CommandArchGrid.IsActive(), ArchRebar.makeRebar(), ArchCurtainWall.ViewProviderCurtainWall.onChanged(), ArchStructure.placeAlongEdge(), draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.updateData(), draftviewproviders.view_label.ViewProviderLabel.updateData(), DraftLayer.ViewProviderLayer.updateData(), ArchPanel.ViewProviderPanelCut.updateData(), and ArchPanel.ViewProviderPanelSheet.updateData().

setDisplayMode()

def ArchComponent.ViewProviderComponent.setDisplayMode	(		self,
			mode
	)

Method called when the display mode changes. Called when the display mode changes, this method can be used to set data that wasn't available when .attach() was called. When HiRes is set as display mode, display the component as a copy of the mesh associated as the HiRes property of the host object. See ArchComponent.Component's properties. If no shape is set in the HiRes property, just display the object as the Flat Lines display mode. Parameters ---------- vobj: <Gui.ViewProviderDocumentObject> The component's view provider object. mode: str The name of the display mode the view provider has switched to. Returns ------- str: The name of the display mode the view provider has switched to.

References ArchComponent.ViewProviderComponent.hiresgroup, ArchComponent.ViewProviderComponent.meshnode, Base::Writer::FileEntry.Object, Gui::SelectionChanges.Object, Base::XMLReader::FileEntry.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, and ArchComponent.ViewProviderComponent.Object.

Referenced by ArchWall.areSameWallTypes(), and ArchSpace.removeSpaceBoundaries().

setEdit()

def ArchComponent.ViewProviderComponent.setEdit	(		self,
			vobj,
			mode
	)

Method called when the document requests the object to enter edit mode. Edit mode is entered when a user double clicks on an object in the tree view, or when they use the menu option [Edit -> Toggle Edit Mode]. Parameters ---------- vobj: <Gui.ViewProviderDocumentObject> The component's view provider object. mode: int or str The edit mode the document has requested. Set to 0 when requested via a double click or [Edit -> Toggle Edit Mode]. Returns ------- bool If edit mode was entered.

References Base::Writer::FileEntry.Object, Gui::SelectionChanges.Object, Base::XMLReader::FileEntry.Object, ArchBuildingPart.ViewProviderBuildingPart.Object, and ArchComponent.ViewProviderComponent.Object.

Referenced by PathScripts.PathSetupSheetGui.ViewProvider.doubleClicked(), PathScripts.PathToolBitGui.ViewProvider.doubleClicked(), ArchReference.ViewProviderArchReference.doubleClicked(), Spreadsheet_legacy.ViewProviderSpreadsheet.doubleClicked(), ArchSchedule.CommandArchSchedule.IsActive(), ArchAxis.CommandArchGrid.IsActive(), PathScripts.PathIconViewProvider.ViewProvider.setupContextMenu(), PathScripts.PathToolControllerGui.ViewProvider.setupContextMenu(), PathScripts.PathOpGui.ViewProvider.setupContextMenu(), and PathScripts.PathJobGui.ViewProvider.setupContextMenu().

setProperties()

def ArchComponent.ViewProviderComponent.setProperties	(		self,
			vobj
	)

Give the component view provider its component view provider specific properties. You can learn more about properties here: https://wiki.freecadweb.org/property

Referenced by ArchPanel.CommandPanelSheet.Activated(), ArchSite.Compass.buildCoordinates(), ArchSchedule.CommandArchSchedule.IsActive(), ArchAxis.CommandArchGrid.IsActive(), DraftLayer.Layer.onDocumentRestored(), ArchPanel.PanelView.onDocumentRestored(), ArchPanel.PanelCut.onDocumentRestored(), ArchPanel.ViewProviderPanelCut.onDocumentRestored(), ArchPanel.PanelSheet.onDocumentRestored(), ArchPanel.ViewProviderPanelSheet.onDocumentRestored(), and ArchStructure.placeAlongEdge().

setupContextMenu()

def ArchComponent.ViewProviderComponent.setupContextMenu	(		self,
			vobj,
			menu
	)

Add the component specific options to the context menu. The context menu is the drop down menu that opens when the user right clicks on the component in the tree view. Add a menu choice to call the Arch_ToggleSubs Gui command. See ArchCommands._ToggleSubs Parameters ---------- vobj: <Gui.ViewProviderDocumentObject> The component's view provider object. menu: <PySide2.QtWidgets.QMenu> The context menu already assembled prior to this method being called.

References ArchComponent.ViewProviderComponent.toggleSubcomponents().

toggleSubcomponents()

def ArchComponent.ViewProviderComponent.toggleSubcomponents

(

self

)

Simple wrapper to call Arch_ToggleSubs when the relevant context menu choice is selected.

Referenced by ArchComponent.ViewProviderComponent.setupContextMenu().

unsetEdit()

def ArchComponent.ViewProviderComponent.unsetEdit	(		self,
			vobj,
			mode
	)

Method called when the document requests the object exit edit mode. Returns ------- False

Referenced by PathScripts.PathJobGui.ViewProvider.uneditObject().

updateData()

def ArchComponent.ViewProviderComponent.updateData	(		self,
			obj,
			prop
	)

Method called when the host object has a property changed. If the object has a Material associated with it, match the view object's ShapeColor and Transparency to match the Material. If the object is now cloned, or is part of a compound, have the view object inherit the DiffuseColor. Parameters ---------- obj: <App::FeaturePython> The host object that has changed. prop: string The name of the property that has changed.

Reimplemented in ArchCurtainWall.ViewProviderCurtainWall.

Referenced by ArchPanel.CommandPanelSheet.Activated(), ArchWall.areSameWallTypes(), PathScripts.PathJobDlg.JobCreate.exec_(), ArchRebar.makeRebar(), draftviewproviders.view_wire.ViewProviderWire.onChanged(), draftviewproviders.view_dimension.ViewProviderLinearDimension.onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension.onChanged(), PathScripts.PathOpGui.TaskPanelPage.pageUpdateData(), ArchStructure.placeAlongEdge(), and PathScripts.PathSetupSheetGui.OpTaskPanel.setupUi().

Member Data Documentation

hiresgroup

ArchComponent.ViewProviderComponent.hiresgroup

Referenced by ArchComponent.ViewProviderComponent.setDisplayMode().

meshcolor

ArchComponent.ViewProviderComponent.meshcolor

meshnode

ArchComponent.ViewProviderComponent.meshnode

Referenced by ArchComponent.ViewProviderComponent.setDisplayMode().

Object

ArchComponent.ViewProviderComponent.Object

Referenced by DraftLayer.ViewProviderLayer.activate(), ArchPanel.CommandPanelSheet.Activated(), draftviewproviders.view_draftlink.ViewProviderDraftLink.attach(), OpenSCADFeatures.ViewProviderTree.attach(), PathScripts.PathCopy.ViewProviderPathCopy.attach(), PathScripts.PathHop.ViewProviderPathHop.attach(), PathScripts.PathOpGui.ViewProvider.attach(), draftviewproviders.view_base.ViewProviderDraft.attach(), PathScripts.PathArray.ViewProviderArray.attach(), draftviewproviders.view_dimension.ViewProviderLinearDimension.attach(), PathScripts.PathDressupDragknife.ViewProviderDressup.attach(), draftviewproviders.view_dimension.ViewProviderAngularDimension.attach(), ArchSite.Compass.buildCoordinates(), ArchReference.ViewProviderArchReference.checkChanges(), draftviewproviders.view_draftlink.ViewProviderDraftLink.claimChildren(), femviewprovider.view_result_mechanical.VPResultMechanical.claimChildren(), OpenSCADFeatures.ViewProviderTree.claimChildren(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation.claimChildren(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.claimChildren(), draftviewproviders.view_wire.ViewProviderWire.claimChildren(), BOPTools.JoinFeatures.ViewProviderConnect.claimChildren(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.claimChildren(), DraftLayer.ViewProviderLayer.claimChildren(), PathScripts.PathArray.ViewProviderArray.claimChildren(), BOPTools.SplitFeatures.ViewProviderSlice.claimChildren(), BOPTools.JoinFeatures.ViewProviderEmbed.claimChildren(), BOPTools.JoinFeatures.ViewProviderCutout.claimChildren(), BOPTools.SplitFeatures.ViewProviderXOR.claimChildren(), PathScripts.PathDressupDragknife.ViewProviderDressup.claimChildren(), draftviewproviders.view_base.ViewProviderDraft.claimChildren(), Spreadsheet_legacy.ViewProviderSpreadsheet.claimChildren(), ArchComponent.ViewProviderComponent.claimChildren(), PathScripts.PathOpGui.ViewProvider.clearTaskPanel(), ArchStructure.StructureTaskPanel.connectNodes(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.doubleClicked(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.dragObject(), BOPTools.JoinFeatures.ViewProviderConnect.dragObject(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.dragObject(), BOPTools.SplitFeatures.ViewProviderXOR.dragObject(), BOPTools.SplitFeatures.ViewProviderBooleanFragments.dropObject(), BOPTools.JoinFeatures.ViewProviderConnect.dropObject(), femviewprovider.view_mesh_gmsh.VPMeshGmsh.dropObject(), BOPTools.SplitFeatures.ViewProviderXOR.dropObject(), ArchStructure.StructureTaskPanel.extendNodes(), draftviewproviders.view_wire.ViewProviderWire.flatten(), Mod.Show.Containers.Container.getCSChildren(), Mod.Show.Containers.Container.getDynamicChildren(), draftviewproviders.view_array.ViewProviderDraftArray.getIcon(), femviewprovider.view_material_common.VPMaterialCommon.getIcon(), draftviewproviders.view_draftlink.ViewProviderDraftLink.getIcon(), femviewprovider.view_base_femobject.VPBaseFemObject.getIcon(), OpenSCADFeatures.ViewProviderTree.getIcon(), PathScripts.PathOpGui.ViewProvider.getIcon(), draftviewproviders.view_dimension.ViewProviderDimensionBase.getIcon(), draftviewproviders.view_base.ViewProviderDraft.getIcon(), ArchComponent.ViewProviderComponent.getIcon(), Mod.Show.Containers.Container.getStaticChildren(), Mod.Show.Containers.Container.getVisGroupChildren(), Mod.Show.Containers.Container.hasObjectRecursive(), draftviewproviders.view_dimension.ViewProviderLinearDimension.is_linked_to_circle(), Mod.Show.Containers.Container.isACS(), ArchSchedule.CommandArchSchedule.IsActive(), Mod.Show.Containers.Container.isAVisGroup(), Mod.Show.Containers.Container.isChildVisible(), DraftLayer.ViewProviderLayerContainer.mergeByName(), draftviewproviders.view_base.ViewProviderDraft.onChanged(), BOPTools.JoinFeatures.ViewProviderEmbed.onDelete(), BOPTools.JoinFeatures.ViewProviderCutout.onDelete(), ArchReference.ViewProviderArchReference.onOpen(), ArchReference.ViewProviderArchReference.onReload(), ArchStructure.StructureTaskPanel.resetNodes(), DraftLayer.ViewProviderLayer.selectcontents(), Mod.Show.Containers.Container.self_check(), draftviewproviders.view_label.ViewProviderLabel.set_properties(), ArchComponent.ViewProviderComponent.setDisplayMode(), Mod.PartDesign.SprocketFeature.ViewProviderSprocket.setEdit(), ArchComponent.ViewProviderComponent.setEdit(), PathScripts.PathOpGui.ViewProvider.setupTaskPanel(), femviewprovider.view_result_mechanical.VPResultMechanical.unsetEdit(), draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.writeCamera(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.writeState().

---

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

• src/Mod/Arch/ArchComponent.py