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