Merge with 2.5 -r 21788:22040.
[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
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_blenlib.h"
42 #include "BLI_arithb.h"
43
44 #include "DNA_anim_types.h"
45 #include "DNA_key_types.h"
46 #include "DNA_object_types.h"
47 #include "DNA_space_types.h"
48 #include "DNA_scene_types.h"
49 #include "DNA_view3d_types.h"
50
51 #include "BKE_animsys.h"
52 #include "BKE_key.h"
53 #include "BKE_utildefines.h"
54
55 #include "UI_resources.h"
56 #include "ED_anim_api.h"
57
58 #include "RNA_access.h"
59 #include "RNA_types.h"
60
61 /* ----------------------- Getter functions ----------------------- */
62
63 /* gets the appropriate icon for the given blocktype */
64 // XXX some of these will be depreceated?
65 int geticon_anim_blocktype(short blocktype)
66 {
67         switch (blocktype) {
68                 case ID_OB:
69                         return ICON_OBJECT_DATA;
70                 case ID_PO:
71                         return ICON_POSE_HLT;
72                 case ID_KE:
73                         return ICON_SHAPEKEY_DATA;
74                 case ID_MA:
75                         return ICON_MATERIAL;
76                 case ID_WO:
77                         return ICON_WORLD;
78                 case ID_CU:
79                         return ICON_CURVE_DATA;
80                 case ID_CA:
81                         return ICON_CAMERA;
82                 case ID_LA:
83                         return ICON_LAMP;
84                 case ID_TE:
85                         return ICON_TEXTURE;
86                 case ID_CO:
87                         return ICON_CONSTRAINT;
88                 case ID_FLUIDSIM:
89                         return ICON_WORLD; // uggh
90                 default:
91                         return 0; // what about blank icon?
92         }
93 }
94
95 /* Write into "name" buffer, the name of the property (retrieved using RNA from the curve's settings) 
96  * WARNING: name buffer we're writing to cannot exceed 128 chars (check action_draw.c for details)
97  */
98 // TODO: have an extra var to indicate if prop was valid?
99 void getname_anim_fcurve(char *name, ID *id, FCurve *fcu)
100 {
101         /* sanity checks */
102         if (name == NULL)
103                 return;
104         else if ELEM3(NULL, id, fcu, fcu->rna_path) {
105                 if (fcu == NULL)
106                         sprintf(name, "<invalid>");
107                 else if (fcu->rna_path == NULL)
108                         sprintf(name, "<no path>");
109                 else /* id == NULL */
110                         BLI_snprintf(name, 128, "%s[%d]", fcu->rna_path, fcu->array_index);
111         }
112         else {
113                 PointerRNA id_ptr, ptr;
114                 PropertyRNA *prop;
115                 
116                 /* get RNA pointer, and resolve the path */
117                 RNA_id_pointer_create(id, &id_ptr);
118                 
119                 /* try to resolve the path */
120                 if (RNA_path_resolve(&id_ptr, fcu->rna_path, &ptr, &prop)) {
121                         char *structname=NULL, *propname=NULL, *arrayname=NULL, arrayindbuf[16];
122                         PropertyRNA *nameprop;
123                         
124                         /* For now, name will consist of 3 parts: struct-name, property name, array index
125                          * There are several options possible:
126                          *      1) <struct-name>.<property-name>.<array-index>
127                          *              i.e. Bone1.Location.X, or Object.Location.X
128                          *      2) <array-index> <property-name> (<struct name>)
129                          *              i.e. X Location (Bone1), or X Location (Object)
130                          *      
131                          * Currently, option 2 is in use, to try and make it easier to quickly identify F-Curves (it does have
132                          * problems with looking rather odd though). Option 1 is better in terms of revealing a consistent sense of 
133                          * hierarchy though, which isn't so clear with option 2.
134                          */
135                         
136                         /* for structname, we use a custom name if one is available */
137                                 // xxx we might want an icon from types?
138                                 // xxx it is hard to differentiate between object and bone channels then, if ob + bone motion occur together...
139                         nameprop= RNA_struct_name_property(ptr.type);
140                         if (nameprop) {
141                                 /* this gets a string which will need to be freed */
142                                 structname= RNA_property_string_get_alloc(&ptr, nameprop, NULL, 0);
143                         }
144                         else
145                                 structname= (char *)RNA_struct_ui_name(ptr.type);
146                         
147                         /* Property Name is straightforward */
148                         propname= (char *)RNA_property_ui_name(prop);
149                         
150                         /* Array Index - only if applicable */
151                         if (RNA_property_array_length(prop)) {
152                                 static char *vectoritem[4]= {"X ", "Y ", "Z ", "W "};
153                                 static char *quatitem[4]= {"W ", "X ", "Y ", "Z "};
154                                 static char *coloritem[4]= {"R ", "G ", "B ", "A "};
155                                 
156                                 int tot= RNA_property_array_length(prop);
157                                 int propsubtype= RNA_property_subtype(prop);
158                                 
159                                 /* get string to use for array index */
160                                 if ((tot == 4) && (propsubtype == PROP_ROTATION))
161                                         arrayname= quatitem[fcu->array_index];
162                                 else if ( (tot <= 4) && ((propsubtype == PROP_VECTOR) || (propsubtype == PROP_ROTATION)) )
163                                         arrayname= vectoritem[fcu->array_index];
164                                 else if ((tot <= 4) && (propsubtype == PROP_COLOR))
165                                         arrayname= coloritem[fcu->array_index];
166                                 else {
167                                         /* we need to write the index to a temp buffer (in py syntax), as it is a number... */
168                                         sprintf(arrayindbuf, "[%d]", fcu->array_index);
169                                         arrayname= &arrayindbuf[0];
170                                 }
171                         }
172                         else {
173                                 /* no array index */
174                                 arrayname= "";
175                         }
176                         
177                         /* putting this all together into the buffer */
178                         // XXX we need to check for invalid names...
179                         BLI_snprintf(name, 128, "%s%s (%s)", arrayname, propname, structname); 
180                         
181                         /* free temp name if nameprop is set */
182                         if (nameprop)
183                                 MEM_freeN(structname);
184                 }
185                 else {
186                         /* invalid path */
187                         BLI_snprintf(name, 128, "\"%s[%d]\"", fcu->rna_path, fcu->array_index);
188                 }
189         }
190 }
191
192 /* ------------------------------- Color Codes for F-Curve Channels ---------------------------- */
193
194 #if 0
195 /* used for FCURVE_COLOR_AUTO_RAINBOW */
196 // XXX this still doesn't work too great when there are more than 32 curves (which happens most of the time)
197 void ipo_rainbow (int cur, int tot, float *out)
198 {
199         float dfac, fac, sat;
200         
201         dfac= (float)(1.0/( (float)tot+1.0));
202         
203         /* this calculation makes 2 or 4 different cycles of rainbow colors */
204                 // 2 different cycles - for hue
205         if(cur< tot/2) fac= (float)(cur*2.0f*dfac);
206         else fac= (float)((cur-tot/2)*2.0f*dfac +dfac);
207         
208                 // third cycle with altered hue
209         if(tot > 32) fac= fac*1.95f;
210                 // clamping for excessive ranges
211         if(fac>1.0f) fac-= 1.0f;
212         
213                 // saturation adjustments for more visible range
214         if(fac>0.5f && fac<0.8f) sat= 0.5f;
215         else sat= 0.6f;
216         
217         hsv_to_rgb(fac, sat, 1.0f, out, out+1, out+2);
218 }
219 #endif
220
221 /* step between the major distinguishable color bands of the primary colors */
222 #define HSV_BANDWIDTH   0.3f
223
224 /* testbed for FCURVE_COLOR_AUTO_RAINBOW determination methods */
225 //void fcurve_rainbow (unsigned int cur, unsigned int tot, float *out)
226 void ipo_rainbow (int cur, int tot, float *out)
227 {
228         float hue, val, sat, fac;
229         int grouping;
230         
231         /* we try to divide the colours into groupings of n colors,
232          * where n is:
233          *      3 - for 'odd' numbers of curves - there should be a majority of triplets of curves
234          *      4 - for 'even' numbers of curves - there should be a majority of quartets of curves
235          * so the base color is simply one of the three primary colors
236          */
237         grouping= (4 - (tot % 2));
238         hue= HSV_BANDWIDTH * (float)(cur % grouping);
239         
240         /* 'Value' (i.e. darkness) needs to vary so that larger sets of three will be 
241          * 'darker' (i.e. smaller value), so that they don't look that similar to previous ones.
242          * However, only a range of 0.3 to 1.0 is really usable to avoid clashing
243          * with some other stuff 
244          */
245         fac = ((float)cur / (float)tot) * 0.7f;
246         
247         /* the base color can get offset a bit so that the colors aren't so identical */
248         hue += fac * HSV_BANDWIDTH; 
249         if (hue > 1.0f) hue= fmod(hue, 1.0f);
250         
251         /* saturation adjustments for more visible range */
252         if ((hue > 0.5f) && (hue < 0.8f)) sat= 0.5f;
253         else sat= 0.6f;
254         
255         /* value is fixed at 1.0f, otherwise we cannot clearly see the curves... */
256         val= 1.0f;
257         
258         /* finally, conver this to RGB colors */
259         hsv_to_rgb(hue, sat, val, out, out+1, out+2); 
260 }