FeaturePython.ViewProviderBox Class Reference
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.
◆ onChanged()
| def FeaturePython.ViewProviderBox.onChanged | ( | self, | |
| vp, | |||
| prop | |||
| ) |
Print the name of the property that has changed
Referenced by ArchSite.Compass.buildCoordinates(), and ArchAxis.CommandArchGrid.IsActive().
◆ 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
The documentation for this class was generated from the following file:
- src/Mod/TemplatePyMod/FeaturePython.py
