FeaturePython methods: Difference between revisions

From FreeCAD Documentation
(Fix links to FeaturePython Objects and Scripted objects)
No edit summary
Line 1: Line 1:
<languages/>
<translate>

==Introduction==
==Introduction==

This page serves as a reference for the available public methods on [[FeaturePython Objects]] or [[Scripted objects]].
This page serves as a reference for the available public methods on [[FeaturePython Objects]] or [[Scripted objects]].


==Reference==
==Reference==

{| class="wikitable" cellpadding="5px" width="100%"
{| class="wikitable" cellpadding="5px" width="100%"
|+ FeaturePython basic callbacks
|+ FeaturePython basic callbacks
Line 25: Line 30:


==See Also==
==See Also==

* [https://github.com/FreeCAD/FreeCAD/blob/76e74294894bbce46d006e149315c6274d206278/src/App/FeaturePython.h#L44-L86 FreeCAD GitHub: FeaturePython.h - public API]
* [https://github.com/FreeCAD/FreeCAD/blob/76e74294894bbce46d006e149315c6274d206278/src/App/FeaturePython.h#L44-L86 FreeCAD GitHub: FeaturePython.h - public API]

</translate>
{{Powerdocnavi{{#translation:}}}}
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Python Code{{#translation:}}]]
{{clear}}

Revision as of 07:17, 4 August 2020

Introduction

This page serves as a reference for the available public methods on FeaturePython Objects or Scripted objects.

Reference

FeaturePython basic callbacks
execute(self, obj) Called during document recomputes Do not call recompute() from this method (or any method called from execute()) as this causes a nested recompute.
onBeforeChanged(self, obj, prop) Called before a property value is changed 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.
onChanged(self, obj, prop) Called after a property is changed prop is the name of the property to be changed, not the property object itself.
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 __init__() method is not called when the object is reconstructed. Adding self.Object = obj or obj.Proxy = self often solves these issues.

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

See Also