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