change python scripts so modules which register with blender have a register() functi...
[blender.git] / release / scripts / ui / properties_object_constraint.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20 import bpy
21
22 narrowui = 180
23
24
25 class ConstraintButtonsPanel(bpy.types.Panel):
26     bl_space_type = 'PROPERTIES'
27     bl_region_type = 'WINDOW'
28     bl_context = "constraint"
29
30     def draw_constraint(self, context, con):
31         layout = self.layout
32
33         box = layout.template_constraint(con)
34         wide_ui = context.region.width > narrowui
35
36         if box:
37             # match enum type to our functions, avoids a lookup table.
38             getattr(self, con.type)(context, box, con, wide_ui)
39
40             if con.type not in ('RIGID_BODY_JOINT', 'SPLINE_IK', 'NULL'):
41                 box.prop(con, "influence")
42
43     def space_template(self, layout, con, wide_ui, target=True, owner=True):
44         if target or owner:
45
46             split = layout.split(percentage=0.2)
47
48             if wide_ui:
49                 split.label(text="Space:")
50                 row = split.row()
51             else:
52                 row = layout.row()
53
54
55             if target:
56                 row.prop(con, "target_space", text="")
57
58             if wide_ui:
59                 if target and owner:
60                     row.label(icon='ARROW_LEFTRIGHT')
61             else:
62                 row = layout.row()
63             if owner:
64                 row.prop(con, "owner_space", text="")
65
66     def target_template(self, layout, con, wide_ui, subtargets=True):
67         if wide_ui:
68             layout.prop(con, "target") # XXX limiting settings for only 'curves' or some type of object
69         else:
70             layout.prop(con, "target", text="")
71
72         if con.target and subtargets:
73             if con.target.type == 'ARMATURE':
74                 if wide_ui:
75                     layout.prop_object(con, "subtarget", con.target.data, "bones", text="Bone")
76                 else:
77                     layout.prop_object(con, "subtarget", con.target.data, "bones", text="")
78
79                 if con.type in ('COPY_LOCATION', 'STRETCH_TO', 'TRACK_TO'):
80                     row = layout.row()
81                     row.label(text="Head/Tail:")
82                     row.prop(con, "head_tail", text="")
83             elif con.target.type in ('MESH', 'LATTICE'):
84                 layout.prop_object(con, "subtarget", con.target, "vertex_groups", text="Vertex Group")
85
86     def ik_template(self, layout, con, wide_ui):
87         # only used for iTaSC
88         layout.prop(con, "pole_target")
89
90         if con.pole_target and con.pole_target.type == 'ARMATURE':
91             layout.prop_object(con, "pole_subtarget", con.pole_target.data, "bones", text="Bone")
92
93         if con.pole_target:
94             row = layout.row()
95             row.label()
96             row.prop(con, "pole_angle")
97
98         split = layout.split(percentage=0.33)
99         col = split.column()
100         col.prop(con, "tail")
101         col.prop(con, "stretch")
102
103         col = split.column()
104         col.prop(con, "chain_length")
105         col.prop(con, "targetless")
106
107     def CHILD_OF(self, context, layout, con, wide_ui):
108         self.target_template(layout, con, wide_ui)
109
110         split = layout.split()
111
112         col = split.column()
113         col.label(text="Location:")
114         col.prop(con, "use_location_x", text="X")
115         col.prop(con, "use_location_y", text="Y")
116         col.prop(con, "use_location_z", text="Z")
117
118         col = split.column()
119         col.label(text="Rotation:")
120         col.prop(con, "use_rotation_x", text="X")
121         col.prop(con, "use_rotation_y", text="Y")
122         col.prop(con, "use_rotation_z", text="Z")
123
124         col = split.column()
125         col.label(text="Scale:")
126         col.prop(con, "use_scale_x", text="X")
127         col.prop(con, "use_scale_y", text="Y")
128         col.prop(con, "use_scale_z", text="Z")
129
130         split = layout.split()
131
132         col = split.column()
133         col.operator("constraint.childof_set_inverse")
134
135         if wide_ui:
136             col = split.column()
137         col.operator("constraint.childof_clear_inverse")
138
139     def TRACK_TO(self, context, layout, con, wide_ui):
140         self.target_template(layout, con, wide_ui)
141
142         row = layout.row()
143         if wide_ui:
144             row.label(text="To:")
145         row.prop(con, "track", expand=True)
146
147         split = layout.split()
148
149         col = split.column()
150         col.prop(con, "up", text="Up")
151
152         if wide_ui:
153             col = split.column()
154         col.prop(con, "target_z")
155
156         self.space_template(layout, con, wide_ui)
157
158     def IK(self, context, layout, con, wide_ui):
159         if context.object.pose.ik_solver == "ITASC":
160             layout.prop(con, "ik_type")
161             getattr(self, 'IK_' + con.ik_type)(context, layout, con, wide_ui)
162         else:
163             # Legacy IK constraint
164             self.target_template(layout, con, wide_ui)
165             if wide_ui:
166                 layout.prop(con, "pole_target")
167             else:
168                 layout.prop(con, "pole_target", text="")
169             if con.pole_target and con.pole_target.type == 'ARMATURE':
170                 if wide_ui:
171                     layout.prop_object(con, "pole_subtarget", con.pole_target.data, "bones", text="Bone")
172                 else:
173                     layout.prop_object(con, "pole_subtarget", con.pole_target.data, "bones", text="")
174
175             if con.pole_target:
176                 row = layout.row()
177                 row.prop(con, "pole_angle")
178                 if wide_ui:
179                     row.label()
180
181             split = layout.split()
182             col = split.column()
183             col.prop(con, "iterations")
184             col.prop(con, "chain_length")
185
186             col.label(text="Weight:")
187             col.prop(con, "weight", text="Position", slider=True)
188             sub = col.column()
189             sub.active = con.use_rotation
190             sub.prop(con, "orient_weight", text="Rotation", slider=True)
191
192             if wide_ui:
193                 col = split.column()
194             col.prop(con, "use_tail")
195             col.prop(con, "use_stretch")
196             col.separator()
197             col.prop(con, "use_target")
198             col.prop(con, "use_rotation")
199
200     def IK_COPY_POSE(self, context, layout, con, wide_ui):
201         self.target_template(layout, con, wide_ui)
202         self.ik_template(layout, con, wide_ui)
203
204         row = layout.row()
205         row.label(text="Axis Ref:")
206         row.prop(con, "axis_reference", expand=True)
207         split = layout.split(percentage=0.33)
208         split.row().prop(con, "position")
209         row = split.row()
210         row.prop(con, "weight", text="Weight", slider=True)
211         row.active = con.position
212         split = layout.split(percentage=0.33)
213         row = split.row()
214         row.label(text="Lock:")
215         row = split.row()
216         row.prop(con, "pos_lock_x", text="X")
217         row.prop(con, "pos_lock_y", text="Y")
218         row.prop(con, "pos_lock_z", text="Z")
219         split.active = con.use_position
220
221         split = layout.split(percentage=0.33)
222         split.row().prop(con, "rotation")
223         row = split.row()
224         row.prop(con, "orient_weight", text="Weight", slider=True)
225         row.active = con.use_rotation
226         split = layout.split(percentage=0.33)
227         row = split.row()
228         row.label(text="Lock:")
229         row = split.row()
230         row.prop(con, "rot_lock_x", text="X")
231         row.prop(con, "rot_lock_y", text="Y")
232         row.prop(con, "rot_lock_z", text="Z")
233         split.active = con.use_rotation
234
235     def IK_DISTANCE(self, context, layout, con, wide_ui):
236         self.target_template(layout, con, wide_ui)
237         self.ik_template(layout, con, wide_ui)
238
239         layout.prop(con, "limit_mode")
240         row = layout.row()
241         row.prop(con, "weight", text="Weight", slider=True)
242         row.prop(con, "distance", text="Distance", slider=True)
243
244     def FOLLOW_PATH(self, context, layout, con, wide_ui):
245         self.target_template(layout, con, wide_ui)
246
247         split = layout.split()
248
249         col = split.column()
250         col.prop(con, "use_curve_follow")
251         col.prop(con, "use_curve_radius")
252
253         if wide_ui:
254             col = split.column()
255         col.prop(con, "use_fixed_position")
256         if con.use_fixed_position:
257             col.prop(con, "offset_factor", text="Offset")
258         else:
259             col.prop(con, "offset")
260
261         row = layout.row()
262         if wide_ui:
263             row.label(text="Forward:")
264         row.prop(con, "forward", expand=True)
265
266         row = layout.row()
267         row.prop(con, "up", text="Up")
268         if wide_ui:
269             row.label()
270
271     def LIMIT_ROTATION(self, context, layout, con, wide_ui):
272
273         split = layout.split()
274
275         col = split.column(align=True)
276         col.prop(con, "use_limit_x")
277         sub = col.column()
278         sub.active = con.use_limit_x
279         sub.prop(con, "minimum_x", text="Min")
280         sub.prop(con, "maximum_x", text="Max")
281
282         if wide_ui:
283             col = split.column(align=True)
284         col.prop(con, "use_limit_y")
285         sub = col.column()
286         sub.active = con.use_limit_y
287         sub.prop(con, "minimum_y", text="Min")
288         sub.prop(con, "maximum_y", text="Max")
289
290         if wide_ui:
291             col = split.column(align=True)
292         col.prop(con, "use_limit_z")
293         sub = col.column()
294         sub.active = con.use_limit_z
295         sub.prop(con, "minimum_z", text="Min")
296         sub.prop(con, "maximum_z", text="Max")
297
298         row = layout.row()
299         row.prop(con, "limit_transform")
300         if wide_ui:
301             row.label()
302
303         row = layout.row()
304         if wide_ui:
305             row.label(text="Convert:")
306         row.prop(con, "owner_space", text="")
307
308     def LIMIT_LOCATION(self, context, layout, con, wide_ui):
309         split = layout.split()
310
311         col = split.column()
312         col.prop(con, "use_minimum_x")
313         sub = col.column()
314         sub.active = con.use_minimum_x
315         sub.prop(con, "minimum_x", text="")
316         col.prop(con, "use_maximum_x")
317         sub = col.column()
318         sub.active = con.use_maximum_x
319         sub.prop(con, "maximum_x", text="")
320
321         if wide_ui:
322             col = split.column()
323         col.prop(con, "use_minimum_y")
324         sub = col.column()
325         sub.active = con.use_minimum_y
326         sub.prop(con, "minimum_y", text="")
327         col.prop(con, "use_maximum_y")
328         sub = col.column()
329         sub.active = con.use_maximum_y
330         sub.prop(con, "maximum_y", text="")
331
332         if wide_ui:
333             col = split.column()
334         col.prop(con, "use_minimum_z")
335         sub = col.column()
336         sub.active = con.use_minimum_z
337         sub.prop(con, "minimum_z", text="")
338         col.prop(con, "use_maximum_z")
339         sub = col.column()
340         sub.active = con.use_maximum_z
341         sub.prop(con, "maximum_z", text="")
342
343         row = layout.row()
344         row.prop(con, "limit_transform")
345         if wide_ui:
346             row.label()
347
348         row = layout.row()
349         if wide_ui:
350             row.label(text="Convert:")
351         row.prop(con, "owner_space", text="")
352
353     def LIMIT_SCALE(self, context, layout, con, wide_ui):
354         split = layout.split()
355
356         col = split.column()
357         col.prop(con, "use_minimum_x")
358         sub = col.column()
359         sub.active = con.use_minimum_x
360         sub.prop(con, "minimum_x", text="")
361         col.prop(con, "use_maximum_x")
362         sub = col.column()
363         sub.active = con.use_maximum_x
364         sub.prop(con, "maximum_x", text="")
365
366         if wide_ui:
367             col = split.column()
368         col.prop(con, "use_minimum_y")
369         sub = col.column()
370         sub.active = con.use_minimum_y
371         sub.prop(con, "minimum_y", text="")
372         col.prop(con, "use_maximum_y")
373         sub = col.column()
374         sub.active = con.use_maximum_y
375         sub.prop(con, "maximum_y", text="")
376
377         if wide_ui:
378             col = split.column()
379         col.prop(con, "use_minimum_z")
380         sub = col.column()
381         sub.active = con.use_minimum_z
382         sub.prop(con, "minimum_z", text="")
383         col.prop(con, "use_maximum_z")
384         sub = col.column()
385         sub.active = con.use_maximum_z
386         sub.prop(con, "maximum_z", text="")
387
388         row = layout.row()
389         row.prop(con, "limit_transform")
390         if wide_ui:
391             row.label()
392
393         row = layout.row()
394         if wide_ui:
395             row.label(text="Convert:")
396         row.prop(con, "owner_space", text="")
397
398     def COPY_ROTATION(self, context, layout, con, wide_ui):
399         self.target_template(layout, con, wide_ui)
400
401         split = layout.split()
402
403         col = split.column()
404         col.prop(con, "use_x", text="X")
405         sub = col.column()
406         sub.active = con.use_x
407         sub.prop(con, "invert_x", text="Invert")
408
409         col = split.column()
410         col.prop(con, "use_y", text="Y")
411         sub = col.column()
412         sub.active = con.use_y
413         sub.prop(con, "invert_y", text="Invert")
414
415         col = split.column()
416         col.prop(con, "use_z", text="Z")
417         sub = col.column()
418         sub.active = con.use_z
419         sub.prop(con, "invert_z", text="Invert")
420
421         layout.prop(con, "use_offset")
422
423         self.space_template(layout, con, wide_ui)
424
425     def COPY_LOCATION(self, context, layout, con, wide_ui):
426         self.target_template(layout, con, wide_ui)
427
428         split = layout.split()
429
430         col = split.column()
431         col.prop(con, "use_x", text="X")
432         sub = col.column()
433         sub.active = con.use_x
434         sub.prop(con, "invert_x", text="Invert")
435
436         col = split.column()
437         col.prop(con, "use_y", text="Y")
438         sub = col.column()
439         sub.active = con.use_y
440         sub.prop(con, "invert_y", text="Invert")
441
442         col = split.column()
443         col.prop(con, "use_z", text="Z")
444         sub = col.column()
445         sub.active = con.use_z
446         sub.prop(con, "invert_z", text="Invert")
447
448         layout.prop(con, "use_offset")
449
450         self.space_template(layout, con, wide_ui)
451
452     def COPY_SCALE(self, context, layout, con, wide_ui):
453         self.target_template(layout, con, wide_ui)
454
455         row = layout.row(align=True)
456         row.prop(con, "use_x", text="X")
457         row.prop(con, "use_y", text="Y")
458         row.prop(con, "use_z", text="Z")
459
460         layout.prop(con, "use_offset")
461
462         self.space_template(layout, con, wide_ui)
463
464     def COPY_TRANSFORMS(self, context, layout, con, wide_ui):
465         self.target_template(layout, con, wide_ui)
466
467         self.space_template(layout, con, wide_ui)
468
469
470     #def SCRIPT(self, context, layout, con):
471
472     def ACTION(self, context, layout, con, wide_ui):
473         self.target_template(layout, con, wide_ui)
474
475         if wide_ui:
476             layout.prop(con, "action")
477         else:
478             layout.prop(con, "action", text="")
479
480         if wide_ui:
481             layout.prop(con, "transform_channel")
482         else:
483             layout.prop(con, "transform_channel", text="")
484
485         split = layout.split()
486
487         col = split.column(align=True)
488         col.label(text="Action Length:")
489         col.prop(con, "start_frame", text="Start")
490         col.prop(con, "end_frame", text="End")
491
492         if wide_ui:
493             col = split.column(align=True)
494         col.label(text="Target Range:")
495         col.prop(con, "minimum", text="Min")
496         col.prop(con, "maximum", text="Max")
497
498         row = layout.row()
499         if wide_ui:
500             row.label(text="Convert:")
501         row.prop(con, "target_space", text="")
502
503     def LOCKED_TRACK(self, context, layout, con, wide_ui):
504         self.target_template(layout, con, wide_ui)
505
506         row = layout.row()
507         if wide_ui:
508             row.label(text="To:")
509         row.prop(con, "track", expand=True)
510
511         row = layout.row()
512         if wide_ui:
513             row.label(text="Lock:")
514         row.prop(con, "locked", expand=True)
515
516     def LIMIT_DISTANCE(self, context, layout, con, wide_ui):
517         self.target_template(layout, con, wide_ui)
518
519         col = layout.column(align=True)
520         col.prop(con, "distance")
521         col.operator("constraint.limitdistance_reset")
522
523         row = layout.row()
524         row.label(text="Clamp Region:")
525         row.prop(con, "limit_mode", text="")
526
527     def STRETCH_TO(self, context, layout, con, wide_ui):
528         self.target_template(layout, con, wide_ui)
529
530         split = layout.split()
531
532         col = split.column()
533         col.prop(con, "original_length", text="Rest Length")
534
535         if wide_ui:
536             col = split.column()
537         col.operator("constraint.stretchto_reset", text="Reset")
538
539         col = layout.column()
540         col.prop(con, "bulge", text="Volume Variation")
541
542         row = layout.row()
543         if wide_ui:
544             row.label(text="Volume:")
545         row.prop(con, "volume", expand=True)
546         if not wide_ui:
547             row = layout.row()
548         row.label(text="Plane:")
549         row.prop(con, "keep_axis", expand=True)
550
551     def FLOOR(self, context, layout, con, wide_ui):
552         self.target_template(layout, con, wide_ui)
553
554         split = layout.split()
555
556         col = split.column()
557         col.prop(con, "sticky")
558
559         if wide_ui:
560             col = split.column()
561         col.prop(con, "use_rotation")
562
563         layout.prop(con, "offset")
564
565         row = layout.row()
566         if wide_ui:
567             row.label(text="Min/Max:")
568         row.prop(con, "floor_location", expand=True)
569
570         self.space_template(layout, con, wide_ui)
571
572     def RIGID_BODY_JOINT(self, context, layout, con, wide_ui):
573         self.target_template(layout, con, wide_ui)
574
575         if wide_ui:
576             layout.prop(con, "pivot_type")
577         else:
578             layout.prop(con, "pivot_type", text="")
579         if wide_ui:
580             layout.prop(con, "child")
581         else:
582             layout.prop(con, "child", text="")
583
584         split = layout.split()
585
586         col = split.column()
587         col.prop(con, "disable_linked_collision", text="No Collision")
588
589         if wide_ui:
590             col = split.column()
591         col.prop(con, "draw_pivot", text="Display Pivot")
592
593         split = layout.split()
594
595         col = split.column(align=True)
596         col.label(text="Pivot:")
597         col.prop(con, "pivot_x", text="X")
598         col.prop(con, "pivot_y", text="Y")
599         col.prop(con, "pivot_z", text="Z")
600
601         if wide_ui:
602             col = split.column(align=True)
603         col.label(text="Axis:")
604         col.prop(con, "axis_x", text="X")
605         col.prop(con, "axis_y", text="Y")
606         col.prop(con, "axis_z", text="Z")
607
608         #Missing: Limit arrays (not wrapped in RNA yet)
609
610     def CLAMP_TO(self, context, layout, con, wide_ui):
611         self.target_template(layout, con, wide_ui)
612
613         row = layout.row()
614         if wide_ui:
615             row.label(text="Main Axis:")
616         row.prop(con, "main_axis", expand=True)
617
618         row = layout.row()
619         row.prop(con, "cyclic")
620
621     def TRANSFORM(self, context, layout, con, wide_ui):
622         self.target_template(layout, con, wide_ui)
623
624         layout.prop(con, "extrapolate_motion", text="Extrapolate")
625
626         col = layout.column()
627         col.row().label(text="Source:")
628         col.row().prop(con, "map_from", expand=True)
629
630         split = layout.split()
631
632         sub = split.column(align=True)
633         sub.label(text="X:")
634         sub.prop(con, "from_min_x", text="Min")
635         sub.prop(con, "from_max_x", text="Max")
636
637         if wide_ui:
638             sub = split.column(align=True)
639         sub.label(text="Y:")
640         sub.prop(con, "from_min_y", text="Min")
641         sub.prop(con, "from_max_y", text="Max")
642
643         if wide_ui:
644             sub = split.column(align=True)
645         sub.label(text="Z:")
646         sub.prop(con, "from_min_z", text="Min")
647         sub.prop(con, "from_max_z", text="Max")
648
649         split = layout.split()
650
651         col = split.column()
652         col.label(text="Destination:")
653         col.row().prop(con, "map_to", expand=True)
654
655         split = layout.split()
656
657         col = split.column()
658         col.label(text="X:")
659         col.row().prop(con, "map_to_x_from", expand=True)
660
661         sub = col.column(align=True)
662         sub.prop(con, "to_min_x", text="Min")
663         sub.prop(con, "to_max_x", text="Max")
664
665         if wide_ui:
666             col = split.column()
667         col.label(text="Y:")
668         col.row().prop(con, "map_to_y_from", expand=True)
669
670         sub = col.column(align=True)
671         sub.prop(con, "to_min_y", text="Min")
672         sub.prop(con, "to_max_y", text="Max")
673
674         if wide_ui:
675             col = split.column()
676         col.label(text="Z:")
677         col.row().prop(con, "map_to_z_from", expand=True)
678
679         sub = col.column(align=True)
680         sub.prop(con, "to_min_z", text="Min")
681         sub.prop(con, "to_max_z", text="Max")
682
683         self.space_template(layout, con, wide_ui)
684
685     def SHRINKWRAP(self, context, layout, con, wide_ui):
686         self.target_template(layout, con, wide_ui)
687
688         layout.prop(con, "distance")
689         layout.prop(con, "shrinkwrap_type")
690
691         if con.shrinkwrap_type == 'PROJECT':
692             row = layout.row(align=True)
693             row.prop(con, "use_x")
694             row.prop(con, "use_y")
695             row.prop(con, "use_z")
696
697     def DAMPED_TRACK(self, context, layout, con, wide_ui):
698         self.target_template(layout, con, wide_ui)
699
700         row = layout.row()
701         if wide_ui:
702             row.label(text="To:")
703         row.prop(con, "track", expand=True)
704
705     def SPLINE_IK(self, context, layout, con, wide_ui):
706         self.target_template(layout, con, wide_ui)
707
708         col = layout.column()
709         col.label(text="Spline Fitting:")
710         col.prop(con, "chain_length")
711         col.prop(con, "even_divisions")
712         col.prop(con, "chain_offset")
713
714         col = layout.column()
715         col.label(text="Chain Scaling:")
716         col.prop(con, "y_stretch")
717         if wide_ui:
718             col.prop(con, "xz_scaling_mode")
719         else:
720             col.prop(con, "xz_scaling_mode", text="")
721         col.prop(con, "use_curve_radius")
722
723
724 class OBJECT_PT_constraints(ConstraintButtonsPanel):
725     bl_label = "Object Constraints"
726     bl_context = "constraint"
727
728     def poll(self, context):
729         return (context.object)
730
731     def draw(self, context):
732         layout = self.layout
733
734         ob = context.object
735
736         layout.operator_menu_enum("object.constraint_add", "type")
737
738         for con in ob.constraints:
739             self.draw_constraint(context, con)
740
741
742 class BONE_PT_constraints(ConstraintButtonsPanel):
743     bl_label = "Bone Constraints"
744     bl_context = "bone_constraint"
745
746     def poll(self, context):
747         return (context.pose_bone)
748
749     def draw(self, context):
750         layout = self.layout
751
752         layout.operator_menu_enum("pose.constraint_add", "type")
753
754         for con in context.pose_bone.constraints:
755             self.draw_constraint(context, con)
756
757
758 classes = [
759     OBJECT_PT_constraints,
760     BONE_PT_constraints]
761
762
763 def register():
764     register = bpy.types.register
765     for cls in classes:
766         register(cls)
767
768 def unregister():
769     unregister = bpy.types.unregister
770     for cls in classes:
771         unregister(cls)