code cleanup: don't use magic numbers for curve flag & use bool args for curvemapping...
[blender.git] / source / blender / makesrna / intern / rna_color.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_color.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29 #include <stdio.h>
30
31 #include "RNA_define.h"
32 #include "rna_internal.h"
33
34 #include "DNA_color_types.h"
35 #include "DNA_texture_types.h"
36
37 #ifdef RNA_RUNTIME
38
39 #include "RNA_access.h"
40
41 #include "DNA_material_types.h"
42 #include "DNA_node_types.h"
43
44 #include "MEM_guardedalloc.h"
45
46 #include "BKE_colortools.h"
47 #include "BKE_depsgraph.h"
48 #include "BKE_node.h"
49 #include "BKE_texture.h"
50
51 #include "WM_api.h"
52 #include "WM_types.h"
53
54 #include "ED_node.h"
55
56 static int rna_CurveMapping_curves_length(PointerRNA *ptr)
57 {
58         CurveMapping *cumap = (CurveMapping *)ptr->data;
59         int len;
60
61         for (len = 0; len < CM_TOT; len++)
62                 if (!cumap->cm[len].curve)
63                         break;
64         
65         return len;
66 }
67
68 static void rna_CurveMapping_curves_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
69 {
70         CurveMapping *cumap = (CurveMapping *)ptr->data;
71
72         rna_iterator_array_begin(iter, cumap->cm, sizeof(CurveMap), rna_CurveMapping_curves_length(ptr), 0, NULL);
73 }
74
75 static void rna_CurveMapping_clip_set(PointerRNA *ptr, int value)
76 {
77         CurveMapping *cumap = (CurveMapping *)ptr->data;
78
79         if (value) cumap->flag |= CUMA_DO_CLIP;
80         else cumap->flag &= ~CUMA_DO_CLIP;
81
82         curvemapping_changed(cumap, FALSE);
83 }
84
85 static void rna_CurveMapping_black_level_set(PointerRNA *ptr, const float *values)
86 {
87         CurveMapping *cumap = (CurveMapping *)ptr->data;
88         cumap->black[0] = values[0];
89         cumap->black[1] = values[1];
90         cumap->black[2] = values[2];
91         curvemapping_set_black_white(cumap, NULL, NULL);
92 }
93
94 static void rna_CurveMapping_white_level_set(PointerRNA *ptr, const float *values)
95 {
96         CurveMapping *cumap = (CurveMapping *)ptr->data;
97         cumap->white[0] = values[0];
98         cumap->white[1] = values[1];
99         cumap->white[2] = values[2];
100         curvemapping_set_black_white(cumap, NULL, NULL);
101 }
102
103 static void rna_CurveMapping_clipminx_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
104 {
105         CurveMapping *cumap = (CurveMapping *)ptr->data;
106
107         *min = -100.0f;
108         *max = cumap->clipr.xmax;
109 }
110
111 static void rna_CurveMapping_clipminy_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
112 {
113         CurveMapping *cumap = (CurveMapping *)ptr->data;
114
115         *min = -100.0f;
116         *max = cumap->clipr.ymax;
117 }
118
119 static void rna_CurveMapping_clipmaxx_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
120 {
121         CurveMapping *cumap = (CurveMapping *)ptr->data;
122
123         *min = cumap->clipr.xmin;
124         *max = 100.0f;
125 }
126
127 static void rna_CurveMapping_clipmaxy_range(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax)
128 {
129         CurveMapping *cumap = (CurveMapping *)ptr->data;
130
131         *min = cumap->clipr.ymin;
132         *max = 100.0f;
133 }
134
135
136 static char *rna_ColorRamp_path(PointerRNA *ptr)
137 {
138         char *path = NULL;
139         
140         /* handle the cases where a single datablock may have 2 ramp types */
141         if (ptr->id.data) {
142                 ID *id = ptr->id.data;
143                 
144                 switch (GS(id->name)) {
145                         case ID_MA: /* material has 2 cases - diffuse and specular */
146                         {
147                                 Material *ma = (Material *)id;
148                                 
149                                 if (ptr->data == ma->ramp_col)
150                                         path = BLI_strdup("diffuse_ramp");
151                                 else if (ptr->data == ma->ramp_spec)
152                                         path = BLI_strdup("specular_ramp");
153                                 break;
154                         }
155                         
156                         case ID_NT:
157                         {
158                                 bNodeTree *ntree = (bNodeTree *)id;
159                                 bNode *node;
160                                 PointerRNA node_ptr;
161                                 char *node_path;
162                                 
163                                 for (node = ntree->nodes.first; node; node = node->next) {
164                                         if (ELEM3(node->type, SH_NODE_VALTORGB, CMP_NODE_VALTORGB, TEX_NODE_VALTORGB)) {
165                                                 if (node->storage == ptr->data) {
166                                                         /* all node color ramp properties called 'color_ramp'
167                                                          * prepend path from ID to the node
168                                                          */
169                                                         RNA_pointer_create(id, &RNA_Node, node, &node_ptr);
170                                                         node_path = RNA_path_from_ID_to_struct(&node_ptr);
171                                                         path = BLI_sprintfN("%s.color_ramp", node_path);
172                                                         MEM_freeN(node_path);
173                                                 }
174                                         }
175                                 }
176                                 break;
177                         }
178                         
179                         default:
180                                 /* everything else just uses 'color_ramp' */
181                                 path = BLI_strdup("color_ramp");
182                                 break;
183                 }
184         }
185         else {
186                 /* everything else just uses 'color_ramp' */
187                 path = BLI_strdup("color_ramp");
188         }
189         
190         return path;
191 }
192
193 static char *rna_ColorRampElement_path(PointerRNA *ptr)
194 {
195         PointerRNA ramp_ptr;
196         PropertyRNA *prop;
197         char *path = NULL;
198         int index;
199         
200         /* helper macro for use here to try and get the path
201          *      - this calls the standard code for getting a path to a texture...
202          */
203
204 #define COLRAMP_GETPATH                                                       \
205 {                                                                             \
206         prop = RNA_struct_find_property(&ramp_ptr, "elements");                   \
207         if (prop) {                                                               \
208                 index = RNA_property_collection_lookup_index(&ramp_ptr, prop, ptr);   \
209                 if (index >= 0) {                                                     \
210                         char *texture_path = rna_ColorRamp_path(&ramp_ptr);               \
211                         path = BLI_sprintfN("%s.elements[%d]", texture_path, index);      \
212                         MEM_freeN(texture_path);                                          \
213                 }                                                                     \
214         }                                                                         \
215 } (void)0
216
217         /* determine the path from the ID-block to the ramp */
218         /* FIXME: this is a very slow way to do it, but it will have to suffice... */
219         if (ptr->id.data) {
220                 ID *id = ptr->id.data;
221                 
222                 switch (GS(id->name)) {
223                         case ID_MA: /* 2 cases for material - diffuse and spec */
224                         {
225                                 Material *ma = (Material *)id;
226                                 
227                                 /* try diffuse first */
228                                 if (ma->ramp_col) {
229                                         RNA_pointer_create(id, &RNA_ColorRamp, ma->ramp_col, &ramp_ptr);
230                                         COLRAMP_GETPATH;
231                                 }
232                                 /* try specular if not diffuse */
233                                 if (!path && ma->ramp_spec) {
234                                         RNA_pointer_create(id, &RNA_ColorRamp, ma->ramp_spec, &ramp_ptr);
235                                         COLRAMP_GETPATH;
236                                 }
237                         }
238                         break;
239                                 
240                         case ID_NT:
241                         {
242                                 bNodeTree *ntree = (bNodeTree *)id;
243                                 bNode *node;
244                                 
245                                 for (node = ntree->nodes.first; node; node = node->next) {
246                                         if (ELEM3(node->type, SH_NODE_VALTORGB, CMP_NODE_VALTORGB, TEX_NODE_VALTORGB)) {
247                                                 RNA_pointer_create(id, &RNA_ColorRamp, node->storage, &ramp_ptr);
248                                                 COLRAMP_GETPATH;
249                                         }
250                                 }
251                         }
252                         break;
253                                 
254                         default: /* everything else should have a "color_ramp" property */
255                         {
256                                 /* create pointer to the ID block, and try to resolve "color_ramp" pointer */
257                                 RNA_id_pointer_create(id, &ramp_ptr);
258                                 if (RNA_path_resolve(&ramp_ptr, "color_ramp", &ramp_ptr, &prop)) {
259                                         COLRAMP_GETPATH;
260                                 }
261                         }
262                 }
263         }
264         
265         /* cleanup the macro we defined */
266 #undef COLRAMP_GETPATH
267         
268         return path;
269 }
270
271 static void rna_ColorRamp_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
272 {
273         if (ptr->id.data) {
274                 ID *id = ptr->id.data;
275                 
276                 switch (GS(id->name)) {
277                         case ID_MA:
278                         {
279                                 Material *ma = ptr->id.data;
280                                 
281                                 DAG_id_tag_update(&ma->id, 0);
282                                 WM_main_add_notifier(NC_MATERIAL | ND_SHADING_DRAW, ma);
283                         }
284                         break;
285                         case ID_NT:
286                         {
287                                 bNodeTree *ntree = (bNodeTree *)id;
288                                 bNode *node;
289
290                                 for (node = ntree->nodes.first; node; node = node->next) {
291                                         if (ELEM3(node->type, SH_NODE_VALTORGB, CMP_NODE_VALTORGB, TEX_NODE_VALTORGB)) {
292                                                 ED_node_generic_update(bmain, ntree, node);
293                                         }
294                                 }
295                         }
296                         break;
297                         case ID_TE:
298                         {
299                                 Tex *tex = ptr->id.data;
300
301                                 DAG_id_tag_update(&tex->id, 0);
302                                 WM_main_add_notifier(NC_TEXTURE, tex);
303                         }
304                         break;
305                         default:
306                                 break;
307                 }
308         }
309 }
310
311 void rna_ColorRamp_eval(struct ColorBand *coba, float position, float color[4])
312 {
313         do_colorband(coba, position, color);
314 }
315
316 static CBData *rna_ColorRampElement_new(struct ColorBand *coba, ReportList *reports, float position)
317 {
318         CBData *element = colorband_element_add(coba, position);
319
320         if (element == NULL)
321                 BKE_reportf(reports, RPT_ERROR, "Unable to add element to colorband (limit %d)", MAXCOLORBAND);
322
323         return element;
324 }
325
326 static void rna_ColorRampElement_remove(struct ColorBand *coba, ReportList *reports, CBData *element)
327 {
328         int index = (int)(element - coba->data);
329         if (colorband_element_remove(coba, index) == 0)
330                 BKE_report(reports, RPT_ERROR, "Element not found in element collection or last element");
331
332 }
333
334 static void rna_Scopes_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
335 {
336         Scopes *s = (Scopes *)ptr->data;
337         s->ok = 0;
338 }
339
340 #else
341
342 static void rna_def_curvemappoint(BlenderRNA *brna)
343 {
344         StructRNA *srna;
345         PropertyRNA *prop;
346         static EnumPropertyItem prop_handle_type_items[] = {
347                 {0, "AUTO", 0, "Auto Handle", ""},
348                 {CUMA_VECTOR, "VECTOR", 0, "Vector Handle", ""},
349                 {0, NULL, 0, NULL, NULL}
350         };
351
352         srna = RNA_def_struct(brna, "CurveMapPoint", NULL);
353         RNA_def_struct_ui_text(srna, "CurveMapPoint", "Point of a curve used for a curve mapping");
354
355         prop = RNA_def_property(srna, "location", PROP_FLOAT, PROP_XYZ);
356         RNA_def_property_float_sdna(prop, NULL, "x");
357         RNA_def_property_array(prop, 2);
358         RNA_def_property_ui_text(prop, "Location", "X/Y coordinates of the curve point");
359
360         prop = RNA_def_property(srna, "handle_type", PROP_ENUM, PROP_NONE);
361         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
362         RNA_def_property_enum_items(prop, prop_handle_type_items);
363         RNA_def_property_ui_text(prop, "Handle Type", "Curve interpolation at this point: Bezier or vector");
364
365         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
366         RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_SELECT);
367         RNA_def_property_ui_text(prop, "Select", "Selection state of the curve point");
368 }
369
370 static void rna_def_curvemap_points_api(BlenderRNA *brna, PropertyRNA *cprop)
371 {
372         StructRNA *srna;
373         PropertyRNA *parm;
374         FunctionRNA *func;
375
376         RNA_def_property_srna(cprop, "CurveMapPoints");
377         srna = RNA_def_struct(brna, "CurveMapPoints", NULL);
378         RNA_def_struct_sdna(srna, "CurveMap");
379         RNA_def_struct_ui_text(srna, "Curve Map Point", "Collection of Curve Map Points");
380
381         func = RNA_def_function(srna, "new", "curvemap_insert");
382         RNA_def_function_ui_description(func, "Add point to CurveMap");
383         parm = RNA_def_float(func, "position", 0.0f, -FLT_MAX, FLT_MAX, "Position", "Position to add point", -FLT_MAX, FLT_MAX);
384         RNA_def_property_flag(parm, PROP_REQUIRED);
385         parm = RNA_def_float(func, "value", 0.0f, -FLT_MAX, FLT_MAX, "Value", "Value of point", -FLT_MAX, FLT_MAX);
386         RNA_def_property_flag(parm, PROP_REQUIRED);
387         parm = RNA_def_pointer(func, "point", "CurveMapPoint", "", "New point");
388         RNA_def_function_return(func, parm);
389
390         func = RNA_def_function(srna, "remove", "curvemap_remove_point");
391         RNA_def_function_ui_description(func, "Delete point from CurveMap");
392         parm = RNA_def_pointer(func, "point", "CurveMapPoint", "", "PointElement to remove");
393         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
394 }
395
396 static void rna_def_curvemap(BlenderRNA *brna)
397 {
398         StructRNA *srna;
399         PropertyRNA *prop, *parm;
400         FunctionRNA *func;
401
402         static EnumPropertyItem prop_extend_items[] = {
403                 {0, "HORIZONTAL", 0, "Horizontal", ""},
404                 {CUMA_EXTEND_EXTRAPOLATE, "EXTRAPOLATED", 0, "Extrapolated", ""},
405                 {0, NULL, 0, NULL, NULL}
406         };
407
408         srna = RNA_def_struct(brna, "CurveMap", NULL);
409         RNA_def_struct_ui_text(srna, "CurveMap", "Curve in a curve mapping");
410
411         prop = RNA_def_property(srna, "extend", PROP_ENUM, PROP_NONE);
412         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
413         RNA_def_property_enum_items(prop, prop_extend_items);
414         RNA_def_property_ui_text(prop, "Extend", "Extrapolate the curve or extend it horizontally");
415
416         prop = RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
417         RNA_def_property_collection_sdna(prop, NULL, "curve", "totpoint");
418         RNA_def_property_struct_type(prop, "CurveMapPoint");
419         RNA_def_property_ui_text(prop, "Points", "");
420         rna_def_curvemap_points_api(brna, prop);
421
422         func = RNA_def_function(srna, "evaluate", "curvemap_evaluateF");
423         RNA_def_function_ui_description(func, "Evaluate curve at given location");
424         parm = RNA_def_float(func, "position", 0.0f, -FLT_MAX, FLT_MAX, "Position", "Position to evaluate curve at", -FLT_MAX, FLT_MAX);
425         RNA_def_property_flag(parm, PROP_REQUIRED);
426         parm = RNA_def_float(func, "value", 0.0f, -FLT_MAX, FLT_MAX, "Value", "Value of curve at given location", -FLT_MAX, FLT_MAX);
427         RNA_def_function_return(func, parm);
428 }
429
430 static void rna_def_curvemapping(BlenderRNA *brna)
431 {
432         StructRNA *srna;
433         PropertyRNA *prop;
434         FunctionRNA *func;
435
436         srna = RNA_def_struct(brna, "CurveMapping", NULL);
437         RNA_def_struct_ui_text(srna, "CurveMapping",
438                                "Curve mapping to map color, vector and scalar values to other values using "
439                                "a user defined curve");
440         
441         prop = RNA_def_property(srna, "use_clip", PROP_BOOLEAN, PROP_NONE);
442         RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_DO_CLIP);
443         RNA_def_property_ui_text(prop, "Clip", "Force the curve view to fit a defined boundary");
444         RNA_def_property_boolean_funcs(prop, NULL, "rna_CurveMapping_clip_set");
445
446         prop = RNA_def_property(srna, "clip_min_x", PROP_FLOAT, PROP_NONE);
447         RNA_def_property_float_sdna(prop, NULL, "clipr.xmin");
448         RNA_def_property_range(prop, -100.0f, 100.0f);
449         RNA_def_property_ui_text(prop, "Clip Min X", "");
450         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipminx_range");
451
452         prop = RNA_def_property(srna, "clip_min_y", PROP_FLOAT, PROP_NONE);
453         RNA_def_property_float_sdna(prop, NULL, "clipr.ymin");
454         RNA_def_property_range(prop, -100.0f, 100.0f);
455         RNA_def_property_ui_text(prop, "Clip Min Y", "");
456         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipminy_range");
457
458         prop = RNA_def_property(srna, "clip_max_x", PROP_FLOAT, PROP_NONE);
459         RNA_def_property_float_sdna(prop, NULL, "clipr.xmax");
460         RNA_def_property_range(prop, -100.0f, 100.0f);
461         RNA_def_property_ui_text(prop, "Clip Max X", "");
462         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipmaxx_range");
463
464         prop = RNA_def_property(srna, "clip_max_y", PROP_FLOAT, PROP_NONE);
465         RNA_def_property_float_sdna(prop, NULL, "clipr.ymax");
466         RNA_def_property_range(prop, -100.0f, 100.0f);
467         RNA_def_property_ui_text(prop, "Clip Max Y", "");
468         RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipmaxy_range");
469
470         prop = RNA_def_property(srna, "curves", PROP_COLLECTION, PROP_NONE);
471         RNA_def_property_collection_funcs(prop, "rna_CurveMapping_curves_begin", "rna_iterator_array_next",
472                                           "rna_iterator_array_end", "rna_iterator_array_get",
473                                           "rna_CurveMapping_curves_length", NULL, NULL, NULL);
474         RNA_def_property_struct_type(prop, "CurveMap");
475         RNA_def_property_ui_text(prop, "Curves", "");
476
477         prop = RNA_def_property(srna, "black_level", PROP_FLOAT, PROP_COLOR);
478         RNA_def_property_float_sdna(prop, NULL, "black");
479         RNA_def_property_range(prop, -1000.0f, 1000.0f);
480         RNA_def_property_ui_text(prop, "Black Level", "For RGB curves, the color that black is mapped to");
481         RNA_def_property_float_funcs(prop, NULL, "rna_CurveMapping_black_level_set", NULL);
482
483         prop = RNA_def_property(srna, "white_level", PROP_FLOAT, PROP_COLOR);
484         RNA_def_property_float_sdna(prop, NULL, "white");
485         RNA_def_property_range(prop, -1000.0f, 1000.0f);
486         RNA_def_property_ui_text(prop, "White Level", "For RGB curves, the color that white is mapped to");
487         RNA_def_property_float_funcs(prop, NULL, "rna_CurveMapping_white_level_set", NULL);
488
489         func = RNA_def_function(srna, "update", "curvemapping_changed_all");
490         RNA_def_function_ui_description(func, "Update curve mapping after making changes");
491 }
492
493 static void rna_def_color_ramp_element(BlenderRNA *brna)
494 {
495         StructRNA *srna;
496         PropertyRNA *prop;
497
498         srna = RNA_def_struct(brna, "ColorRampElement", NULL);
499         RNA_def_struct_sdna(srna, "CBData");
500         RNA_def_struct_path_func(srna, "rna_ColorRampElement_path");
501         RNA_def_struct_ui_text(srna, "Color Ramp Element", "Element defining a color at a position in the color ramp");
502         
503         prop = RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
504         RNA_def_property_float_sdna(prop, NULL, "r");
505         RNA_def_property_array(prop, 4);
506         RNA_def_property_ui_text(prop, "Color", "Set color of selected color stop");
507         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
508         
509         prop = RNA_def_property(srna, "position", PROP_FLOAT, PROP_NONE);
510         RNA_def_property_float_sdna(prop, NULL, "pos");
511         RNA_def_property_range(prop, 0, 1);
512         RNA_def_property_ui_text(prop, "Position", "Set position of selected color stop");
513         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
514 }
515
516 static void rna_def_color_ramp_element_api(BlenderRNA *brna, PropertyRNA *cprop)
517 {
518         StructRNA *srna;
519         PropertyRNA *parm;
520         FunctionRNA *func;
521
522         RNA_def_property_srna(cprop, "ColorRampElements");
523         srna = RNA_def_struct(brna, "ColorRampElements", NULL);
524         RNA_def_struct_sdna(srna, "ColorBand");
525         RNA_def_struct_path_func(srna, "rna_ColorRampElement_path");
526         RNA_def_struct_ui_text(srna, "Color Ramp Elements", "Collection of Color Ramp Elements");
527
528         /* TODO, make these functions generic in texture.c */
529         func = RNA_def_function(srna, "new", "rna_ColorRampElement_new");
530         RNA_def_function_ui_description(func, "Add element to ColorRamp");
531         RNA_def_function_flag(func, FUNC_USE_REPORTS);
532         parm = RNA_def_float(func, "position", 0.0f, 0.0f, 1.0f, "Position", "Position to add element", 0.0f, 1.0f);
533         RNA_def_property_flag(parm, PROP_REQUIRED);
534         /* return type */
535         parm = RNA_def_pointer(func, "element", "ColorRampElement", "", "New element");
536         RNA_def_function_return(func, parm);
537
538         func = RNA_def_function(srna, "remove", "rna_ColorRampElement_remove");
539         RNA_def_function_ui_description(func, "Delete element from ColorRamp");
540         RNA_def_function_flag(func, FUNC_USE_REPORTS);
541         parm = RNA_def_pointer(func, "element", "ColorRampElement", "", "Element to remove");
542         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
543 }
544
545 static void rna_def_color_ramp(BlenderRNA *brna)
546 {
547         StructRNA *srna;
548         PropertyRNA *prop;
549         FunctionRNA *func;
550
551         static EnumPropertyItem prop_interpolation_items[] = {
552                 {1, "EASE", 0, "Ease", ""},
553                 {3, "CARDINAL", 0, "Cardinal", ""},
554                 {0, "LINEAR", 0, "Linear", ""},
555                 {2, "B_SPLINE", 0, "B-Spline", ""},
556                 {4, "CONSTANT", 0, "Constant", ""},
557                 {0, NULL, 0, NULL, NULL}
558         };
559         
560         srna = RNA_def_struct(brna, "ColorRamp", NULL);
561         RNA_def_struct_sdna(srna, "ColorBand");
562         RNA_def_struct_path_func(srna, "rna_ColorRamp_path");
563         RNA_def_struct_ui_text(srna, "Color Ramp", "Color ramp mapping a scalar value to a color");
564         
565         prop = RNA_def_property(srna, "elements", PROP_COLLECTION, PROP_COLOR);
566         RNA_def_property_collection_sdna(prop, NULL, "data", "tot");
567         RNA_def_property_struct_type(prop, "ColorRampElement");
568         RNA_def_property_ui_text(prop, "Elements", "");
569         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
570         rna_def_color_ramp_element_api(brna, prop);
571
572         prop = RNA_def_property(srna, "interpolation", PROP_ENUM, PROP_NONE);
573         RNA_def_property_enum_sdna(prop, NULL, "ipotype");
574         RNA_def_property_enum_items(prop, prop_interpolation_items);
575         RNA_def_property_ui_text(prop, "Interpolation", "");
576         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
577
578 #if 0 /* use len(elements) */
579         prop = RNA_def_property(srna, "total", PROP_INT, PROP_NONE);
580         RNA_def_property_int_sdna(prop, NULL, "tot");
581         /* needs a function to do the right thing when adding elements like colorband_add_cb() */
582         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
583         RNA_def_property_range(prop, 0, 31); /* MAXCOLORBAND = 32 */
584         RNA_def_property_ui_text(prop, "Total", "Total number of elements");
585         RNA_def_property_update(prop, 0, "rna_ColorRamp_update");
586 #endif
587         
588         func = RNA_def_function(srna, "evaluate", "rna_ColorRamp_eval");
589         RNA_def_function_ui_description(func, "Evaluate ColorRamp");
590         prop = RNA_def_float(func, "position", 1.0f, 0.0f, 1.0f, "Position", "Evaluate ColorRamp at position", 0.0f, 1.0f);
591         RNA_def_property_flag(prop, PROP_REQUIRED);
592         /* return */
593         prop = RNA_def_float_color(func, "color", 4, NULL, -FLT_MAX, FLT_MAX, "Color", "Color at given position",
594                                    -FLT_MAX, FLT_MAX);
595         RNA_def_property_flag(prop, PROP_THICK_WRAP);
596         RNA_def_function_output(func, prop);
597 }
598
599 static void rna_def_histogram(BlenderRNA *brna)
600 {
601         StructRNA *srna;
602         PropertyRNA *prop;
603         
604         static EnumPropertyItem prop_mode_items[] = {
605                 {HISTO_MODE_LUMA, "LUMA", 0, "Luma", "Luma"},
606                 {HISTO_MODE_RGB, "RGB", 0, "RGB", "Red Green Blue"},
607                 {HISTO_MODE_R, "R", 0, "R", "Red"},
608                 {HISTO_MODE_G, "G", 0, "G", "Green"},
609                 {HISTO_MODE_B, "B", 0, "B", "Blue"},
610                 {HISTO_MODE_ALPHA, "A", 0, "A", "Alpha"},
611                 {0, NULL, 0, NULL, NULL}
612         };
613
614         srna = RNA_def_struct(brna, "Histogram", NULL);
615         RNA_def_struct_ui_text(srna, "Histogram", "Statistical view of the levels of color in an image");
616         
617         prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
618         RNA_def_property_enum_sdna(prop, NULL, "mode");
619         RNA_def_property_enum_items(prop, prop_mode_items);
620         RNA_def_property_ui_text(prop, "Mode", "Channels to display when drawing the histogram");
621
622         prop = RNA_def_property(srna, "show_line", PROP_BOOLEAN, PROP_NONE);
623         RNA_def_property_boolean_sdna(prop, NULL, "flag", HISTO_FLAG_LINE);
624         RNA_def_property_ui_text(prop, "Show Line", "Display lines rather then filled shapes");
625         RNA_def_property_ui_icon(prop, ICON_IPO, 0);
626 }
627
628 static void rna_def_scopes(BlenderRNA *brna)
629 {
630         StructRNA *srna;
631         PropertyRNA *prop;
632
633         static EnumPropertyItem prop_wavefrm_mode_items[] = {
634                 {SCOPES_WAVEFRM_LUMA, "LUMA", ICON_COLOR, "Luma", ""},
635                 {SCOPES_WAVEFRM_RGB, "RGB", ICON_COLOR, "Red Green Blue", ""},
636                 {SCOPES_WAVEFRM_YCC_601, "YCBCR601", ICON_COLOR, "YCbCr (ITU 601)", ""},
637                 {SCOPES_WAVEFRM_YCC_709, "YCBCR709", ICON_COLOR, "YCbCr (ITU 709)", ""},
638                 {SCOPES_WAVEFRM_YCC_JPEG, "YCBCRJPG", ICON_COLOR, "YCbCr (Jpeg)", ""},
639                 {0, NULL, 0, NULL, NULL}
640         };
641
642         srna = RNA_def_struct(brna, "Scopes", NULL);
643         RNA_def_struct_ui_text(srna, "Scopes", "Scopes for statistical view of an image");
644         
645         prop = RNA_def_property(srna, "use_full_resolution", PROP_BOOLEAN, PROP_NONE);
646         RNA_def_property_boolean_sdna(prop, "Scopes", "sample_full", 1);
647         RNA_def_property_ui_text(prop, "Full Sample", "Sample every pixel of the image");
648         RNA_def_property_update(prop, 0, "rna_Scopes_update");
649         
650         prop = RNA_def_property(srna, "accuracy", PROP_FLOAT, PROP_PERCENTAGE);
651         RNA_def_property_float_sdna(prop, "Scopes", "accuracy");
652         RNA_def_property_range(prop, 0.0, 100.0);
653         RNA_def_property_ui_range(prop, 0.0, 100.0, 10, 1);
654         RNA_def_property_ui_text(prop, "Accuracy", "Proportion of original image source pixel lines to sample");
655         RNA_def_property_update(prop, 0, "rna_Scopes_update");
656
657         prop = RNA_def_property(srna, "histogram", PROP_POINTER, PROP_NONE);
658         RNA_def_property_pointer_sdna(prop, "Scopes", "hist");
659         RNA_def_property_struct_type(prop, "Histogram");
660         RNA_def_property_ui_text(prop, "Histogram", "Histogram for viewing image statistics");
661
662         prop = RNA_def_property(srna, "waveform_mode", PROP_ENUM, PROP_NONE);
663         RNA_def_property_enum_sdna(prop, "Scopes", "wavefrm_mode");
664         RNA_def_property_enum_items(prop, prop_wavefrm_mode_items);
665         RNA_def_property_ui_text(prop, "Waveform Mode", "");
666         RNA_def_property_update(prop, 0, "rna_Scopes_update");
667
668         prop = RNA_def_property(srna, "waveform_alpha", PROP_FLOAT, PROP_FACTOR);
669         RNA_def_property_float_sdna(prop, "Scopes", "wavefrm_alpha");
670         RNA_def_property_range(prop, 0, 1);
671         RNA_def_property_ui_text(prop, "Waveform Opacity", "Opacity of the points");
672
673         prop = RNA_def_property(srna, "vectorscope_alpha", PROP_FLOAT, PROP_FACTOR);
674         RNA_def_property_float_sdna(prop, "Scopes", "vecscope_alpha");
675         RNA_def_property_range(prop, 0, 1);
676         RNA_def_property_ui_text(prop, "Vectorscope Opacity", "Opacity of the points");
677 }
678
679
680 void RNA_def_color(BlenderRNA *brna)
681 {
682         rna_def_curvemappoint(brna);
683         rna_def_curvemap(brna);
684         rna_def_curvemapping(brna);
685         rna_def_color_ramp_element(brna);
686         rna_def_color_ramp(brna);
687         rna_def_histogram(brna);
688         rna_def_scopes(brna);
689 }
690
691 #endif