forked from bartvdbraak/blender
PyAPI: update to bpy.types.Operator.5.py
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:
parent
020bbbb046
commit
e1910ac6ed
@ -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.
|
||||||
|
Loading…
Reference in New Issue
Block a user