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