[Bf-docboard-svn] bf-manual: [9482] branches/blender-3.3-release/blender_docs/manual: Shapekeys: Add RNA references
Aaron Carlisle
noreply at blender.org
Tue Aug 16 03:54:50 CEST 2022
Revision: 9482
https://developer.blender.org/rBM9482
Author: Blendify
Date: 2022-08-16 03:54:49 +0200 (Tue, 16 Aug 2022)
Log Message:
-----------
Shapekeys: Add RNA references
Modified Paths:
--------------
branches/blender-3.3-release/blender_docs/manual/animation/shape_keys/shape_keys_panel.rst
branches/blender-3.3-release/blender_docs/manual/editors/dope_sheet/shape_key.rst
Modified: branches/blender-3.3-release/blender_docs/manual/animation/shape_keys/shape_keys_panel.rst
===================================================================
--- branches/blender-3.3-release/blender_docs/manual/animation/shape_keys/shape_keys_panel.rst 2022-08-14 19:44:12 UTC (rev 9481)
+++ branches/blender-3.3-release/blender_docs/manual/animation/shape_keys/shape_keys_panel.rst 2022-08-16 01:54:49 UTC (rev 9482)
@@ -20,10 +20,14 @@
Settings
========
+.. _bpy.types.Object.active_shape_key_index:
+
Active Shape Key Index
A :ref:`List View <ui-list-view>`.
- Value (number)
+ .. _bpy.types.ShapeKey.frame:
+
+ Value/Frame (number)
In Relative mode: Value is the current influence of the shape key used for blending between
the shape (value=1.0) and its reference key (value=0.0). The reference key is usually the Basis shape.
The weight of the blend can be extrapolated above 1.0 and below 0.0.
@@ -30,6 +34,8 @@
In Absolute mode: Value is the *Evaluation Time* at which the shape will have maximum influence.
+ .. _bpy.types.ShapeKey.mute:
+
Mute (check mark)
If unchecked, the shape key will not be taken into consideration when
mixing the shape key stack into the result visible in the 3D Viewport.
@@ -61,13 +67,20 @@
Use this action and a new shape key will be added to the active object
with the active shape of the first object.
+.. _bpy.types.Key.use_relative:
+
Relative
Set the shape keys to *Relative* or *Absolute*.
See :ref:`animation-shapekeys-relative-vs-absolute`.
+.. _bpy.types.Object.show_only_shape_key:
+
Shape Key Lock (pin icon)
Show the active shape in the 3D Viewport without blending.
*Shape Key Lock* gets automatically enabled while the object is in *Edit Mode*.
+
+.. _bpy.types.Object.use_shape_key_edit_mode:
+
Shape Key Edit Mode (edit mode icon)
If enabled, when entering *Edit Mode* the active shape key will **not** take maximum influence as is default.
Instead, the current blend of shape keys will be visible and can be edited from that state.
@@ -85,23 +98,35 @@
Relative Shape Keys options.
+.. _bpy.ops.object.shape_key_clear:
+
Clear Shape Keys ``X``
Set all influence values, or weights, to zero.
Useful to quickly guarantee that the result shown in the 3D Viewport is not affected by shapes.
-.. _animation-shapekey-relative-value:
+.. _bpy.types.ShapeKey.value:
Value
The weight of the blend between the shape key and its reference key (usually the Basis shape).
A value of 0.0 denotes 100% influence of the reference key and 1.0 of the shape key.
+
+.. _bpy.types.ShapeKey.slider_min:
+.. _bpy.types.ShapeKey.slider_max:
+
Range
Minimum and maximum range for the influence value of the active shape key.
Blender can extrapolate results when the *Value* goes lower than 0.0 or above 1.0.
+
+.. _bpy.types.ShapeKey.vertex_group:
+
Vertex Group
Limit the active shape key deformation to a vertex group.
Useful to break down a complex shape into components by assigning temporary vertex groups
to the complex shape and copying the result into new simpler shapes.
+
+.. _bpy.types.ShapeKey.relative_key:
+
Relative To
Select the shape key to deform from. This is called the *Reference Key* for that shape.
@@ -118,9 +143,14 @@
Absolute Shape Keys options.
+.. _bpy.ops.object.shape_key_retime:
+
Re-Time Shape Keys (clock icon)
Absolute shape keys are timed, by order in the list, at a constant interval.
This button resets the timing for the keys. Useful if keys were removed or re-ordered.
+
+.. _bpy.types.ShapeKey.interpolation:
+
Interpolation
Controls the interpolation between shape keys.
@@ -134,6 +164,8 @@
The red line represents interpolated values between keys (black dots).
+.. _bpy.types.Key.eval_time:
+
Evaluation Time
Controls the shape key influence. Scrub to see the effect of the current configuration.
Typically, this property is keyed for animation or rigged with a driver.
Modified: branches/blender-3.3-release/blender_docs/manual/editors/dope_sheet/shape_key.rst
===================================================================
--- branches/blender-3.3-release/blender_docs/manual/editors/dope_sheet/shape_key.rst 2022-08-14 19:44:12 UTC (rev 9481)
+++ branches/blender-3.3-release/blender_docs/manual/editors/dope_sheet/shape_key.rst 2022-08-16 01:54:49 UTC (rev 9482)
@@ -10,7 +10,7 @@
================
The *Shape Key Editor* is used to adjust the animation timing of :doc:`shape keys </animation/shape_keys/index>`.
-These are stored inside an Action data-block. It lets you edit the :ref:`value <animation-shapekey-relative-value>`
+These are stored inside an Action data-block. It lets you edit the :ref:`Value <bpy.types.ShapeKey.value>`
of shape keys over time.
This mode of the *Dope Sheet* uses a similar interface as the :doc:`/editors/dope_sheet/action` Mode
More information about the Bf-docboard-svn
mailing list