From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page Viewprovider and the translation is 47% complete.
Other languages:


Le Viewproviders sono classi che definiscono il modo in cui gli oggetti appariranno nella Vista ad albero e nella Vista 3D, e come interagiranno con certe azioni grafiche come la selezione.

Completano gli scripted objects. Mentre la classe base dell'oggetto con script definisce le suoe data proprietà, il viewprovider definisce le view proprietà. Queste proprietà della vista non sono informazioni essenziali dell'oggetto, poiché indicano solo informazioni superficiali come larghezza della linea, colore della linea, colore del viso, ecc. In una sessione solo terminale, il viewprovider non viene caricato perché non ci sarà alcuna interfaccia per manipolare quelli visibili proprietà.

Come per le proprietà dei dati, le proprietà della vista sono accessibili dall'editor di proprietà.

View providers di Python

Le classi viewprovider di solito includono ViewProvider nel loro nome. Sono assegnati sull'attributo ViewObject dell'oggetto di base.

In this example, we define two properties for the viewprovider, only if the properties don't already exist, and assign their default values. We also define the onChanged method that runs every time a property changes. We need to test the property by name, and then we will call one of two methods that will do the actual work of updating the pattern or setting its size.

# views/
class ViewProviderCustom:
    """Viewprovider of the custom object."""

    def __init__(self, vobj):
        self.Object = vobj.Object

        vobj.Proxy = self

    def _set_properties(self, vobj):
        if not hasattr(vobj, "Pattern"):
                             "Defines a hatch pattern for this object.")
            vobj.Pattern = ["None", "diagonals", "cross", "brick"]

        if not hasattr(vobj, "PatternSize"):
                             "Defines the size of the hatch pattern.")
            vobj.PatternSize = 1

    def onChanged(self, vobj, prop):
        if prop in "Pattern":
        if prop in "PatternSize":

    def _set_pattern(self, pattern):

    def _set_size(self, size):

The normal workflow is to first add the object proxy class, for example, CustomObject, and then the viewprovider, for example, ViewProviderCustom. The viewprovider can only be assigned when we have verified that the graphical interface is available, as otherwise the ViewObject attribute doesn't exist, and it will be an error to use this element as input for our class.

import FreeCAD as App
import objects.custom as custom
import views.view_custom as view_custom

doc = App.newDocument()
obj = doc.addObject("Part::FeaturePython", "Custom")


if App.GuiUp:

Custom icons

By implementing the getIcon method, you can specify the icon that will be shown in the tree view in the upper part of the combo view.

The return value can be the full path to an icon.

import os
some_path = "/home/user/.FreeCAD/custom_icons"

class ViewProviderCustom:

    def getIcon(self):
        return os.path.join(some_path, "my_icon.svg")

The relative path to an icon inside a compiled resource file.


class ViewProviderCustom:

    def getIcon(self):
        return ":/icons/my_icon.svg"

A raw XPM icon, which is essentially ASCII art.


class ViewProviderCustom:

    def getIcon(self):
        return """
               /* XPM */
               static char *Some_icon_xpm[] = {
               /* columns rows colors chars-per-pixel */
               "16 16 3 1 ",
               "  c None",
               ". c #D71414",
               "+ c #AA1919",
               /* pixels */
               "                ",
               "  +          +  ",
               " +.+        +.+ ",
               "  +.+      +.+  ",
               "   +        +   ",
               "      ++++      ",
               "     +....+     ",
               "     +...++     ",
               "     +..+++     ",
               "     +.++.+     ",
               "      ++++      ",
               "   +        +   ",
               "  +.+      +.+  ",
               " +.+        +.+ ",
               "  +          +  ",
               "                "

See various examples in Custom icon in tree view.