Cleanup: style, use braces for editors
[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   }
62   else if (ELEM(NULL, id, fcu, fcu->rna_path)) {
63     if (fcu == NULL) {
64       strcpy(name, IFACE_("<invalid>"));
65     }
66     else if (fcu->rna_path == NULL) {
67       strcpy(name, IFACE_("<no path>"));
68     }
69     else { /* id == NULL */
70       BLI_snprintf(name, 256, "%s[%d]", fcu->rna_path, fcu->array_index);
71     }
72   }
73   else {
74     PointerRNA id_ptr, ptr;
75     PropertyRNA *prop;
76
77     /* get RNA pointer, and resolve the path */
78     RNA_id_pointer_create(id, &id_ptr);
79
80     /* try to resolve the path */
81     if (RNA_path_resolve_property(&id_ptr, fcu->rna_path, &ptr, &prop)) {
82       const char *structname = NULL, *propname = NULL;
83       char arrayindbuf[16];
84       const char *arrayname = NULL;
85       short free_structname = 0;
86
87       /* For now, name will consist of 3 parts: struct-name, property name, array index
88        * There are several options possible:
89        * 1) <struct-name>.<property-name>.<array-index>
90        *     i.e. Bone1.Location.X, or Object.Location.X
91        * 2) <array-index> <property-name> (<struct name>)
92        *     i.e. X Location (Bone1), or X Location (Object)
93        *
94        * Currently, option 2 is in use, to try and make it easier to quickly identify F-Curves
95        * (it does have problems with looking rather odd though).
96        * Option 1 is better in terms of revealing a consistent sense of hierarchy though,
97        * which isn't so clear with option 2.
98        */
99
100       /* For structname:
101        * - As base, we use a custom name from the structs if one is available
102        * - However, if we're showing subdata of bones
103        *   (probably there will be other exceptions later).
104        *   need to include that info too since it gets confusing otherwise.
105        * - If a pointer just refers to the ID-block, then don't repeat this info
106        *   since this just introduces clutter.
107        */
108       if (strstr(fcu->rna_path, "bones") && strstr(fcu->rna_path, "constraints")) {
109         /* perform string 'chopping' to get "Bone Name : Constraint Name" */
110         char *pchanName = BLI_str_quoted_substrN(fcu->rna_path, "bones[");
111         char *constName = BLI_str_quoted_substrN(fcu->rna_path, "constraints[");
112
113         /* assemble the string to display in the UI... */
114         structname = BLI_sprintfN("%s : %s", pchanName, constName);
115         free_structname = 1;
116
117         /* free the temp names */
118         if (pchanName) {
119           MEM_freeN(pchanName);
120         }
121         if (constName) {
122           MEM_freeN(constName);
123         }
124       }
125       else if (ptr.data != ptr.id.data) {
126         PropertyRNA *nameprop = RNA_struct_name_property(ptr.type);
127         if (nameprop) {
128           /* this gets a string which will need to be freed */
129           structname = RNA_property_string_get_alloc(&ptr, nameprop, NULL, 0, NULL);
130           free_structname = 1;
131         }
132         else {
133           structname = RNA_struct_ui_name(ptr.type);
134         }
135       }
136
137       /* Property Name is straightforward */
138       propname = RNA_property_ui_name(prop);
139
140       /* Array Index - only if applicable */
141       if (RNA_property_array_check(prop)) {
142         char c = RNA_property_array_item_char(prop, fcu->array_index);
143
144         /* we need to write the index to a temp buffer (in py syntax) */
145         if (c) {
146           BLI_snprintf(arrayindbuf, sizeof(arrayindbuf), "%c ", c);
147         }
148         else {
149           BLI_snprintf(arrayindbuf, sizeof(arrayindbuf), "[%d]", fcu->array_index);
150         }
151
152         arrayname = &arrayindbuf[0];
153       }
154       else {
155         /* no array index */
156         arrayname = "";
157       }
158
159       /* putting this all together into the buffer */
160       /* XXX we need to check for invalid names...
161        * XXX the name length limit needs to be passed in or as some define */
162       if (structname) {
163         BLI_snprintf(name, 256, "%s%s (%s)", arrayname, propname, structname);
164       }
165       else {
166         BLI_snprintf(name, 256, "%s%s", arrayname, propname);
167       }
168
169       /* free temp name if nameprop is set */
170       if (free_structname) {
171         MEM_freeN((void *)structname);
172       }
173
174       /* Icon for this property's owner:
175        * use the struct's icon if it is set
176        */
177       icon = RNA_struct_ui_icon(ptr.type);
178
179       /* valid path - remove the invalid tag since we now know how to use it saving
180        * users manual effort to reenable using "Revive Disabled FCurves" [#29629]
181        */
182       fcu->flag &= ~FCURVE_DISABLED;
183     }
184     else {
185       /* invalid path */
186       BLI_snprintf(name, 256, "\"%s[%d]\"", fcu->rna_path, fcu->array_index);
187
188       /* icon for this should be the icon for the base ID */
189       /* TODO: or should we just use the error icon? */
190       icon = RNA_struct_ui_icon(id_ptr.type);
191
192       /* tag F-Curve as disabled - as not usable path */
193       fcu->flag |= FCURVE_DISABLED;
194     }
195   }
196
197   /* return the icon that the active data had */
198   return icon;
199 }
200
201 /* ------------------------------- Color Codes for F-Curve Channels ---------------------------- */
202
203 /* step between the major distinguishable color bands of the primary colors */
204 #define HSV_BANDWIDTH 0.3f
205
206 /* used to determine the color of F-Curves with FCURVE_COLOR_AUTO_RAINBOW set */
207 // void fcurve_rainbow(unsigned int cur, unsigned int tot, float *out)
208 void getcolor_fcurve_rainbow(int cur, int tot, float out[3])
209 {
210   float hsv[3], fac;
211   int grouping;
212
213   /* we try to divide the color into groupings of n colors,
214    * where n is:
215    * 3 - for 'odd' numbers of curves - there should be a majority of triplets of curves
216    * 4 - for 'even' numbers of curves - there should be a majority of quartets of curves
217    * so the base color is simply one of the three primary colors
218    */
219   grouping = (4 - (tot % 2));
220   hsv[0] = HSV_BANDWIDTH * (float)(cur % grouping);
221
222   /* 'Value' (i.e. darkness) needs to vary so that larger sets of three will be
223    * 'darker' (i.e. smaller value), so that they don't look that similar to previous ones.
224    * However, only a range of 0.3 to 1.0 is really usable to avoid clashing
225    * with some other stuff
226    */
227   fac = ((float)cur / (float)tot) * 0.7f;
228
229   /* the base color can get offset a bit so that the colors aren't so identical */
230   hsv[0] += fac * HSV_BANDWIDTH;
231   if (hsv[0] > 1.0f) {
232     hsv[0] = fmod(hsv[0], 1.0f);
233   }
234
235   /* saturation adjustments for more visible range */
236   hsv[1] = ((hsv[0] > 0.5f) && (hsv[0] < 0.8f)) ? 0.5f : 0.6f;
237
238   /* value is fixed at 1.0f, otherwise we cannot clearly see the curves... */
239   hsv[2] = 1.0f;
240
241   /* finally, conver this to RGB colors */
242   hsv_to_rgb_v(hsv, out);
243 }