sandey/blender
1
0
Fork 0
forked from bartvdbraak/blender
Code Pull Requests Activity

PyAPI: update to bpy.types.Operator.5.py

Browse Source 
This is a minor update add more information on how Blender handles modal
operators. The existing docs provide a good overview, but might not be
as helpful to those unfamiliar with modal programming. This patch also
corrects a few small grammar issues.
This commit is contained in:
nBurn 2017-06-01 21:59:51 -04:00 committed by Aaron Carlisle
parent 020bbbb046
commit e1910ac6ed
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/python_api/examples/bpy.types.Operator.5.py
View File

@ -2,13 +2,14 @@
Modal Execution Modal Execution
+++++++++++++++ +++++++++++++++
This operator defines a :class:`Operator.modal` function which running, This operator defines a :class:`Operator.modal` function that will keep being
handling events until it returns ``{'FINISHED'}`` or ``{'CANCELLED'}``. run to handle events until it returns ``{'FINISHED'}`` or ``{'CANCELLED'}``.
Grab, Rotate, Scale and Fly-Mode are examples of modal operators. Modal operators run every time a new event is detected, such as a mouse click
They are especially useful for interactive tools, or key press. Conversely, when no new events are detected, the modal operator
your operator can have its own state where keys toggle options as the operator will not run. Modal operators are especially useful for interactive tools, an
runs. operator can have its own state where keys toggle options as the operator runs.
Grab, Rotate, Scale, and Fly-Mode are examples of modal operators.
:class:`Operator.invoke` is used to initialize the operator as being by :class:`Operator.invoke` is used to initialize the operator as being by
returning ``{'RUNNING_MODAL'}``, initializing the modal loop. returning ``{'RUNNING_MODAL'}``, initializing the modal loop.