ArchCurtainWall.ViewProviderCurtainWall Class Reference

Public Member Functions
def	colorize (self, obj, force=False)
def	getIcon (self)
def	onChanged (self, vobj, prop)
def	updateData (self, obj, prop)
Public Member Functions inherited from ArchComponent.ViewProviderComponent
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)

Additional Inherited Members
Public Attributes inherited from ArchComponent.ViewProviderComponent
	hiresgroup
	meshcolor
	meshnode
	Object

Member Function Documentation

colorize()

def ArchCurtainWall.ViewProviderCurtainWall.colorize	(		self,
			obj,
			force = False
	)

If an object is a clone, set 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 from ArchComponent.ViewProviderComponent.

References ArchComponent.ViewProviderComponent.areDifferentColors(), and ArchCommands.getDefaultColor().

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

getIcon()

def ArchCurtainWall.ViewProviderCurtainWall.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 from ArchComponent.ViewProviderComponent.

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

onChanged()

def ArchCurtainWall.ViewProviderCurtainWall.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 from ArchComponent.ViewProviderComponent.

References ArchComponent.ViewProviderComponent.colorize(), ArchCurtainWall.ViewProviderCurtainWall.colorize(), ArchWindow._ViewProviderWindow.colorize(), and ArchComponent.ViewProviderComponent.onChanged().

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

updateData()

def ArchCurtainWall.ViewProviderCurtainWall.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 from ArchComponent.ViewProviderComponent.

References ArchComponent.ViewProviderComponent.colorize(), ArchCurtainWall.ViewProviderCurtainWall.colorize(), and ArchWindow._ViewProviderWindow.colorize().

Referenced by ArchStructure.CommandStructuralSystem.Activated(), PathScripts.PathJobDlg.JobCreate.exec_(), draftviewproviders.view_dimension.ViewProviderLinearDimension.onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension.onChanged(), draftviewproviders.view_wire.ViewProviderWire.onChanged(), PathScripts.PathOpGui.TaskPanelPage.pageUpdateData(), PathScripts.PathPropertyBagGui.TaskPanel.setupUi(), and PathScripts.PathSetupSheetGui.OpTaskPanel.setupUi().

---

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

• FreeCAD/src/Mod/Arch/ArchCurtainWall.py