Public Member Functions | |
| def | attach (self, obj) |
| def | getDefaultDisplayMode (self) |
| def | getDisplayModes (self, obj) |
| def | getIcon (self) |
| def | onChanged (self, vp, prop) |
| def | setDisplayMode (self, mode) |
| def | updateData (self, fp, prop) |
Member Function Documentation
◆ attach()
| def FeaturePython.ViewProviderBox.attach | ( | self, | |
| obj | |||
| ) |
Setup the scene sub-graph of the view provider, this method is mandatory
◆ getDefaultDisplayMode()
| def FeaturePython.ViewProviderBox.getDefaultDisplayMode | ( | self | ) |
Return the name of the default display mode. It must be defined in getDisplayModes.
◆ getDisplayModes()
| def FeaturePython.ViewProviderBox.getDisplayModes | ( | self, | |
| obj | |||
| ) |
Return a list of display modes.
◆ getIcon()
| def FeaturePython.ViewProviderBox.getIcon | ( | self | ) |
Return the icon in XMP format which will appear in the tree view. This method is optional
and if not defined a default icon is shown.
Referenced by ArchAxis.AxisSystemTaskPanel.update(), ArchComponent.ComponentTaskPanel.update(), and ArchSectionPlane.SectionPlaneTaskPanel.update().
◆ onChanged()
| def FeaturePython.ViewProviderBox.onChanged | ( | self, | |
| vp, | |||
| prop | |||
| ) |
Print the name of the property that has changed
Referenced by draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), draftobjects.wire.Wire.execute(), ArchAxis.CommandArchGrid.IsActive(), 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().
◆ setDisplayMode()
| def FeaturePython.ViewProviderBox.setDisplayMode | ( | self, | |
| mode | |||
| ) |
Map the display mode defined in attach with those defined in getDisplayModes.
Since they have the same names nothing needs to be done. This method is optional.
◆ updateData()
| def FeaturePython.ViewProviderBox.updateData | ( | self, | |
| fp, | |||
| prop | |||
| ) |
If a property of the handled feature has changed we have the chance to handle this here
Referenced by 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:
- Sources/FreeCAD/src/Mod/TemplatePyMod/FeaturePython.py
