[Bf-docboard-svn] bf-manual: [8309] trunk/blender_docs/manual/addons/rigging/rigify: Rigify: document new modular face rig types and minor features.

Alexander Gavrilov noreply at blender.org
Wed Aug 11 12:00:42 CEST 2021 

Revision: 8309
          https://developer.blender.org/rBM8309
Author:   angavrilov
Date:     2021-08-11 12:00:42 +0200 (Wed, 11 Aug 2021)
Log Message:
-----------
Rigify: document new modular face rig types and minor features.

Modified Paths:
--------------
    trunk/blender_docs/manual/addons/rigging/rigify/bone_positioning.rst
    trunk/blender_docs/manual/addons/rigging/rigify/metarigs.rst
    trunk/blender_docs/manual/addons/rigging/rigify/rig_types/basic.rst
    trunk/blender_docs/manual/addons/rigging/rigify/rig_types/faces.rst
    trunk/blender_docs/manual/addons/rigging/rigify/rig_types/index.rst
    trunk/blender_docs/manual/addons/rigging/rigify/rig_types/limbs.rst

Added Paths:
-----------
    trunk/blender_docs/manual/addons/rigging/rigify/rig_types/face.rst
    trunk/blender_docs/manual/addons/rigging/rigify/rig_types/skin.rst

Modified: trunk/blender_docs/manual/addons/rigging/rigify/bone_positioning.rst
===================================================================
--- trunk/blender_docs/manual/addons/rigging/rigify/bone_positioning.rst	2021-08-10 23:29:33 UTC (rev 8308)
+++ trunk/blender_docs/manual/addons/rigging/rigify/bone_positioning.rst	2021-08-11 10:00:42 UTC (rev 8309)
@@ -55,8 +55,10 @@
 
 .. warning::
 
-   While placing the lip bones you should keep the opposite bone chains merged in the middle.
-   Tearing the merge point apart may result in a misalignment of controls in the final rig.
+   While moving the face bones it is necessary to preserve merge points, i.e. whenever heads
+   or tails of two or more bones overlap at the same point, they should still do so after
+   repositioning. Tearing a merge point apart may result in multiple controls being created
+   instead of one, or even generation errors.
 
 .. figure:: /images/addons_rigging_rigify_bone-positioning_face-stretcher-bones.png
    :align: center
@@ -66,10 +68,6 @@
 After the main face bones are placed use the cheek bone to connect the eye-nose area to the jaw mouth area.
 Then do the same with the brow area. This process will automatically define face muscles compression areas.
 
-.. tip:: Merge Points
-
-   The rig will generically work as its best if you keep the bone connected at their merge points.
-
 Position the eye bones in the eye pivot point facing right **toward** the face on the Y axis.
 
 .. figure:: /images/addons_rigging_rigify_bone-positioning_face-eyes-pivot-position.png

Modified: trunk/blender_docs/manual/addons/rigging/rigify/metarigs.rst
===================================================================
--- trunk/blender_docs/manual/addons/rigging/rigify/metarigs.rst	2021-08-10 23:29:33 UTC (rev 8308)
+++ trunk/blender_docs/manual/addons/rigging/rigify/metarigs.rst	2021-08-11 10:00:42 UTC (rev 8309)
@@ -110,6 +110,18 @@
 .. _bpy.types.RigifySelectionColors:
 .. _bpy.types.RigifyArmatureLayer:
 
+
+Custom Root Bone
+^^^^^^^^^^^^^^^^
+
+If the meta-rig contains a bone called 'root', it is used as the root control bone instead of creating
+a new one. This allows changing the rest position of the root bone, assigning a custom widget, or adding
+custom properties to the bone.
+
+The custom root bone must use the :ref:`basic.raw_copy <rigify.rigs.basic.raw_copy>` sub-rig
+type, either explicitly or implicitly by not selecting any type.
+
+
 Layers, Bone Groups & Selection Sets
 ====================================
 

Modified: trunk/blender_docs/manual/addons/rigging/rigify/rig_types/basic.rst
===================================================================
--- trunk/blender_docs/manual/addons/rigging/rigify/rig_types/basic.rst	2021-08-10 23:29:33 UTC (rev 8308)
+++ trunk/blender_docs/manual/addons/rigging/rigify/rig_types/basic.rst	2021-08-11 10:00:42 UTC (rev 8309)
@@ -11,6 +11,8 @@
 This is unlike chain-based rig types that usually consume the whole connected chain.
 
 
+.. _rigify.rigs.basic.copy_chain:
+
 ``basic.copy_chain``
 ====================
 
@@ -25,6 +27,8 @@
    When enabled deform bones will be created.
 
 
+.. _rigify.rigs.basic.pivot:
+
 ``basic.pivot``
 ===============
 
@@ -37,6 +41,9 @@
    When enabled an extra parent control bone with a box widget is created to allow moving the rig.
    It is also required by all other options besides *Deform Bone*.
 
+Widget Type
+   Allows selecting one of the predefined widgets to generate for the master control instead of the default cube.
+
 Switchable Parent
    Generates a mechanism for switching the effective parent of the rig based on the value of a custom property.
 
@@ -65,6 +72,8 @@
    When enabled a deform bone will be created.
 
 
+.. _rigify.rigs.basic.raw_copy:
+
 ``basic.raw_copy``
 ==================
 
@@ -95,6 +104,8 @@
    if it has no parent; enter ``root`` in the *Parent* field if that is necessary.
 
 
+.. _rigify.rigs.basic.super_copy:
+
 ``basic.super_copy``
 ====================
 
@@ -104,8 +115,11 @@
 Control (Boolean)
    When enabled a control bone and widget will be created.
 Widget (Boolean)
-   When enabled a circle widget will be created in replacement to the standard.
+   When enabled a widget will be created in replacement to the standard.
+Widget Type (String):
+   Allows selecting one of the predefined widget types to generate instead of the default circle.
 Deform (Boolean)
    When enabled a deform bone will be created.
 Relink Constraints
-   Works the same as in the `basic.raw_copy`_ rig.
+   Works the same as in the `basic.raw_copy`_ rig. In addition, when enabled any constraints that have
+   names prefixed with ``CTRL:`` are moved to the control, and with ``DEF:`` to the deform bone.

Added: trunk/blender_docs/manual/addons/rigging/rigify/rig_types/face.rst
===================================================================
--- trunk/blender_docs/manual/addons/rigging/rigify/rig_types/face.rst	                        (rev 0)
+++ trunk/blender_docs/manual/addons/rigging/rigify/rig_types/face.rst	2021-08-11 10:00:42 UTC (rev 8309)
@@ -0,0 +1,71 @@
+
+****
+Face
+****
+
+These rig types implement components of a modular face.
+
+
+.. _rigify.rigs.face.basic_tongue:
+
+``face.basic_tongue``
+=====================
+
+Generates a simple tongue, extracted from the original PitchiPoy ``super_face`` rig.
+
+B-Bone Segments (integer)
+   Defines the number of b-bone segments each tweak control will be split into.
+Primary Control Layers
+   Optionally specifies layers for the main control.
+
+
+.. _rigify.rigs.face.skin_eye:
+
+``face.skin_eye``
+=================
+
+Implements a skin system :ref:`parent controller <rigify.rigs.skin.skin_parents>` that manages
+two skin chains for the top and bottom eyelids in addition to generating the eye rotation mechanism.
+
+The rig must have two child skin chains with names tagged with `.T` and `.B` symmetry
+to mark the top and bottom eyelid, which are connected at their ends forming eye corners.
+The chains are rigged to follow the surface of the eye and twist to its normal.
+
+In addition, it creates target controls for aiming the eye, including a master control shared by all
+eyes under the same parent rig, and the eyelids are rigged to follow the movement of the eyeball with
+adjustable influence.
+
+Eyeball And Iris Deforms
+   Generates deform bones for the eyeball and the iris, the latter copying XZ scale from
+   the eye target control. The iris is located at the tail of the ORG bone.
+Eyelid Detach Option
+   Generates a slider to disable the mechanism that keeps eyelid controls stuck to the surface of the eye.
+Split Eyelid Follow Slider
+   Generates two separate sliders for controlling the influence of the eye rotation on X and Z eyelid motion.
+Eyelids Follow Default
+   Depending on *Split Eyelid Follow Slider*, specifies the default values for the split follow sliders,
+   or fixed factors to be multiplied with the single common follow influence slider value.
+
+
+.. _rigify.rigs.face.skin_jaw:
+
+``face.skin_jaw``
+=================
+
+Implements a skin system :ref:`parent controller <rigify.rigs.skin.skin_parents>` that manages
+one or more loops of mouth skin chains in response to the movement of jaw and mouth controls.
+
+The rig must have one or more child chain loops, each formed by 4 skin chains tagged
+with `.T`/`.B` `.L`/`.R` symmetrical names.
+
+The lip loops are sorted into layers based on the distance from corners to the common
+center and rigged with blended influence of the jaw and the master mouth control. Other
+child rigs simply become children of the jaw.
+
+Bottom Lip Influence
+   Specifies the influence of the jaw on the inner bottom lip with mouth lock disabled.
+Locked Influence
+   Specifies the influence of the jaw on both lips of locked mouth.
+Secondary Influence Falloff
+   Specifies the factor by which influence fades away with each successive lip loop
+   (for bottom lip loops the blend moves away from inner bottom lip to full jaw influence).


Property changes on: trunk/blender_docs/manual/addons/rigging/rigify/rig_types/face.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/blender_docs/manual/addons/rigging/rigify/rig_types/faces.rst
===================================================================
--- trunk/blender_docs/manual/addons/rigging/rigify/rig_types/faces.rst	2021-08-10 23:29:33 UTC (rev 8308)
+++ trunk/blender_docs/manual/addons/rigging/rigify/rig_types/faces.rst	2021-08-11 10:00:42 UTC (rev 8309)
@@ -10,3 +10,6 @@
 
 Requirement: All the face bones bundled in the ``faces.super_face`` sample had to be present and
 child of the master bone that has the Rigify-type *face* property set.
+
+.. note::
+   This rig type is being deprecated in favor of a new modular face rigging system.

Modified: trunk/blender_docs/manual/addons/rigging/rigify/rig_types/index.rst
===================================================================
--- trunk/blender_docs/manual/addons/rigging/rigify/rig_types/index.rst	2021-08-10 23:29:33 UTC (rev 8308)
+++ trunk/blender_docs/manual/addons/rigging/rigify/rig_types/index.rst	2021-08-11 10:00:42 UTC (rev 8309)
@@ -22,3 +22,5 @@
    spines.rst
    limbs.rst
    faces.rst
+   skin.rst
+   face.rst

Modified: trunk/blender_docs/manual/addons/rigging/rigify/rig_types/limbs.rst
===================================================================
--- trunk/blender_docs/manual/addons/rigging/rigify/rig_types/limbs.rst	2021-08-10 23:29:33 UTC (rev 8308)
+++ trunk/blender_docs/manual/addons/rigging/rigify/rig_types/limbs.rst	2021-08-11 10:00:42 UTC (rev 8309)
@@ -139,7 +139,7 @@
 i.e. there should be some degree of bend in all joints of the paw.
 
 Heel IK Influence
-   Influence of the extended IK. At fully rotating the main IK control or digit bone would
+   Influence of the extended IK. At full rotating the main IK control or digit bone would
    not affect the rotation of the paw bone, while lower values provide some blending.
 
 

Added: trunk/blender_docs/manual/addons/rigging/rigify/rig_types/skin.rst
===================================================================
--- trunk/blender_docs/manual/addons/rigging/rigify/rig_types/skin.rst	                        (rev 0)
+++ trunk/blender_docs/manual/addons/rigging/rigify/rig_types/skin.rst	2021-08-11 10:00:42 UTC (rev 8309)

@@ Diff output truncated at 10240 characters. @@

More information about the Bf-docboard-svn mailing list