Commit f7c3210c authored by Mike Kremer's avatar Mike Kremer
Browse files

Updated section about geometry handling and updateing

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@5420 383ad7c9-94d9-4d36-a494-682f7c89f535
parent c7a0900b
......@@ -73,25 +73,40 @@
* \subsection updatingObjects Updating objects
*
* Once your plugin has manipulated object data we have to inform OpenFlipper's core about the changes.
* When doing this, OpenFlipper distinguishes between two fundamental types of changes:
* When doing this, OpenFlipper distinguishes between four fundamental types of changes:
*
* - Changing geometry
* - Changing object properties
* - Changing object's visibility
* - Changing selection type
*
* When changing geometry, OpenFlipper's core will be forced to redraw the object that has been
* changed by calling:
*
* \ref BaseInterface::updatedObject(int _idx)
* \ref BaseInterface::updatedObject(int _id)
*
* where \c _idx is the object's id.
* where \c _id is the object's id.
*
* When changing object properties e.g. changing the marking from source to target object, it
* won't be necessary to redraw the scene since it can be expensive in computation power.
* In this case, one should call the
* In this case, one should call
*
* \ref BaseInterface::objectPropertiesChanged(int _idx)
* \ref BaseInterface::objectPropertiesChanged(int _id)
*
* where \c _idx once again is the object's id.
* where \c _id once again is the object's id.
*
* If a plugin changed an object's visibility (hide, show), it should call
*
* \ref BaseInterface::visibilityChanged(int _id)
*
* for the core to update the visibility state of object with identifier \c _id.
*
* Last, when changing an object's selection flag (TARGET, SOURCE), it
* will be updated by calling
*
* \ref BaseInterface::objectSelectionChanged(int _id)
*
* where \c _id as in the examples above is the object's identifier.
*
* Also see \ref BaseInterface.
*/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment