RNA
[blender.git] / source / blender / makesrna / intern / rna_lamp.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  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_lamp_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 #else
37
38 void RNA_def_lamp(BlenderRNA *brna)
39 {
40         StructRNA *srna;
41         PropertyRNA *prop;
42         static EnumPropertyItem prop_type_items[] = {
43                 {LA_LOCAL, "LOCAL", "Local", ""},
44                 {LA_SUN, "SUN", "Sun", ""},
45                 {LA_SPOT, "SPOT", "Spot", ""},
46                 {LA_HEMI, "HEMI", "Hemi", ""},
47                 {LA_AREA, "AREA", "Area", ""},
48                 {0, NULL, NULL, NULL}};
49         static EnumPropertyItem prop_shadow_items[] = {
50                 {0, "NOSHADOW", "No Shadow", ""},
51                 {LA_SHAD_BUF, "BUFSHADOW", "Buffer Shadow", "Lets spotlight produce shadows using shadow buffer."},
52                 {LA_SHAD_RAY, "RAYSHADOW", "Ray Shadow", "Use ray tracing for shadow."},
53                 {0, NULL, NULL, NULL}};
54         static EnumPropertyItem prop_raysampmethod_items[] = {
55                 {LA_SAMP_CONSTANT, "CONSTANT", "Constant", ""},
56                 {LA_SAMP_HALTON, "HALTON", "Halton", ""},
57                 {LA_SHAD_RAY, "LA_SAMP_HAMMERSLEY", "Hammersley", ""},
58                 {0, NULL, NULL, NULL}};
59         static EnumPropertyItem prop_areashape_items[] = {
60                 {LA_AREA_SQUARE, "SQUARE", "Square", ""},
61                 {LA_AREA_RECT, "RECTANGLE", "Rectangle", ""},
62                 {0, NULL, NULL, NULL}};
63         static EnumPropertyItem prop_shadbuftype_items[] = {
64                 {LA_SHADBUF_REGULAR     , "REGULAR", "Classical", "Use the Classic Buffer type"},
65                 {LA_SHADBUF_IRREGULAR, "IRREGULAR", "Irregular", "Use the Irregular Shadow Buffer type."},
66                 {LA_SHADBUF_HALFWAY, "HALFWAY", "Classic-Halfway", "Use the Classic-Halfway Buffer type."},
67                 {0, NULL, NULL, NULL}};
68         static EnumPropertyItem prop_shadbuffiltertype_items[] = {
69                 {LA_SHADBUF_BOX , "BOX", "Box", "Use the Box filter"},
70                 {LA_SHADBUF_TENT, "TENT", "Tent", "Use the Tent Filter."},
71                 {LA_SHADBUF_GAUSS, "GAUSS", "Gauss", "Use the Gauss filter."},
72                 {0, NULL, NULL, NULL}};
73         static EnumPropertyItem prop_numbuffer_items[] = {
74                 {1, "1BUFF", "1", "Sample 1 Shadow Buffer."},
75                 {4, "4BUFF", "4", "Sample 4 Shadow Buffers."},
76                 {9, "9BUFF", "9", "Sample 9 Shadow Buffers."},
77                 {0, NULL, NULL, NULL}};
78         static EnumPropertyItem prop_skycolorspace_items[] = {
79                 {0, "SMPTE", "SMPTE", ""},
80                 {1, "REC709", "REC709", ""},
81                 {2, "CIE", "CIE", ""},
82                 {0, NULL, NULL, NULL}};
83         static EnumPropertyItem prop_blendmode_items[] = {
84                 {0, "MIX", "Mix", ""},
85                 {1, "ADD", "Add", ""},
86                 {2, "MULTIPLY", "Multiply", ""},
87                 {3, "SUBTRACT", "Subtract", ""},
88                 {4, "SCREEN", "Screen", ""},
89                 {5, "DIVIDE", "Divide", ""},
90                 {6, "DIFFERENCE", "Difference", ""},
91                 {7, "DARKEN", "Darken", ""},
92                 {8, "LIGHTEN", "Lighten", ""},
93                 {9, "OVERLAY", "Overlay", ""},
94                 {10, "DODGE", "Dodge", ""},
95                 {11, "BURN", "Burn", ""},
96                 {12, "HUE", "Hue", ""},
97                 {13, "SATURATION", "Satruation", ""},
98                 {14, "VALUE", "Value", ""},
99                 {15, "COLOR", "Color", ""},
100                 {0, NULL, NULL, NULL}};
101         static EnumPropertyItem prop_fallofftype_items[] = {
102                 {LA_FALLOFF_CONSTANT, "CONSTANT", "Constant", ""},
103                 {LA_FALLOFF_INVLINEAR, "INVLINEAR", "Invert Linear", ""},
104                 {LA_FALLOFF_INVSQUARE, "INVSQUARE", "Invert Square", ""},
105                 {LA_FALLOFF_CURVE, "CURVE", "Custum Curve", ""},
106                 {LA_FALLOFF_SLIDERS, "SLIDERS", "Lin/Quad Weighted", ""},
107                 {0, NULL, NULL, NULL}};
108
109         srna= RNA_def_struct(brna, "Lamp", "ID", "Lamp");
110
111         /* Enums */
112         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
113         RNA_def_property_enum_items(prop, prop_type_items);
114         RNA_def_property_ui_text(prop, "Type", "Type of Lamp.");
115
116         prop= RNA_def_property(srna, "sky_colorspace", PROP_ENUM, PROP_NONE);
117         RNA_def_property_enum_items(prop, prop_skycolorspace_items);
118         RNA_def_property_ui_text(prop, "Sky Color Space", "");
119
120         prop= RNA_def_property(srna, "sky_blend_type", PROP_ENUM, PROP_NONE);
121         RNA_def_property_enum_sdna(prop, NULL, "skyblendtype", 0);
122         RNA_def_property_enum_items(prop, prop_blendmode_items);
123         RNA_def_property_ui_text(prop, "Sky Blend Type", "Blend type for how sky is combined with world sky");
124
125         prop= RNA_def_property(srna, "area_shape", PROP_ENUM, PROP_NONE);
126         RNA_def_property_enum_items(prop, prop_areashape_items);
127         RNA_def_property_ui_text(prop, "Area Shape", "Shape of the Area lamp");
128
129         prop= RNA_def_property(srna, "ray_samp_method", PROP_ENUM, PROP_NONE);
130         RNA_def_property_enum_items(prop, prop_raysampmethod_items);
131         RNA_def_property_ui_text(prop, "Ray Sample Method", "The Method in how rays are sampled");
132
133         prop= RNA_def_property(srna, "buffer_type", PROP_ENUM, PROP_NONE);
134         RNA_def_property_enum_sdna(prop, NULL, "buftype", 0);
135         RNA_def_property_enum_items(prop, prop_shadbuftype_items);
136         RNA_def_property_ui_text(prop, "Buffer Type", "Type of Shadow Buffer.");
137
138         prop= RNA_def_property(srna, "filter_type", PROP_ENUM, PROP_NONE);
139         RNA_def_property_enum_sdna(prop, NULL, "filtertype", 0);
140         RNA_def_property_enum_items(prop, prop_shadbuffiltertype_items);
141         RNA_def_property_ui_text(prop, "Filter Type", "Type of Shadow Buffer Filter.");
142
143         prop= RNA_def_property(srna, "buffers", PROP_ENUM, PROP_NONE);
144         RNA_def_property_enum_items(prop, prop_numbuffer_items);
145         RNA_def_property_ui_text(prop, "Sample Buffers", "Number of Buffers to sample.");
146
147         prop= RNA_def_property(srna, "falloff_type", PROP_ENUM, PROP_NONE);
148         RNA_def_property_enum_items(prop, prop_fallofftype_items);
149         RNA_def_property_ui_text(prop, "Falloff Type", "Intensity Decay with distance.");
150
151         prop= RNA_def_property(srna, "falloff_curve", PROP_POINTER, PROP_NONE);
152         RNA_def_property_pointer_sdna(prop, NULL, "curfalloff");
153         RNA_def_property_struct_type(prop, "CurveMapping");
154         RNA_def_property_ui_text(prop, "Falloff Curve", "Custum Lamp Falloff Curve");
155
156         /* Number values */
157         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
158         RNA_def_property_float_sdna(prop, NULL, "dist");
159         RNA_def_property_range(prop, 0.0f, 9999.0f);
160         RNA_def_property_ui_text(prop, "Distance", "Distance that the lamp emits light.");
161
162         prop= RNA_def_property(srna, "linear_attenuation", PROP_FLOAT, PROP_NONE);
163         RNA_def_property_float_sdna(prop, NULL, "att1");
164         RNA_def_property_range(prop, 0.0f, 1.0f);
165         RNA_def_property_ui_text(prop, "Linear Attenuation", "Linear distance attentuation.");
166
167         prop= RNA_def_property(srna, "quadratic_attenuation", PROP_FLOAT, PROP_NONE);
168         RNA_def_property_float_sdna(prop, NULL, "att2");
169         RNA_def_property_range(prop, 0.0f, 1.0f);
170         RNA_def_property_ui_text(prop, "Quadratic Attenuation", "Quadratic distance attentuation.");
171
172         prop= RNA_def_property(srna, "spot_blend", PROP_FLOAT, PROP_NONE);
173         RNA_def_property_float_sdna(prop, NULL, "spotblend");
174         RNA_def_property_range(prop, 0.0f ,1.0f);
175         RNA_def_property_ui_text(prop, "Spot Blend", "The softeness of the spotlight edge.");
176
177         prop= RNA_def_property(srna, "spot_size", PROP_FLOAT, PROP_NONE);
178         RNA_def_property_float_sdna(prop, NULL, "spotsize");
179         RNA_def_property_range(prop, 1.0f ,180.0f);
180         RNA_def_property_ui_text(prop, "Spot Size", "The angle of the spotlight beam in degrees.");
181
182         prop= RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_NONE);
183         RNA_def_property_float_sdna(prop, NULL, "clipsta");
184         RNA_def_property_range(prop, 0.0f, 9999.0f);
185         RNA_def_property_ui_text(prop, "Clip Start", "Distance that the buffer calculations start.");
186
187         prop= RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_NONE);
188         RNA_def_property_float_sdna(prop, NULL, "clipend");
189         RNA_def_property_range(prop, 0.0f, 9999.0f);
190         RNA_def_property_ui_text(prop, "Clip End", "Distance that the buffer calculations finish.");
191
192         prop= RNA_def_property(srna, "bias", PROP_FLOAT, PROP_NONE);
193         RNA_def_property_range(prop, 0.0f, 5.0f);
194         RNA_def_property_ui_text(prop, "Bias", "Shadow Map sampling bias.");
195
196         prop= RNA_def_property(srna, "soft", PROP_FLOAT, PROP_NONE);
197         RNA_def_property_range(prop, 0.0f, 100.0f);
198         RNA_def_property_ui_text(prop, "Soft", "Size of shadow sampling area.");
199
200         prop= RNA_def_property(srna, "samples", PROP_INT, PROP_NONE);
201         RNA_def_property_int_sdna(prop, NULL, "samp");
202         RNA_def_property_range(prop, 1,16);
203         RNA_def_property_ui_text(prop, "Samples", "Number of shadow map samples.");
204
205         prop= RNA_def_property(srna, "energy", PROP_FLOAT, PROP_NONE);
206         RNA_def_property_range(prop, 0.0f, 10.0f);
207         RNA_def_property_ui_text(prop, "Energy", "Amount of light that the lamp emits.");
208
209         prop= RNA_def_property(srna, "ray_samples", PROP_INT, PROP_NONE);
210         RNA_def_property_int_sdna(prop, NULL, "ray_samp");
211         RNA_def_property_range(prop, 1, 16);
212         RNA_def_property_ui_text(prop, "Ray Samples", "Amount of smaples taken extra (samples x samples).");
213
214         prop= RNA_def_property(srna, "ray_sampy", PROP_INT, PROP_NONE);
215         RNA_def_property_range(prop, 1,16);
216         RNA_def_property_ui_text(prop, "Ray Samples Y", "Amount of smaples taken extra (samples x samples).");
217
218         prop= RNA_def_property(srna, "area_size", PROP_FLOAT, PROP_NONE);
219         RNA_def_property_range(prop, 0.0f, 100.0f);
220         RNA_def_property_ui_text(prop, "Area Size", "Size of the area of the Area Lamp.");
221
222         prop= RNA_def_property(srna, "area_sizey", PROP_FLOAT, PROP_NONE);
223         RNA_def_property_range(prop, 0.0f, 100.0f);
224         RNA_def_property_ui_text(prop, "Area Size Y", "Size of the area of the Area Lamp.");
225
226         prop= RNA_def_property(srna, "adapt_thresh", PROP_FLOAT, PROP_NONE);
227         RNA_def_property_range(prop, 0.0f, 1.0f);
228         RNA_def_property_ui_text(prop, "Adapt Threshold", "Threshold for Adaptive Sampleing.");
229
230         prop= RNA_def_property(srna, "buffer_size", PROP_INT, PROP_NONE);
231         RNA_def_property_int_sdna(prop, NULL, "bufsize");
232         RNA_def_property_range(prop, 512, 10240);
233         RNA_def_property_ui_text(prop, "Buffer Size", "The Size in Bytes of the Shadow Buffer");
234
235         prop= RNA_def_property(srna, "halo_intensity", PROP_FLOAT, PROP_NONE);
236         RNA_def_property_float_sdna(prop, NULL, "bufsize");
237         RNA_def_property_range(prop, 0.0f, 5.0f);
238         RNA_def_property_ui_text(prop, "Halo Intensity", "Intesity of Spot Halo");
239
240         prop= RNA_def_property(srna, "horizon_brightness", PROP_FLOAT, PROP_NONE);
241         RNA_def_property_range(prop, 0.0f,20.0f);
242         RNA_def_property_ui_text(prop, "Hor. Bright", "horizon brightness");
243
244         prop= RNA_def_property(srna, "spread", PROP_FLOAT, PROP_NONE);
245         RNA_def_property_range(prop, 0.0f,10.0f);
246         RNA_def_property_ui_text(prop, "Hor. Spread", "horizon Spread");
247
248         prop= RNA_def_property(srna, "sun_brightness", PROP_FLOAT, PROP_NONE);
249         RNA_def_property_range(prop, 0.0f,10.0f);
250         RNA_def_property_ui_text(prop, "Sun Bright", "Sun Brightness");
251
252         prop= RNA_def_property(srna, "sun_size", PROP_FLOAT, PROP_NONE);
253         RNA_def_property_range(prop, 0.0f,10.0f);
254         RNA_def_property_ui_text(prop, "Sun Size", "Sun Size");
255
256         prop= RNA_def_property(srna, "backscattered_light", PROP_FLOAT, PROP_NONE);
257         RNA_def_property_range(prop, 0.0f,1.0f);
258         RNA_def_property_ui_text(prop, "Back Light", "Backscatter Light");
259
260         prop= RNA_def_property(srna, "sun_intensity", PROP_FLOAT, PROP_NONE);
261         RNA_def_property_range(prop, 0.0f,10.0f);
262         RNA_def_property_ui_text(prop, "Sun Intens", "Sun Intensity");
263
264         prop= RNA_def_property(srna, "atm_turbidity", PROP_FLOAT, PROP_NONE);
265         RNA_def_property_range(prop, 0.0f,30.0f);
266         RNA_def_property_ui_text(prop, "Turbidity", "Sky Tubidity");
267
268         prop= RNA_def_property(srna, "atm_inscattering_factor", PROP_FLOAT, PROP_NONE);
269         RNA_def_property_range(prop, 0.0f,1.0f);
270         RNA_def_property_ui_text(prop, "Inscatter", "Scatter Contibution factor");
271
272         prop= RNA_def_property(srna, "atm_extinction_factor", PROP_FLOAT, PROP_NONE);
273         RNA_def_property_range(prop, 0.0f,1.0f);
274         RNA_def_property_ui_text(prop, "Extinction", "Extinction Scattering Contibution factor");
275
276         prop= RNA_def_property(srna, "atm_distance_factor", PROP_FLOAT, PROP_NONE);
277         RNA_def_property_range(prop, 0.0f,500.0f);
278         RNA_def_property_ui_text(prop, "Atmos Distance", "Scale blender distance to real distance");
279
280         prop= RNA_def_property(srna, "sky_blend_factor", PROP_FLOAT, PROP_NONE);
281         RNA_def_property_float_sdna(prop, NULL, "skyblendfac");
282         RNA_def_property_range(prop, 0.0f,2.0f);
283         RNA_def_property_ui_text(prop, "Sky Blend Factor", "Blend factor with sky");
284
285         prop= RNA_def_property(srna, "sky_exposure", PROP_FLOAT, PROP_NONE);
286         RNA_def_property_range(prop, 0.0f,20.0f);
287         RNA_def_property_ui_text(prop, "Sky Exposure", "Expsure Correction");
288
289
290         /*short sky_colorspace, pad4;*/
291
292         /* Colors */
293         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
294         RNA_def_property_float_sdna(prop, NULL, "r");
295         RNA_def_property_array(prop, 3);
296         RNA_def_property_ui_text(prop, "Color", "");
297         RNA_def_property_ui_range(prop, 0.0f, 1.0f, 10.0f, 3.0f);
298
299         prop= RNA_def_property(srna, "shadow_color", PROP_FLOAT, PROP_COLOR);
300         RNA_def_property_float_sdna(prop, NULL, "shdwr");
301         RNA_def_property_array(prop, 3);
302         RNA_def_property_ui_text(prop, "Shadow Color", "");
303         RNA_def_property_ui_range(prop, 0.0f, 1.0f, 10.0f, 3.0f);
304
305         /* Booleans */
306         prop= RNA_def_property(srna, "auto_clip_start", PROP_BOOLEAN, PROP_NONE);
307         RNA_def_property_boolean_sdna(prop, NULL, "bufflag", LA_SHADBUF_AUTO_START);
308         RNA_def_property_ui_text(prop, "Autoclip Start", "Automatically Sets Clip start to the nearest pixel.");
309
310         prop= RNA_def_property(srna, "auto_clip_end", PROP_BOOLEAN, PROP_NONE);
311         RNA_def_property_boolean_sdna(prop, NULL, "bufflag", LA_SHADBUF_AUTO_END);
312         RNA_def_property_ui_text(prop, "Autoclip End", "Automatically Sets Clip start to the furthurest away pixel.");
313
314         prop= RNA_def_property(srna, "umbra", PROP_BOOLEAN, PROP_NONE);
315         RNA_def_property_boolean_sdna(prop, NULL, "ray_samp_type", LA_SAMP_UMBRA);
316         RNA_def_property_ui_text(prop, "Umbra", "Emphersise parts in full shadow.");
317
318         prop= RNA_def_property(srna, "dither", PROP_BOOLEAN, PROP_NONE);
319         RNA_def_property_boolean_sdna(prop, NULL, "ray_samp_type", LA_SAMP_DITHER);
320         RNA_def_property_ui_text(prop, "Dither", "Use 2x2 dithering for sampling.");
321
322         prop= RNA_def_property(srna, "jitter", PROP_BOOLEAN, PROP_NONE);
323         RNA_def_property_boolean_sdna(prop, NULL, "ray_samp_type", LA_SAMP_JITTER);
324         RNA_def_property_ui_text(prop, "Jitter", "Use noise for sampling.");
325
326         prop= RNA_def_property(srna, "sky", PROP_BOOLEAN, PROP_NONE);
327         RNA_def_property_boolean_sdna(prop, NULL, "sun_effect_type", LA_SUN_EFFECT_SKY);
328         RNA_def_property_ui_text(prop, "sky", "Apply sun effect on sky");
329
330         prop= RNA_def_property(srna, "atmosphere", PROP_BOOLEAN, PROP_NONE);
331         RNA_def_property_boolean_sdna(prop, NULL, "sun_effect_type", LA_SUN_EFFECT_AP);
332         RNA_def_property_ui_text(prop, "Atmosphere", "Apply sun effect on Atmosphere");
333
334         /* mode */
335         prop= RNA_def_property(srna, "halo", PROP_BOOLEAN, PROP_NONE);
336         RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_HALO);
337         RNA_def_property_ui_text(prop, "Halo", "Lamp creates a halo.");
338
339         prop= RNA_def_property(srna, "layer", PROP_BOOLEAN, PROP_NONE);
340         RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_LAYER);
341         RNA_def_property_ui_text(prop, "Layer", "Lamp is only used on the Scene layer the lamp is on.");
342
343         prop= RNA_def_property(srna, "negative", PROP_BOOLEAN, PROP_NONE);
344         RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_NEG);
345         RNA_def_property_ui_text(prop, "Negative", "Lamp casts negative light.");
346
347         prop= RNA_def_property(srna, "no_specular", PROP_BOOLEAN, PROP_NONE);
348         RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_NO_SPEC);
349         RNA_def_property_ui_text(prop, "No Specular", "Lamp does not create specular higlights.");
350
351         prop= RNA_def_property(srna, "no_diffuse", PROP_BOOLEAN, PROP_NONE);
352         RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_NO_DIFF);
353         RNA_def_property_ui_text(prop, "No Diffuse", "Lamp does not create diffuse shading.");
354
355         prop= RNA_def_property(srna, "only_shadow", PROP_BOOLEAN, PROP_NONE);
356         RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_ONLYSHADOW);
357         RNA_def_property_ui_text(prop, "Only Shadow", "Lamp only creates shadows.");
358
359         prop= RNA_def_property(srna, "shadow", PROP_ENUM, PROP_NONE);
360         RNA_def_property_enum_sdna(prop, NULL, "mode", PROP_DEF_ENUM_BITFLAGS);
361         RNA_def_property_enum_items(prop, prop_shadow_items);
362         RNA_def_property_ui_text(prop, "Shadow", "Method to compute lamp shadow.");
363
364         prop= RNA_def_property(srna, "sphere", PROP_BOOLEAN, PROP_NONE);
365         RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_SPHERE);
366         RNA_def_property_ui_text(prop, "Sphere", "Sets square spotbundles.");
367
368         prop= RNA_def_property(srna, "square", PROP_BOOLEAN, PROP_NONE);
369         RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_SQUARE);
370         RNA_def_property_ui_text(prop, "Square", "Sets light intensity to zero beyond lamp distance.");
371 }
372
373 #endif
374