App::InventorObject Class Reference
#include <InventorObject.h>
Public Member Functions | |
| virtual DocumentObjectExecReturn * | execute (void) |
| get called by the document to recompute this feature Normaly this method get called in the processing of Document::recompute(). | |
| virtual PyObject * | getPyObject (void) |
| This method returns the Python wrapper for a C++ object. | |
| virtual const char * | getViewProviderName (void) const |
| returns the type name of the ViewProvider | |
| InventorObject (void) | |
| Constructor. | |
| virtual short | mustExecute (void) const |
| mustExecute We call this method to check if the object was modified to be invoked. | |
| virtual | ~InventorObject () |
Public Attributes | |
| PropertyString | Buffer |
| PropertyString | FileName |
Detailed Description
Definition at line 34 of file InventorObject.h.
Constructor & Destructor Documentation
| InventorObject::InventorObject | ( | void | ) |
Constructor.
Definition at line 37 of file InventorObject.cpp.
References ADD_PROPERTY_TYPE, and App::Prop_None.
| InventorObject::~InventorObject | ( | ) | [virtual] |
Definition at line 43 of file InventorObject.cpp.
Member Function Documentation
| virtual DocumentObjectExecReturn* App::InventorObject::execute | ( | void | ) | [inline, virtual] |
get called by the document to recompute this feature Normaly this method get called in the processing of Document::recompute().
In execute() the outpupt properties get recomputed with the data from linked objects and objects own properties.
Reimplemented from App::DocumentObject.
Definition at line 47 of file InventorObject.h.
References App::DocumentObject::StdReturn.
| PyObject * InventorObject::getPyObject | ( | void | ) | [virtual] |
This method returns the Python wrapper for a C++ object.
It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.
The default implementation returns 'None'.
Reimplemented from App::DocumentObject.
Definition at line 52 of file InventorObject.cpp.
References Py::_None(), Py::Object::is(), Py::new_reference_to(), and App::DocumentObject::PythonObject.
| virtual const char* App::InventorObject::getViewProviderName | ( | void | ) | const [inline, virtual] |
returns the type name of the ViewProvider
Reimplemented from App::DocumentObject.
Definition at line 44 of file InventorObject.h.
| short InventorObject::mustExecute | ( | void | ) | const [virtual] |
mustExecute We call this method to check if the object was modified to be invoked.
If the object label or an argument is modified. If we must recompute the object - to call the method execute(). 0: no recompution is needed 1: recompution needed -1: the document examine all links of this object and if one is touched -> recompute
Reimplemented from App::DocumentObject.
Definition at line 47 of file InventorObject.cpp.
Member Data Documentation
Definition at line 53 of file InventorObject.h.
Referenced by Gui::ViewProviderInventorObject::updateData().
Definition at line 54 of file InventorObject.h.
Referenced by Gui::ViewProviderInventorObject::updateData().
The documentation for this class was generated from the following files:
