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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
# ====================== BEGIN GPL LICENSE BLOCK ======================
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# ======================= END GPL LICENSE BLOCK ========================
# <pep8 compliant>
import bpy
import enum
from itertools import count, repeat
from mathutils import Vector, Matrix
from bl_math import clamp
from ...utils.rig import connected_children_names
from ...utils.layers import ControlLayersOption
from ...utils.naming import make_derived_name
from ...utils.bones import align_bone_orientation, align_bone_to_axis, align_bone_roll
from ...utils.misc import map_list, LazyRef
from ...utils.mechanism import driver_var_transform
from ...base_rig import stage
from .skin_nodes import ControlBoneNode, ControlNodeLayer, ControlNodeIcon
from .skin_parents import ControlBoneWeakParentLayer, ControlBoneParentOffset
from .basic_chain import Rig as BasicChainRig
class Control(enum.IntEnum):
START = 0
MIDDLE = 1
END = 2
class Rig(BasicChainRig):
"""
Skin chain that propagates motion of its end and middle controls, resulting in
stretching the whole chain rather than just immediately connected chain segments.
"""
min_chain_length = 2
def initialize(self):
if len(self.bones.org) < self.min_chain_length:
self.raise_error(
"Input to rig type must be a chain of {} or more bones.", self.min_chain_length)
super().initialize()
orgs = self.bones.org
# Check the middle pivot location
self.pivot_pos = self.params.skin_chain_pivot_pos
if not (0 <= self.pivot_pos < len(orgs)):
self.raise_error('Invalid middle control position: {}', self.pivot_pos)
# Compute cumulative chain lengths from the start
bone_lengths = [self.get_bone(org).length for org in orgs]
self.chain_lengths = [sum(bone_lengths[0:i]) for i in range(len(orgs)+1)]
# Compute the chain start to end direction vector
if not self.params.skin_chain_falloff_length:
self.pivot_base = self.get_bone(orgs[0]).head
self.pivot_vector = self.get_bone(orgs[-1]).tail - self.pivot_base
self.pivot_length = self.pivot_vector.length
self.pivot_vector.normalize()
# Compute the position of the middle pivot within the chain
if self.pivot_pos:
pivot_point = self.get_bone(orgs[self.pivot_pos]).head
self.middle_pivot_factor = self.get_pivot_projection(pivot_point, self.pivot_pos)
####################################################
# UTILITIES
def get_pivot_projection(self, pos, index):
"""Compute the interpolation factor within the chain for a control at pos and index."""
if self.params.skin_chain_falloff_length:
# Position along the length of the chain
return self.chain_lengths[index] / self.chain_lengths[-1]
else:
# Position projected on the line connecting chain ends
return clamp((pos - self.pivot_base).dot(self.pivot_vector) / self.pivot_length)
def use_falloff_curve(self, idx):
"""Check if the given Control has any influence on other nodes."""
return self.params.skin_chain_falloff[idx] > -10
def apply_falloff_curve(self, factor, idx):
"""Compute the falloff weight at position factor for the given Control."""
weight = self.params.skin_chain_falloff[idx]
if self.params.skin_chain_falloff_spherical[idx]:
# circular falloff
if weight >= 0:
p = 2 ** weight
return (1 - (1 - factor) ** p) ** (1/p)
else:
p = 2 ** -weight
return 1 - (1 - factor ** p) ** (1/p)
else:
# parabolic falloff
return 1 - (1 - factor) ** (2 ** weight)
####################################################
# CONTROL NODES
def make_control_node(self, i, org, is_end):
node = super().make_control_node(i, org, is_end)
# Chain end control nodes
if i == 0 or i == self.num_orgs:
node.layer = ControlNodeLayer.FREE
node.icon = ControlNodeIcon.FREE
if i == 0:
node.node_needs_reparent = self.use_falloff_curve(Control.START)
else:
node.node_needs_reparent = self.use_falloff_curve(Control.END)
# Middle pivot control node
elif i == self.pivot_pos:
node.layer = ControlNodeLayer.MIDDLE_PIVOT
node.icon = ControlNodeIcon.MIDDLE_PIVOT
node.node_needs_reparent = self.use_falloff_curve(Control.MIDDLE)
# Other (tweak) control nodes
else:
node.layer = ControlNodeLayer.TWEAK
node.icon = ControlNodeIcon.TWEAK
return node
def extend_control_node_parent(self, parent, node):
if node.rig != self or node.index in (0, self.num_orgs):
return parent
parent = ControlBoneParentOffset(self, node, parent)
# Add offsets from the end controls to other nodes
factor = self.get_pivot_projection(node.point, node.index)
if self.use_falloff_curve(Control.START):
parent.add_copy_local_location(
LazyRef(self.control_nodes[0], 'reparent_bone'),
influence=self.apply_falloff_curve(1 - factor, Control.START),
)
if self.use_falloff_curve(Control.END):
parent.add_copy_local_location(
LazyRef(self.control_nodes[-1], 'reparent_bone'),
influence=self.apply_falloff_curve(factor, Control.END),
)
# Add offset from the middle pivot
if self.pivot_pos and node.index != self.pivot_pos:
if self.use_falloff_curve(Control.MIDDLE):
if node.index < self.pivot_pos:
factor = factor / self.middle_pivot_factor
else:
factor = (1 - factor) / (1 - self.middle_pivot_factor)
parent.add_copy_local_location(
LazyRef(self.control_nodes[self.pivot_pos], 'reparent_bone'),
influence=self.apply_falloff_curve(clamp(factor), Control.MIDDLE),
)
# If Propagate To Controls is set, add an extra wrapper for twist/scale
if node.index != self.pivot_pos and self.params.skin_chain_falloff_to_controls:
if self.params.skin_chain_falloff_twist or self.params.skin_chain_falloff_scale:
parent = ControlBoneChainPropagate(self, node, parent)
return parent
def get_control_node_layers(self, node):
layers = None
# Secondary Layers used for the middle pivot
if self.pivot_pos and node.index == self.pivot_pos:
layers = ControlLayersOption.SKIN_SECONDARY.get(self.params)
# Primary Layers used for the end controls, and middle if secondary not set
if not layers and node.index in (0, self.num_orgs, self.pivot_pos):
layers = ControlLayersOption.SKIN_PRIMARY.get(self.params)
return layers or super().get_control_node_layers(node)
####################################################
# B-Bone handle MCH
def rig_mch_handle_user(self, i, mch, prev_node, node, next_node, pre):
super().rig_mch_handle_user(i, mch, prev_node, node, next_node, pre)
self.rig_propagate(mch, node)
def rig_propagate(self, mch, node):
# Interpolate chain twist and/or scale between pivots
if node.index not in (0, self.num_orgs, self.pivot_pos):
index1, index2, factor = self.get_propagate_spec(node)
if self.params.skin_chain_falloff_twist:
self.rig_propagate_twist(mch, index1, index2, factor)
if self.use_scale and self.params.skin_chain_falloff_scale:
self.rig_propagate_scale(mch, index1, index2, factor)
def get_propagate_spec(self, node):
"""Compute source handle indices and factor for propagating scale and twist to node."""
index1 = 0
index2 = self.num_orgs
len_cur = self.chain_lengths[node.index]
len_end = self.chain_lengths[-1]
if self.pivot_pos:
len_pivot = self.chain_lengths[self.pivot_pos]
if node.index < self.pivot_pos:
factor = len_cur / len_pivot
index2 = self.pivot_pos
else:
factor = (len_cur - len_pivot) / (len_end - len_pivot)
index1 = self.pivot_pos
else:
factor = len_cur / len_end
return index1, index2, factor
def rig_propagate_twist(self, mch, index1, index2, factor):
handles = self.get_all_mch_handles()
handles_pre = self.get_all_mch_handles_pre()
# Get Y Twist rotation of the input handles
variables = {
'y1': driver_var_transform(
self.obj, handles[index1], type='ROT_Y',
space='LOCAL', rotation_mode='SWING_TWIST_Y'
),
'y2': driver_var_transform(
self.obj, handles[index2], type='ROT_Y',
space='LOCAL', rotation_mode='SWING_TWIST_Y'
),
}
# If pre handles are used, exclude the pre-handle twist,
# since it is caused by mechanisms and not user animation.
if handles_pre[index1] != handles[index1]:
variables['p1'] = driver_var_transform(
self.obj, handles_pre[index1], type='ROT_Y',
space='LOCAL', rotation_mode='SWING_TWIST_Y'
)
expr1 = 'y1-p1'
else:
expr1 = 'y1'
if handles_pre[index2] != handles[index2]:
variables['p2'] = driver_var_transform(
self.obj, handles_pre[index2], type='ROT_Y',
space='LOCAL', rotation_mode='SWING_TWIST_Y'
)
expr2 = 'y2-p2'
else:
expr2 = 'y2'
# Create the driver for Y Euler Rotation
bone = self.get_bone(mch)
bone.rotation_mode = 'YXZ'
self.make_driver(
bone, 'rotation_euler', index=1,
expression=f'lerp({expr1},{expr2},{clamp(factor)})',
variables=variables
)
def rig_propagate_scale(self, mch, index1, index2, factor, use_y=False):
handles = self.get_all_mch_handles()
self.make_constraint(
mch, 'COPY_SCALE', handles[index1], space='LOCAL',
use_x=True, use_y=use_y, use_z=True,
use_offset=True, power=clamp(1-factor)
)
self.make_constraint(
mch, 'COPY_SCALE', handles[index2], space='LOCAL',
use_x=True, use_y=use_y, use_z=True,
use_offset=True, power=clamp(factor)
)
####################################################
# SETTINGS
@classmethod
def add_parameters(self, params):
params.skin_chain_pivot_pos = bpy.props.IntProperty(
name='Middle Control Position',
default=0,
min=0,
description='Position of the middle control, disabled if zero'
)
params.skin_chain_falloff_spherical = bpy.props.BoolVectorProperty(
size=3,
name='Spherical Falloff',
default=(False, False, False),
description='Falloff curve tries to form a circle at +1 instead of a parabola',
)
params.skin_chain_falloff = bpy.props.FloatVectorProperty(
size=3,
name='Control Falloff',
default=(0.0, 1.0, 0.0),
soft_min=-2, min=-10, soft_max=2,
description='Falloff curve coefficient: 0 is linear, and higher value is wider influence. Set to -10 to disable influence completely',
)
params.skin_chain_falloff_length = bpy.props.BoolProperty(
name='Falloff Along Chain Curve',
default=False,
description='Falloff is computed along the curve of the chain, instead of projecting on the axis connecting the start and end points',
)
params.skin_chain_falloff_twist = bpy.props.BoolProperty(
name='Propagate Twist',
default=True,
description='Propagate twist from main controls throughout the chain',
)
params.skin_chain_falloff_scale = bpy.props.BoolProperty(
name='Propagate Scale',
default=False,
description='Propagate scale from main controls throughout the chain',
)
params.skin_chain_falloff_to_controls = bpy.props.BoolProperty(
name='Propagate To Controls',
default=False,
description='Expose scale and/or twist propagated to tweak controls to be seen as ' +
'parent motion by glue or other chains using Merge Parent Rotation And ' +
'Scale. Otherwise it is only propagated internally within this chain',
)
ControlLayersOption.SKIN_PRIMARY.add_parameters(params)
ControlLayersOption.SKIN_SECONDARY.add_parameters(params)
super().add_parameters(params)
@classmethod
def parameters_ui(self, layout, params):
layout.prop(params, "skin_chain_pivot_pos")
col = layout.column(align=True)
row = col.row(align=True)
row.label(text="Falloff:")
for i in range(3):
row2 = row.row(align=True)
row2.active = i != 1 or params.skin_chain_pivot_pos > 0
row2.prop(params, "skin_chain_falloff", text="", index=i)
row2.prop(params, "skin_chain_falloff_spherical", text="", icon='SPHERECURVE', index=i)
col.prop(params, "skin_chain_falloff_length")
row = col.split(factor=0.25)
row.label(text="Propagate:")
row = row.row(align=True)
row.prop(params, "skin_chain_falloff_twist", text="Twist", toggle=True)
row.prop(params, "skin_chain_falloff_scale", text="Scale", toggle=True)
row.prop(params, "skin_chain_falloff_to_controls", text="To Controls", toggle=True)
ControlLayersOption.SKIN_PRIMARY.parameters_ui(layout, params)
if params.skin_chain_pivot_pos > 0:
ControlLayersOption.SKIN_SECONDARY.parameters_ui(layout, params)
super().parameters_ui(layout, params)
class ControlBoneChainPropagate(ControlBoneWeakParentLayer):
"""
Parent mechanism generator that propagates chain twist/scale
to the reparent system, if Propagate To Controls is used.
"""
def __eq__(self, other):
return (
isinstance(other, ControlBoneChainPropagate) and
self.parent == other.parent and
self.rig == other.rig and
self.node.index == other.node.index
)
def generate_bones(self):
# The parent bone is based on the handle and aligned appropriately.
handle = self.rig.bones.mch.handles[self.node.index]
self.output_bone = self.copy_bone(handle, make_derived_name(handle, 'mch', '_parent'))
def parent_bones(self):
self.set_bone_parent(self.output_bone, self.parent.output_bone, inherit_scale='AVERAGE')
def rig_bones(self):
# Add the twist/scale propagation rigging to the bone like the handle.
self.rig.rig_propagate(self.output_bone, self.node)
def create_sample(obj):
from rigify.rigs.basic.copy_chain import create_sample as inner
obj.pose.bones[inner(obj)["bone.01"]].rigify_type = 'skin.stretchy_chain'
|