[Bf-docboard-svn] bf-manual: [9029] branches/blender-3.1-release/blender_docs/manual/interface: Interface: Add generic operator page to describe what an operator is

Aaron Carlisle noreply at blender.org
Fri Feb 25 05:56:50 CET 2022 

Revision: 9029
          https://developer.blender.org/rBM9029
Author:   Blendify
Date:     2022-02-25 05:56:50 +0100 (Fri, 25 Feb 2022)
Log Message:
-----------
Interface: Add generic operator page to describe what an operator is

Modified Paths:
--------------
    branches/blender-3.1-release/blender_docs/manual/interface/controls/buttons/buttons.rst
    branches/blender-3.1-release/blender_docs/manual/interface/controls/buttons/menus.rst
    branches/blender-3.1-release/blender_docs/manual/interface/controls/nodes/sidebar.rst
    branches/blender-3.1-release/blender_docs/manual/interface/controls/templates/operator_search.rst
    branches/blender-3.1-release/blender_docs/manual/interface/index.rst
    branches/blender-3.1-release/blender_docs/manual/interface/undo_redo.rst
    branches/blender-3.1-release/blender_docs/manual/interface/window_system/regions.rst

Added Paths:
-----------
    branches/blender-3.1-release/blender_docs/manual/interface/operators.rst

Modified: branches/blender-3.1-release/blender_docs/manual/interface/controls/buttons/buttons.rst
===================================================================
--- branches/blender-3.1-release/blender_docs/manual/interface/controls/buttons/buttons.rst	2022-02-25 02:34:12 UTC (rev 9028)
+++ branches/blender-3.1-release/blender_docs/manual/interface/controls/buttons/buttons.rst	2022-02-25 04:56:50 UTC (rev 9029)
@@ -14,8 +14,9 @@
 
    Operator button.
 
-Operator buttons perform an action when clicked with :kbd:`LMB`.
-Button may show an icon, text, or both.
+Operator buttons execute an :doc:`Operator </interface/operators>`
+which in summary execute an action when clicked with :kbd:`LMB`.
+Operator buttons may be an icon, text, or text with an icon.
 
 .. container:: lead
 

Modified: branches/blender-3.1-release/blender_docs/manual/interface/controls/buttons/menus.rst
===================================================================
--- branches/blender-3.1-release/blender_docs/manual/interface/controls/buttons/menus.rst	2022-02-25 02:34:12 UTC (rev 9028)
+++ branches/blender-3.1-release/blender_docs/manual/interface/controls/buttons/menus.rst	2022-02-25 04:56:50 UTC (rev 9029)
@@ -4,7 +4,7 @@
 Menus
 *****
 
-Blender uses a variety of different menus for accessing options and operators.
+Blender uses a variety of different menus for accessing options and :doc:`/interface/operators`.
 Selecting menus can be interacted with in the following ways:
 
 Mouse selection
@@ -31,8 +31,8 @@
   or by :kbd:`LMB` clicking anywhere out of it.
 
 
+.. _bpy.types.UIPopupMenu:
 .. _ui-header-menu:
-.. _bpy.types.UIPopupMenu:
 
 Header Menus
 ============

Modified: branches/blender-3.1-release/blender_docs/manual/interface/controls/nodes/sidebar.rst
===================================================================
--- branches/blender-3.1-release/blender_docs/manual/interface/controls/nodes/sidebar.rst	2022-02-25 02:34:12 UTC (rev 9028)
+++ branches/blender-3.1-release/blender_docs/manual/interface/controls/nodes/sidebar.rst	2022-02-25 04:56:50 UTC (rev 9029)
@@ -47,7 +47,7 @@
    Color of the node background.
 
    Node Color Specials
-      This menu contains operators for working with nodes with custom colors.
+      This menu contains :doc:`/interface/operators` for working with nodes with custom colors.
 
       .. _bpy.ops.node.node_copy_color:
 

Modified: branches/blender-3.1-release/blender_docs/manual/interface/controls/templates/operator_search.rst
===================================================================
--- branches/blender-3.1-release/blender_docs/manual/interface/controls/templates/operator_search.rst	2022-02-25 02:34:12 UTC (rev 9028)
+++ branches/blender-3.1-release/blender_docs/manual/interface/controls/templates/operator_search.rst	2022-02-25 04:56:50 UTC (rev 9029)
@@ -15,7 +15,8 @@
    :Menu:      :menuselection:`Edit --> Menu Search`
    :Shortcut:  :kbd:`F3`
 
-The Menu Search pop-up searches Blender's interface for a desired operator and allows you to execute that operator.
+The Menu Search pop-up searches Blender's interface for a desired
+:doc:`/interface/operators` and allows you to execute that operator.
 It displays a list of matches and shows which menu the operator was found in.
 Start typing the name of the operator you want to refine the list.
 When the list is sufficiently narrowed, :kbd:`LMB` on the desired operator or
@@ -44,7 +45,8 @@
 
 When :ref:`Developer Extras <prefs-interface-dev-extras>` are activated
 the Operator Search can be accessed from the Edit menu in the Topbar.
-This search menu search all operators within Blender even if they are not exposed in a menu.
+This search menu search all :doc:`/interface/operators`
+within Blender even if they are not exposed in a menu.
 This is useful for Python developers for testing purposes.
 Blender might also include a few advanced operators that are not
 exposed in a menu and can only be accessed via this search menu.

Modified: branches/blender-3.1-release/blender_docs/manual/interface/index.rst
===================================================================
--- branches/blender-3.1-release/blender_docs/manual/interface/index.rst	2022-02-25 02:34:12 UTC (rev 9028)
+++ branches/blender-3.1-release/blender_docs/manual/interface/index.rst	2022-02-25 04:56:50 UTC (rev 9029)
@@ -68,13 +68,14 @@
    controls/nodes/index.rst
 
 
-Tools
-=====
+Tools & Operators
+=================
 
 .. toctree::
    :maxdepth: 1
 
    tool_system.rst
+   operators.rst
    undo_redo.rst
    annotate_tool.rst
    selecting.rst

Added: branches/blender-3.1-release/blender_docs/manual/interface/operators.rst
===================================================================
--- branches/blender-3.1-release/blender_docs/manual/interface/operators.rst	                        (rev 0)
+++ branches/blender-3.1-release/blender_docs/manual/interface/operators.rst	2022-02-25 04:56:50 UTC (rev 9029)
@@ -0,0 +1,42 @@
+
+*********
+Operators
+*********
+
+Operators execute an action as soon as the operator is started
+which make them different from tools which require some sort of input.
+Operators can be started from a :ref:`ui-operator-buttons`,
+:ref:`ui-header-menu`, or :ref:`bpy.ops.wm.search_menu`.
+Examples of operators include adding a new object,
+deleting it, or setting its shading to smooth.
+
+
+Operator Properties
+===================
+
+Most operators have properties that can be adjusted to refine the result of the operation.
+To adjust an operators properties, the operator must first be executed.
+This will execute the operation with its default property values.
+These properties can then be adjusted using :ref:`bpy.ops.screen.redo_last`.
+
+
+Modal Operators
+===============
+
+Modal operators exist as concept in between :doc:`Tools </interface/tool_system>`
+and regular described above operators.
+They require some sort of input to interactively control the operator's properties.
+
+
+Slider Operators
+----------------
+
+Slider operators are a type of modal operator used interactively adjust a factor property.
+Slider operators will display a percentage graphic in the editor's :ref:`ui-region-header`.
+Slider operators can adjust the operator's factor value by moving
+the mouse left or right to decrease or increase the factor property.
+
+Values can be snapped to 10% increments by holding :kbd:`Ctrl`
+and changed using precision by holding :kbd:`Shift`.
+Values can extend beyond the 0-100% range by toggling "overshoot" on with :kbd:`E`.
+Note, overshoot is not be available for all slider operators.


Property changes on: branches/blender-3.1-release/blender_docs/manual/interface/operators.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: branches/blender-3.1-release/blender_docs/manual/interface/undo_redo.rst
===================================================================
--- branches/blender-3.1-release/blender_docs/manual/interface/undo_redo.rst	2022-02-25 02:34:12 UTC (rev 9028)
+++ branches/blender-3.1-release/blender_docs/manual/interface/undo_redo.rst	2022-02-25 04:56:50 UTC (rev 9029)
@@ -52,7 +52,7 @@
    :Menu:      :menuselection:`Edit --> Adjust Last Operation...`
    :Shortcut:  :kbd:`F9`
 
-After an operation is complete you can tweak the parameters of the operation afterwards.
+After an operation is complete you can tweak the parameters of :doc:`/interface/operators` afterwards.
 In editors that support it, there is a "head-up display" panel in the bottom left
 based on the last performed operation; dependent on mode and context.
 Alternatively, you can create a pop-up with :kbd:`F9` which does the same thing.

Modified: branches/blender-3.1-release/blender_docs/manual/interface/window_system/regions.rst
===================================================================
--- branches/blender-3.1-release/blender_docs/manual/interface/window_system/regions.rst	2022-02-25 02:34:12 UTC (rev 9028)
+++ branches/blender-3.1-release/blender_docs/manual/interface/window_system/regions.rst	2022-02-25 04:56:50 UTC (rev 9029)
@@ -33,8 +33,8 @@
 See specific documentation about each editor in the :doc:`Editors </editors/index>` chapter.
 
 
+.. _bpy.types.Header:
 .. _ui-region-header:
-.. _bpy.types.Header:
 
 Header
 ======
@@ -139,7 +139,7 @@
 
 .. figure:: /images/interface_window-system_regions_scrollbar_widget.png
    :align: center
-   
+
    Scrollbars with zoom widgets.
 
 This can be used to stretch or compress the range to show more or less detail within the available screen space.

More information about the Bf-docboard-svn mailing list