View source for Create a FeaturePython object part II/pl

<languages/>

{{Docnav
|[[Create_a_FeaturePython_object_part_I|Create a FeaturePython object part I]]
|
|IconL=
|IconR=
}}

{{TOCright}}

==Introduction==

On the [[Create_a_FeaturePython_object_part_I|Create a FeaturePython object part I]] page we've focused on the internal aspects of a Python class built around a FeaturePython object, specifically an {{incode|App::FeaturePython}} object. We've created the object, defined some properties, and added a document-level event callback that allows our object to respond to a document recompute with the {{incode|execute()}} method. But our object still lacks a presence in the [[3D_view|3D view]]. Let's remedy that by adding a box.

==Adding a box==

First at the top of the {{FileName|box.py}} file, below the existing import, add:

{{Code|code=
import Part
}}

Then in {{incode|execute()}} delete the {{incode|print()}} statement and add the following line in its place:

{{Code|code=
Part.show(Part.makeBox(obj.Length, obj.Width, obj.Height))
}}

[[Image:App_featurepython_box.png | right]]

These commands execute Python methods that come with FreeCAD by default:
*The {{incode|Part.makeBox()}} method generates a box shape.
*The enclosing call to {{incode|Part.show()}} adds the shape to the document and makes it visible.

Delete any existing objects, reload the box module and create a new box object using {{incode|box.create()}}. Notice how a box immediately appears on the screen. That is because we force the document to recompute at the end of {{incode|box.create()}} which in turn triggers the {{incode|execute()}} method of our {{incode|box}} class.

At first glance the result may look fine but there are some problems. The most obvious one is that the box is represented by an entirely different object than our FeaturePython object. {{incode|Part.show()}} simply creates a separate box object and adds it to the document. Worse, if you change the dimensions of the FeaturePython object another box shape gets created, and the old one is left in place. And if you have the [[Report_view|Report view]] open, you may have noticed an error stating "Recursive calling of recompute for document Unnamed". This has to do with using the {{incode|Part.show()}} method inside a FeaturePython object.
{{clear}}

[[#top|top]]

==Fixing the code==

To solve these problems we have to make a number of changes. Until now we've been using a {{incode|App::FeaturePython}} object which is actually not intended to have a visual representation in the 3D view. We have to use a {{incode|Part::FeaturePython}} object instead. In {{incode|create()}} change the following line:

{{Code|code=
obj = App.ActiveDocument.addObject('App::FeaturePython', obj_name)
}}

to:

{{Code|code=
obj = App.ActiveDocument.addObject('Part::FeaturePython', obj_name)
}}

To get rid of the separate box object we need to assigns the result of the {{incode|makeBox()}} method to the {{incode|Shape}} property of our {{incode|Part::FeaturePython}} object. Change this line in {{incode|execute()}}:

{{Code|code=
Part.show(Part.makeBox(obj.Length, obj.Width, obj.Height))
}}

to:

{{Code|code=
obj.Shape = Part.makeBox(obj.Length, obj.Width, obj.Height)
}}

[[File:Part_featurepython_no_vp.png|right]]

Save your changes, switch back to FreeCAD, delete any existing objects, reload the box module, and create a new box object. The new result is somewhat disappointing. There no longer is an extra object in the Tree view, and the icon in the Tree view has changed, but our box in the 3D view is also gone (which is why the icon is gray). What happened? Although we've properly created our box shape and assigned it to a {{incode|Part::FeaturePython}} object, to make it actually show up in the 3D view we need to assign a [[Viewprovider|ViewProvider]].
{{clear}}

[[#top|top]]

==Writing a ViewProvider==

A View Provider is the component of an object which allows it to have a visual representation in the 3D view. FreeCAD uses an application structure which is designed to separate the data (the "model") from it's visual representation (the "view"). If you've spent any time working with FreeCAD in Python, you are likely already aware of this through the use of the two core Python modules: {{incode|FreeCAD}} and {{incode|FreeCADGui}} (often aliased as {{incode|App}} and {{incode|Gui}} repectively).

Our FeaturePython object also requires these elements. Thus far we've focused purely on the "model" portion of the code, now it's time to write the "view" portion. Fortunately most ViewProviders are simple and require little effort to write, at least to get started. Here's an example ViewProvider borrowed and slightly modified from [https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/TemplatePyMod/FeaturePython.py]:

{{Code|code=
class ViewProviderBox:

    def __init__(self, obj):
        """
        Set this object to the proxy object of the actual view provider
        """

        obj.Proxy = self

    def attach(self, obj):
        """
        Setup the scene sub-graph of the view provider, this method is mandatory
        """
        return

    def updateData(self, fp, prop):
        """
        If a property of the handled feature has changed we have the chance to handle this here
        """
        return

    def getDisplayModes(self,obj):
        """
        Return a list of display modes.
        """
        return []

    def getDefaultDisplayMode(self):
        """
        Return the name of the default display mode. It must be defined in getDisplayModes.
        """
        return "Shaded"

    def 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.
        """
        return mode

    def onChanged(self, vp, prop):
        """
        Print the name of the property that has changed
        """

        App.Console.PrintMessage("Change property: " + str(prop) + "\n")

    def 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.
        """

        return """
            /* XPM */
            static const char * ViewProviderBox_xpm[] = {
            "16 16 6 1",
            "    c None",
            ".   c #141010",
            "+   c #615BD2",
            "@   c #C39D55",
            "#   c #000000",
            "$   c #57C355",
            "        ........",
            "   ......++..+..",
            "   .@@@@.++..++.",
            "   .@@@@.++..++.",
            "   .@@  .++++++.",
            "  ..@@  .++..++.",
            "###@@@@ .++..++.",
            "##$.@@$#.++++++.",
            "#$#$.$$$........",
            "#$$#######      ",
            "#$$#$$$$$#      ",
            "#$$#$$$$$#      ",
            "#$$#$$$$$#      ",
            " #$#$$$$$#      ",
            "  ##$$$$$#      ",
            "   #######      "};
            """

    def dumps(self):
        """
        Called during document saving.
        """
        return None

    def loads(self,state):
        """
        Called during document restore.
        """
        return None
}}

In the code above, we define an XMP icon for this object. Icon design is beyond the scope of this tutorial, but basic design can be managed using open source tools like [https://www.gimp.org GIMP], [https://krita.org/en/ Krita], and [https://inkscape.org/ Inkscape]. The {{incode|getIcon()}} method is optional, FreeCAD will use a default icon if this method is not provided.

Add the ViewProvider code at the end of {{FileName|box.py}} and in the {{incode|create()}} method insert the following line above the {{incode|recompute()}} statement:

{{Code|code=
ViewProviderBox(obj.ViewObject)
}}

This instances the custom ViewProvider class and passes the FeaturePython's built-in ViewObject to it. When the ViewProvider class initializes, it saves a reference to itself in the FeaturePython's {{incode|ViewObject.Proxy}} attribute. This way, when FreeCAD needs to render our box visually, it can find the ViewProvider class to do that.

Now, save the changes and return to FreeCAD. Import or reload the box module and call {{incode|box.create()}}. You should now see two things:
*The icon for the box object has changed.
*And, more importantly, there is a box in the 3D view. If you do not see it press the {{Button|[[Image:Std_ViewFitAll.svg|16px]] [[Std_ViewFitAll|Std ViewFitAll]]}} button. You can even alter the dimensions of the box by changing the values in the [[Property_editor|Property editor]]. Give it a try!

[[#top|top]]

==Trapping events==

We have already discussed event trapping. Nearly every method of a FeaturePython class serves as a callback accessible to the FeaturePython object (which gets access to our class instance through the {{incode|Proxy}} attribute).

Below is a list of the callbacks that may be implemented in the basic FeaturePython object:

{| class="wikitable" cellpadding="5px" width="100%"
|+ FeaturePython basic callbacks
|style="width:25%" | {{incode|execute(self, obj)}}
|style="width:25%" | Called during document recomputes
|style="width:50%" | Do not call {{incode|recompute()}} from this method (or any method called from {{incode|execute()}}) as this causes a nested recompute.
|-
| {{incode|onBeforeChange(self, obj, prop)}}
| Called before a property value is changed
| {{incode|prop}} is the name of the property to be changed, not the property object itself. Property changes cannot be cancelled.  Previous / next property values are not simultaneously available for comparison.
|-
| {{incode|onChanged(self, obj, prop)}}
| Called after a property is changed
| {{incode|prop}} is the name of the property to be changed, not the property object itself.
|-
| {{Incode|onDocumentRestored(self, obj)}}
| Called after a document is restored or a FeaturePython object is copied.
| Occasionally, references to the FeaturePython object from the class, or the class from the FeaturePython object may be broken, as the class {{incode|__init__()}} method is not called when the object is reconstructed. Adding {{incode|self.Object <nowiki>=</nowiki> obj}} or {{incode|obj.Proxy <nowiki>=</nowiki> self}} often solves these issues.
|}

For a complete reference of FeaturePython methods available, see [[FeaturePython_methods|FeaturePython methods]].

In addition, there are two callbacks in the ViewProvider class that may occasionally prove useful:

{| class="wikitable" cellpadding="5px" width="100%"
|+ ViewProvider basic callbacks
|-
|style="width:25%" | {{incode|updateData(self, obj, prop)}}
|style="width:25%" | Called after a data (model) property is changed
|style="width:50%" | {{incode|obj}} is a reference to the FeaturePython class instance, not the ViewProvider instance.  {{incode|prop}} is the name of the property to be changed, not the property object itself.
|-
| {{incode|onChanged(self, vobj, prop)}}
| Called after a view property is changed
| {{incode|vobj}} is a reference to the ViewProvider instance.  {{incode|prop}} is the name of the view property which was changed.
|}

It is not uncommon to encounter a situation where the Python callbacks are not being triggered as they should. Beginners in this area can rest assured that the FeaturePython callback system is not fragile or broken. Invariably when callbacks fail to run it is because a reference is lost or undefined in the underlying code. If, however, callbacks appear to be breaking with no explanation, providing object/proxy references in the {{incode|onDocumentRestored()}} callback (as noted in the first table above) may alleviate these problems. Until you are comfortable with the callback system, it may be useful to add print statements in each callback to print messages to the console during development.

[[#top|top]]

==Complete code==

{{Code|code=
import FreeCAD as App
import Part

def create(obj_name):
    """
    Object creation method
    """

    obj = App.ActiveDocument.addObject('Part::FeaturePython', obj_name)

    box(obj)

    ViewProviderBox(obj.ViewObject)

    App.ActiveDocument.recompute()

    return obj

class box():

    def __init__(self, obj):
        """
        Default constructor
        """

        self.Type = 'box'

        obj.Proxy = self

        obj.addProperty('App::PropertyString', 'Description', 'Base', 'Box description').Description = ""
        obj.addProperty('App::PropertyLength', 'Length', 'Dimensions', 'Box length').Length = 10.0
        obj.addProperty('App::PropertyLength', 'Width', 'Dimensions', 'Box width').Width = '10 mm'
        obj.addProperty('App::PropertyLength', 'Height', 'Dimensions', 'Box height').Height = '1 cm'

    def execute(self, obj):
        """
        Called on document recompute
        """

        obj.Shape = Part.makeBox(obj.Length, obj.Width, obj.Height)

class ViewProviderBox:

    def __init__(self, obj):
        """
        Set this object to the proxy object of the actual view provider
        """

        obj.Proxy = self

    def attach(self, obj):
        """
        Setup the scene sub-graph of the view provider, this method is mandatory
        """
        return

    def updateData(self, fp, prop):
        """
        If a property of the handled feature has changed we have the chance to handle this here
        """
        return

    def getDisplayModes(self,obj):
        """
        Return a list of display modes.
        """
        return []

    def getDefaultDisplayMode(self):
        """
        Return the name of the default display mode. It must be defined in getDisplayModes.
        """
        return "Shaded"

    def 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.
        """
        return mode

    def onChanged(self, vp, prop):
        """
        Print the name of the property that has changed
        """

        App.Console.PrintMessage("Change property: " + str(prop) + "\n")

    def 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.
        """

        return """
            /* XPM */
            static const char * ViewProviderBox_xpm[] = {
            "16 16 6 1",
            "    c None",
            ".   c #141010",
            "+   c #615BD2",
            "@   c #C39D55",
            "#   c #000000",
            "$   c #57C355",
            "        ........",
            "   ......++..+..",
            "   .@@@@.++..++.",
            "   .@@@@.++..++.",
            "   .@@  .++++++.",
            "  ..@@  .++..++.",
            "###@@@@ .++..++.",
            "##$.@@$#.++++++.",
            "#$#$.$$$........",
            "#$$#######      ",
            "#$$#$$$$$#      ",
            "#$$#$$$$$#      ",
            "#$$#$$$$$#      ",
            " #$#$$$$$#      ",
            "  ##$$$$$#      ",
            "   #######      "};
            """

    def dumps(self):
        """
        Called during document saving.
        """
        return None

    def loads(self,state):
        """
        Called during document restore.
        """
        return None
}}

[[#top|top]]

{{Docnav
|[[Create_a_FeaturePython_object_part_I|Create a FeaturePython object part I]]
|
|IconL=
|IconR=
}}

{{Powerdocnavi{{#translation:}}}}
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Python Code{{#translation:}}]]
{{clear}}