e34d12bc8fa9500445cb626fec82ce93fa0cab52
[blender.git] / source / blender / editors / animation / anim_ipo_utils.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edanimation
22  */
23
24 /* This file contains code for presenting F-Curves and other animation data
25  * in the UI (especially for use in the Animation Editors).
26  *
27  * -- Joshua Leung, Dec 2008
28  */
29
30 #include "MEM_guardedalloc.h"
31
32 #include "BLI_blenlib.h"
33 #include "BLI_math.h"
34 #include "BLI_utildefines.h"
35
36 #include "BLT_translation.h"
37
38 #include "DNA_anim_types.h"
39
40 #include "RNA_access.h"
41
42 #include "ED_anim_api.h"
43
44 /* ----------------------- Getter functions ----------------------- */
45
46 /**
47  * Write into "name" buffer, the name of the property
48  * (retrieved using RNA from the curve's settings),
49  * and return the icon used for the struct that this property refers to
50  *
51  * \warning name buffer we're writing to cannot exceed 256 chars
52  * (check anim_channels_defines.c for details).
53  */
54 int getname_anim_fcurve(char *name, ID *id, FCurve *fcu)
55 {
56   int icon = 0;
57
58   /* sanity checks */
59   if (name == NULL)
60     return icon;
61   else if (ELEM(NULL, id, fcu, fcu->rna_path)) {
62     if (fcu == NULL)
63       strcpy(name, IFACE_("<invalid>"));
64     else if (fcu->rna_path == NULL)
65       strcpy(name, IFACE_("<no path>"));
66     else /* id == NULL */
67       BLI_snprintf(name, 256, "%s[%d]", fcu->rna_path, fcu->array_index);
68   }
69   else {
70     PointerRNA id_ptr, ptr;
71     PropertyRNA *prop;
72
73     /* get RNA pointer, and resolve the path */
74     RNA_id_pointer_create(id, &id_ptr);
75
76     /* try to resolve the path */
77     if (RNA_path_resolve_property(&id_ptr, fcu->rna_path, &ptr, &prop)) {
78       const char *structname = NULL, *propname = NULL;
79       char arrayindbuf[16];
80       const char *arrayname = NULL;
81       short free_structname = 0;
82
83       /* For now, name will consist of 3 parts: struct-name, property name, array index
84        * There are several options possible:
85        * 1) <struct-name>.<property-name>.<array-index>
86        *     i.e. Bone1.Location.X, or Object.Location.X
87        * 2) <array-index> <property-name> (<struct name>)
88        *     i.e. X Location (Bone1), or X Location (Object)
89        *
90        * Currently, option 2 is in use, to try and make it easier to quickly identify F-Curves
91        * (it does have problems with looking rather odd though).
92        * Option 1 is better in terms of revealing a consistent sense of hierarchy though,
93        * which isn't so clear with option 2.
94        */
95
96       /* For structname:
97        * - As base, we use a custom name from the structs if one is available
98        * - However, if we're showing subdata of bones
99        *   (probably there will be other exceptions later).
100        *   need to include that info too since it gets confusing otherwise.
101        * - If a pointer just refers to the ID-block, then don't repeat this info
102        *   since this just introduces clutter.
103        */
104       if (strstr(fcu->rna_path, "bones") && strstr(fcu->rna_path, "constraints")) {
105         /* perform string 'chopping' to get "Bone Name : Constraint Name" */
106         char *pchanName = BLI_str_quoted_substrN(fcu->rna_path, "bones[");
107         char *constName = BLI_str_quoted_substrN(fcu->rna_path, "constraints[");
108
109         /* assemble the string to display in the UI... */
110         structname = BLI_sprintfN("%s : %s", pchanName, constName);
111         free_structname = 1;
112
113         /* free the temp names */
114         if (pchanName)
115           MEM_freeN(pchanName);
116         if (constName)
117           MEM_freeN(constName);
118       }
119       else if (ptr.data != ptr.id.data) {
120         PropertyRNA *nameprop = RNA_struct_name_property(ptr.type);
121         if (nameprop) {
122           /* this gets a string which will need to be freed */
123           structname = RNA_property_string_get_alloc(&ptr, nameprop, NULL, 0, NULL);
124           free_structname = 1;
125         }
126         else
127           structname = RNA_struct_ui_name(ptr.type);
128       }
129
130       /* Property Name is straightforward */
131       propname = RNA_property_ui_name(prop);
132
133       /* Array Index - only if applicable */
134       if (RNA_property_array_check(prop)) {
135         char c = RNA_property_array_item_char(prop, fcu->array_index);
136
137         /* we need to write the index to a temp buffer (in py syntax) */
138         if (c)
139           BLI_snprintf(arrayindbuf, sizeof(arrayindbuf), "%c ", c);
140         else
141           BLI_snprintf(arrayindbuf, sizeof(arrayindbuf), "[%d]", fcu->array_index);
142
143         arrayname = &arrayindbuf[0];
144       }
145       else {
146         /* no array index */
147         arrayname = "";
148       }
149
150       /* putting this all together into the buffer */
151       /* XXX we need to check for invalid names...
152        * XXX the name length limit needs to be passed in or as some define */
153       if (structname)
154         BLI_snprintf(name, 256, "%s%s (%s)", arrayname, propname, structname);
155       else
156         BLI_snprintf(name, 256, "%s%s", arrayname, propname);
157
158       /* free temp name if nameprop is set */
159       if (free_structname)
160         MEM_freeN((void *)structname);
161
162       /* Icon for this property's owner:
163        * use the struct's icon if it is set
164        */
165       icon = RNA_struct_ui_icon(ptr.type);
166
167       /* valid path - remove the invalid tag since we now know how to use it saving
168        * users manual effort to reenable using "Revive Disabled FCurves" [#29629]
169        */
170       fcu->flag &= ~FCURVE_DISABLED;
171     }
172     else {
173       /* invalid path */
174       BLI_snprintf(name, 256, "\"%s[%d]\"", fcu->rna_path, fcu->array_index);
175
176       /* icon for this should be the icon for the base ID */
177       /* TODO: or should we just use the error icon? */
178       icon = RNA_struct_ui_icon(id_ptr.type);
179
180       /* tag F-Curve as disabled - as not usable path */
181       fcu->flag |= FCURVE_DISABLED;
182     }
183   }
184
185   /* return the icon that the active data had */
186   return icon;
187 }
188
189 /* ------------------------------- Color Codes for F-Curve Channels ---------------------------- */
190
191 /* step between the major distinguishable color bands of the primary colors */
192 #define HSV_BANDWIDTH 0.3f
193
194 /* used to determine the color of F-Curves with FCURVE_COLOR_AUTO_RAINBOW set */
195 // void fcurve_rainbow(unsigned int cur, unsigned int tot, float *out)
196 void getcolor_fcurve_rainbow(int cur, int tot, float out[3])
197 {
198   float hsv[3], fac;
199   int grouping;
200
201   /* we try to divide the color into groupings of n colors,
202    * where n is:
203    * 3 - for 'odd' numbers of curves - there should be a majority of triplets of curves
204    * 4 - for 'even' numbers of curves - there should be a majority of quartets of curves
205    * so the base color is simply one of the three primary colors
206    */
207   grouping = (4 - (tot % 2));
208   hsv[0] = HSV_BANDWIDTH * (float)(cur % grouping);
209
210   /* 'Value' (i.e. darkness) needs to vary so that larger sets of three will be
211    * 'darker' (i.e. smaller value), so that they don't look that similar to previous ones.
212    * However, only a range of 0.3 to 1.0 is really usable to avoid clashing
213    * with some other stuff
214    */
215   fac = ((float)cur / (float)tot) * 0.7f;
216
217   /* the base color can get offset a bit so that the colors aren't so identical */
218   hsv[0] += fac * HSV_BANDWIDTH;
219   if (hsv[0] > 1.0f)
220     hsv[0] = fmod(hsv[0], 1.0f);
221
222   /* saturation adjustments for more visible range */
223   hsv[1] = ((hsv[0] > 0.5f) && (hsv[0] < 0.8f)) ? 0.5f : 0.6f;
224
225   /* value is fixed at 1.0f, otherwise we cannot clearly see the curves... */
226   hsv[2] = 1.0f;
227
228   /* finally, conver this to RGB colors */
229   hsv_to_rgb_v(hsv, out);
230 }