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