File: shape_keys_panel.rst

package info (click to toggle)
blender-doc 4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 253,604 kB
  • sloc: python: 13,030; javascript: 322; makefile: 113; sh: 107
file content (232 lines) | stat: -rw-r--r-- 7,808 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

****************
Shape Keys Panel
****************

.. reference::

   :Editor:    Properties
   :Mode:      All modes
   :Panel:     :menuselection:`Object Data --> Shape Keys`

.. figure:: /images/animation_shape-keys_shape-keys-panel_basis.png
   :align: right
   :width: 296px

   Shape Keys panel.


The Shape Keys panel is used for authoring shape keys.

.. container:: lead

   .. clear

.. _bpy.types.Object.active_shape_key_index:

Active Shape Key Index
   A :ref:`List View <ui-list-view>`.

   .. _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.

      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.

   .. _bpy.types.ShapeKey.lock_shape:

   Lock Shape (lock icon)
      Shape keys can be locked to protect them from accidental modification due to inadvertently
      selecting the wrong key for editing in the list. Most common sculpt and edit mode operators
      and tools that move vertices abort with an error if the active shape key is locked.

      .. note::

         Operators that always modify all shape keys in exactly the same way, like
         :ref:`Apply Object Transforms <bpy.ops.object.transform_apply>`, don't check shape key locks.
         Neither currently do most edit mode operators that modify topology, because the topology is
         expected to usually be finalized before shape keys are created.

Shape Key Specials
   .. _bpy.ops.object.shape_key_add:

   New Shape from Mix
      Add a new shape key with the current deformed shape of the object.
      This differs from the ``+`` button of the list, as that one always copies
      the Basis shape independently of the current mix.

   .. _bpy.ops.object.shape_key_mirror:

   Mirror Shape Key
      If your mesh is symmetrical, in *Object Mode*, you can mirror the shape keys on the X axis.
      This will not work unless the mesh vertices are perfectly symmetrical.
      Use the :menuselection:`Mesh --> Symmetrize` tool in *Edit Mode*.

   Mirror Shape Key (Topology)
      Same as *Mirror Shape Key* though it detects the mirrored vertices based on the topology of the mesh.
      The mesh vertices do not have to be perfectly symmetrical for this action to work.

   .. _bpy.ops.object.join_shapes:

   Join as Shapes (Transfer Mix)
      Transfer the current resulting shape from a different object.

      Select the object to copy, then the object to copy into.
      Use this action and a new shape key will be added to the active object
      with the current mix of the first object.

   .. _bpy.ops.object.shape_key_transfer:

   Transfer Shape Key
      Transfer the active shape key from a different object
      regardless of its current influence.

      Select the object to copy, then the object to copy into.
      Use this action and a new shape key will be added to the active object
      with the active shape of the first object.

   .. _bpy.ops.object.shape_key_remove:

   Delete All Shape Keys
      Removes all Shape Keys and any effect that they had on the mesh.

   Apply All Shape Keys
      Saves the current visible shape to the mesh data and deletes all Shape Keys.

.. _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.

.. _bpy.types.Object.add_rest_position_attribute:

Add Rest Position
   Creates an :doc:`Attribute </modeling/geometry_nodes/attributes_reference>` in the vertex domain called
   ``rest_position`` which is a copy of the ``position`` attribute before shape keys and modifiers are evaluated.
   Only mesh objects support this option.


Relative Shape Keys
===================

.. figure:: /images/animation_shape-keys_shape-keys-panel_relative.png
   :align: right
   :width: 296px

   Relative Shape Keys options.

See :ref:`animation-shapekeys-relative-vs-absolute`.

With relative shape keys, the value shown for each shape in the list represents
the current weight or influence of that shape in the current *Mix*.

.. container:: lead

   .. clear

.. _bpy.ops.object.shape_key_clear:

:bl-icon:`x` (Clear Shape Keys)
   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.

.. _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.

.. note::

   Rather than storing offsets directly, internally relative keys are stored as snapshots of the mesh shape.
   The relative deformation offsets are computed by subtracting *Reference Key* from that snapshot.

   Therefore, replacing the *Reference Key* has the effect of subtracting the difference between the new
   and old reference from the relative deformation of the current key.

Absolute Shape Keys
===================

.. figure:: /images/animation_shape-keys_shape-keys-panel_absolute.png
   :align: right
   :width: 296px

   Absolute Shape Keys options.

See :ref:`animation-shapekeys-relative-vs-absolute`.

With absolute shape keys, the value shown for each shape in the list represents
the *Evaluation Time* at which that shape key will be active.

.. container:: lead

   .. clear

.. _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.

   Linear, Cardinal, Catmull-Rom, B-Spline

   .. _fig-interpolation-type:

   .. figure:: /images/animation_shape-keys_shape-keys-panel_interpolation-types.png

      Different types of interpolation.

      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.