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