App::VRMLObject Class Reference
#include <VRMLObject.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 Base::Type | getTypeId (void) const |
| virtual const char * | getViewProviderName (void) const |
| returns the type name of the ViewProvider | |
| virtual short | mustExecute (void) const |
| mustExecute We call this method to check if the object was modified to be invoked. | |
| VRMLObject (void) | |
| Constructor. | |
| virtual | ~VRMLObject () |
Static Public Member Functions | |
| static void * | create (void) |
| static Base::Type | getClassTypeId (void) |
| static void | init (void) |
Public Attributes | |
| PropertyFileIncluded | VrmlFile |
Protected Member Functions | |
| virtual const App::PropertyData & | getPropertyData (void) const |
Static Protected Member Functions | |
| static const App::PropertyData * | getPropertyDataPtr (void) |
Detailed Description
Definition at line 34 of file VRMLObject.h.
Constructor & Destructor Documentation
| VRMLObject::VRMLObject | ( | void | ) |
Constructor.
Definition at line 37 of file VRMLObject.cpp.
References ADD_PROPERTY_TYPE, and App::Prop_None.
| VRMLObject::~VRMLObject | ( | ) | [virtual] |
Definition at line 42 of file VRMLObject.cpp.
Member Function Documentation
| void * App::VRMLObject::create | ( | void | ) | [static] |
Reimplemented from App::PropertyContainer.
Definition at line 34 of file VRMLObject.cpp.
| virtual DocumentObjectExecReturn* App::VRMLObject::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 VRMLObject.h.
References App::DocumentObject::StdReturn.
| Base::Type App::VRMLObject::getClassTypeId | ( | void | ) | [static] |
Reimplemented from App::PropertyContainer.
Definition at line 34 of file VRMLObject.cpp.
Referenced by RobotGui::ViewProviderRobotObject::updateData().
| const App::PropertyData & App::VRMLObject::getPropertyData | ( | void | ) | const [protected, virtual] |
Reimplemented from App::PropertyContainer.
Definition at line 34 of file VRMLObject.cpp.
| const App::PropertyData * App::VRMLObject::getPropertyDataPtr | ( | void | ) | [static, protected] |
Reimplemented from App::PropertyContainer.
Definition at line 34 of file VRMLObject.cpp.
| PyObject * VRMLObject::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 51 of file VRMLObject.cpp.
References Py::_None(), Py::Object::is(), Py::new_reference_to(), and App::DocumentObject::PythonObject.
| Base::Type App::VRMLObject::getTypeId | ( | void | ) | const [virtual] |
Reimplemented from App::PropertyContainer.
Definition at line 34 of file VRMLObject.cpp.
| virtual const char* App::VRMLObject::getViewProviderName | ( | void | ) | const [inline, virtual] |
returns the type name of the ViewProvider
Reimplemented from App::DocumentObject.
Definition at line 44 of file VRMLObject.h.
| void App::VRMLObject::init | ( | void | ) | [static] |
Reimplemented from App::PropertyContainer.
Definition at line 34 of file VRMLObject.cpp.
| short VRMLObject::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 46 of file VRMLObject.cpp.
Member Data Documentation
Definition at line 53 of file VRMLObject.h.
Referenced by Gui::ViewProviderVRMLObject::updateData().
The documentation for this class was generated from the following files:
