did math lib conversion, equivilent to merge with trunk/2.5 at r24464
[blender-staging.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /* This file contains code for presenting F-Curves and other animation data
30  * in the UI (especially for use in the Animation Editors).
31  *
32  * -- Joshua Leung, Dec 2008
33  */
34
35
36 #include <math.h>
37 #include <stdio.h>
38 #include <string.h>
39
40 #include "MEM_guardedalloc.h"
41
42 #include "BLI_blenlib.h"
43 #include "BLI_math.h"
44
45 #include "DNA_anim_types.h"
46 #include "DNA_key_types.h"
47 #include "DNA_object_types.h"
48 #include "DNA_space_types.h"
49 #include "DNA_scene_types.h"
50 #include "DNA_view3d_types.h"
51
52 #include "BKE_animsys.h"
53 #include "BKE_key.h"
54 #include "BKE_utildefines.h"
55
56 #include "UI_resources.h"
57 #include "ED_anim_api.h"
58
59 #include "RNA_access.h"
60 #include "RNA_types.h"
61
62 /* ----------------------- Getter functions ----------------------- */
63
64 /* Write into "name" buffer, the name of the property (retrieved using RNA from the curve's settings),
65  * and return the icon used for the struct that this property refers to 
66  * WARNING: name buffer we're writing to cannot exceed 256 chars (check anim_channels_defines.c for details)
67  */
68 int getname_anim_fcurve(char *name, ID *id, FCurve *fcu)
69 {
70         int icon = 0;
71         
72         /* sanity checks */
73         if (name == NULL)
74                 return icon;
75         else if ELEM3(NULL, id, fcu, fcu->rna_path) {
76                 if (fcu == NULL)
77                         sprintf(name, "<invalid>");
78                 else if (fcu->rna_path == NULL)
79                         sprintf(name, "<no path>");
80                 else /* id == NULL */
81                         BLI_snprintf(name, 256, "%s[%d]", fcu->rna_path, fcu->array_index);
82         }
83         else {
84                 PointerRNA id_ptr, ptr;
85                 PropertyRNA *prop;
86                 
87                 /* get RNA pointer, and resolve the path */
88                 RNA_id_pointer_create(id, &id_ptr);
89                 
90                 /* try to resolve the path */
91                 if (RNA_path_resolve(&id_ptr, fcu->rna_path, &ptr, &prop)) {
92                         char *structname=NULL, *propname=NULL, *arrayname=NULL, arrayindbuf[16];
93                         short free_structname = 0;
94                         
95                         /* For now, name will consist of 3 parts: struct-name, property name, array index
96                          * There are several options possible:
97                          *      1) <struct-name>.<property-name>.<array-index>
98                          *              i.e. Bone1.Location.X, or Object.Location.X
99                          *      2) <array-index> <property-name> (<struct name>)
100                          *              i.e. X Location (Bone1), or X Location (Object)
101                          *      
102                          * Currently, option 2 is in use, to try and make it easier to quickly identify F-Curves (it does have
103                          * problems with looking rather odd though). Option 1 is better in terms of revealing a consistent sense of 
104                          * hierarchy though, which isn't so clear with option 2.
105                          */
106                         
107                         /* for structname
108                          *      - as base, we use a custom name from the structs if one is available 
109                          *      - however, if we're showing subdata of bones (probably there will be other exceptions later)
110                          *        need to include that info too since it gets confusing otherwise
111                          */
112                         if (strstr(fcu->rna_path, "pose_channels") && strstr(fcu->rna_path, "constraints")) {
113                                 /* perform string 'chopping' to get "Bone Name : Constraint Name" */
114                                 char *pchanName= BLI_getQuotedStr(fcu->rna_path, "pose_channels[");
115                                 char *constName= BLI_getQuotedStr(fcu->rna_path, "constraints[");
116                                 
117                                 /* assemble the string to display in the UI... */
118                                 structname= BLI_sprintfN("%s : %s", pchanName, constName);
119                                 free_structname= 1;
120                                 
121                                 /* free the temp names */
122                                 if (pchanName) MEM_freeN(pchanName);
123                                 if (constName) MEM_freeN(constName);
124                         }
125                         else {
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);
130                                         free_structname= 1;
131                                 }
132                                 else
133                                         structname= (char *)RNA_struct_ui_name(ptr.type);
134                         }
135                         
136                         /* Property Name is straightforward */
137                         propname= (char *)RNA_property_ui_name(prop);
138                         
139                         /* Array Index - only if applicable */
140                         if (RNA_property_array_length(&ptr, prop)) {
141                                 char c= RNA_property_array_item_char(prop, fcu->array_index);
142                                 
143                                 /* we need to write the index to a temp buffer (in py syntax) */
144                                 if (c) sprintf(arrayindbuf, "%c ", c);
145                                 else sprintf(arrayindbuf, "[%d]", fcu->array_index);
146                                 
147                                 arrayname= &arrayindbuf[0];
148                         }
149                         else {
150                                 /* no array index */
151                                 arrayname= "";
152                         }
153                         
154                         /* putting this all together into the buffer */
155                         // XXX we need to check for invalid names...
156                         BLI_snprintf(name, 256, "%s%s (%s)", arrayname, propname, structname); 
157                         
158                         /* free temp name if nameprop is set */
159                         if (free_structname)
160                                 MEM_freeN(structname);
161                         
162                         
163                         /* Icon for this property's owner:
164                          *      use the struct's icon if it is set
165                          */
166                         icon= RNA_struct_ui_icon(ptr.type);
167                 }
168                 else {
169                         /* invalid path */
170                         BLI_snprintf(name, 256, "\"%s[%d]\"", fcu->rna_path, fcu->array_index);
171                         
172                         /* icon for this should be the icon for the base ID */
173                         // TODO: or should we just use the error icon?
174                         icon= RNA_struct_ui_icon(id_ptr.type);
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 #if 0
185 /* used for FCURVE_COLOR_AUTO_RAINBOW */
186 // XXX this still doesn't work too great when there are more than 32 curves (which happens most of the time)
187 void ipo_rainbow (int cur, int tot, float *out)
188 {
189         float dfac, fac, sat;
190         
191         dfac= (float)(1.0/( (float)tot+1.0));
192         
193         /* this calculation makes 2 or 4 different cycles of rainbow colors */
194                 // 2 different cycles - for hue
195         if(cur< tot/2) fac= (float)(cur*2.0f*dfac);
196         else fac= (float)((cur-tot/2)*2.0f*dfac +dfac);
197         
198                 // third cycle with altered hue
199         if(tot > 32) fac= fac*1.95f;
200                 // clamping for excessive ranges
201         if(fac>1.0f) fac-= 1.0f;
202         
203                 // saturation adjustments for more visible range
204         if(fac>0.5f && fac<0.8f) sat= 0.5f;
205         else sat= 0.6f;
206         
207         hsv_to_rgb(fac, sat, 1.0f, out, out+1, out+2);
208 }
209 #endif
210
211 /* step between the major distinguishable color bands of the primary colors */
212 #define HSV_BANDWIDTH   0.3f
213
214 /* testbed for FCURVE_COLOR_AUTO_RAINBOW determination methods */
215 //void fcurve_rainbow (unsigned int cur, unsigned int tot, float *out)
216 void ipo_rainbow (int cur, int tot, float *out)
217 {
218         float hue, val, sat, fac;
219         int grouping;
220         
221         /* we try to divide the colours into groupings of n colors,
222          * where n is:
223          *      3 - for 'odd' numbers of curves - there should be a majority of triplets of curves
224          *      4 - for 'even' numbers of curves - there should be a majority of quartets of curves
225          * so the base color is simply one of the three primary colors
226          */
227         grouping= (4 - (tot % 2));
228         hue= HSV_BANDWIDTH * (float)(cur % grouping);
229         
230         /* 'Value' (i.e. darkness) needs to vary so that larger sets of three will be 
231          * 'darker' (i.e. smaller value), so that they don't look that similar to previous ones.
232          * However, only a range of 0.3 to 1.0 is really usable to avoid clashing
233          * with some other stuff 
234          */
235         fac = ((float)cur / (float)tot) * 0.7f;
236         
237         /* the base color can get offset a bit so that the colors aren't so identical */
238         hue += fac * HSV_BANDWIDTH; 
239         if (hue > 1.0f) hue= fmod(hue, 1.0f);
240         
241         /* saturation adjustments for more visible range */
242         if ((hue > 0.5f) && (hue < 0.8f)) sat= 0.5f;
243         else sat= 0.6f;
244         
245         /* value is fixed at 1.0f, otherwise we cannot clearly see the curves... */
246         val= 1.0f;
247         
248         /* finally, conver this to RGB colors */
249         hsv_to_rgb(hue, sat, val, out, out+1, out+2); 
250 }