path: root/source/blender/makesrna/intern/rna_lamp.c

/**
 * $Id$
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Contributor(s): Blender Foundation (2008).
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <stdlib.h>

#include "RNA_define.h"
#include "RNA_types.h"

#include "rna_internal.h"

#include "DNA_lamp_types.h"

#ifdef RNA_RUNTIME

static void rna_Lamp_buffer_size_set(PointerRNA *ptr, int value)
{
	Lamp *la= (Lamp*)ptr->data;

	CLAMP(value, 512, 10240);
	la->bufsize= value;
	la->bufsize &= (~15); /* round to multiple of 16 */
}


#else

void RNA_def_lamp(BlenderRNA *brna)
{
	StructRNA *srna;
	PropertyRNA *prop;
	static EnumPropertyItem prop_type_items[] = {
		{LA_LOCAL, "LOCAL", "Local", ""},
		{LA_SUN, "SUN", "Sun", ""},
		{LA_SPOT, "SPOT", "Spot", ""},
		{LA_HEMI, "HEMI", "Hemi", ""},
		{LA_AREA, "AREA", "Area", ""},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_shadow_items[] = {
		{0, "NOSHADOW", "No Shadow", ""},
		{LA_SHAD_BUF, "BUFSHADOW", "Buffer Shadow", "Lets spotlight produce shadows using shadow buffer."},
		{LA_SHAD_RAY, "RAYSHADOW", "Ray Shadow", "Use ray tracing for shadow."},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_raysampmethod_items[] = {
		{LA_SAMP_CONSTANT, "CONSTANT", "Constant", ""},
		{LA_SAMP_HALTON, "HALTON", "Halton", ""},
		{LA_SHAD_RAY, "LA_SAMP_HAMMERSLEY", "Hammersley", ""},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_areashape_items[] = {
		{LA_AREA_SQUARE, "SQUARE", "Square", ""},
		{LA_AREA_RECT, "RECTANGLE", "Rectangle", ""},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_shadbuftype_items[] = {
		{LA_SHADBUF_REGULAR	, "REGULAR", "Classical", "Use the Classic Buffer type"},
		{LA_SHADBUF_IRREGULAR, "IRREGULAR", "Irregular", "Use the Irregular Shadow Buffer type."},
		{LA_SHADBUF_HALFWAY, "HALFWAY", "Classic-Halfway", "Use the Classic-Halfway Buffer type."},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_shadbuffiltertype_items[] = {
		{LA_SHADBUF_BOX	, "BOX", "Box", "Use the Box filter"},
		{LA_SHADBUF_TENT, "TENT", "Tent", "Use the Tent Filter."},
		{LA_SHADBUF_GAUSS, "GAUSS", "Gauss", "Use the Gauss filter."},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_numbuffer_items[] = {
		{1, "1BUFF", "1", "Sample 1 Shadow Buffer."},
		{4, "4BUFF", "4", "Sample 4 Shadow Buffers."},
		{9, "9BUFF", "9", "Sample 9 Shadow Buffers."},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_skycolorspace_items[] = {
		{0, "SMPTE", "SMPTE", ""},
		{1, "REC709", "REC709", ""},
		{2, "CIE", "CIE", ""},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_blendmode_items[] = {
		{0, "MIX", "Mix", ""},
		{1, "ADD", "Add", ""},
		{2, "MULTIPLY", "Multiply", ""},
		{3, "SUBTRACT", "Subtract", ""},
		{4, "SCREEN", "Screen", ""},
		{5, "DIVIDE", "Divide", ""},
		{6, "DIFFERENCE", "Difference", ""},
		{7, "DARKEN", "Darken", ""},
		{8, "LIGHTEN", "Lighten", ""},
		{9, "OVERLAY", "Overlay", ""},
		{10, "DODGE", "Dodge", ""},
		{11, "BURN", "Burn", ""},
		{12, "HUE", "Hue", ""},
		{13, "SATURATION", "Saturation", ""},
		{14, "VALUE", "Value", ""},
		{15, "COLOR", "Color", ""},
		{0, NULL, NULL, NULL}};
	static EnumPropertyItem prop_fallofftype_items[] = {
		{LA_FALLOFF_CONSTANT, "CONSTANT", "Constant", ""},
		{LA_FALLOFF_INVLINEAR, "INVLINEAR", "Inverse Linear", ""},
		{LA_FALLOFF_INVSQUARE, "INVSQUARE", "Inverse Square", ""},
		{LA_FALLOFF_CURVE, "CURVE", "Custom Curve", ""},
		{LA_FALLOFF_SLIDERS, "SLIDERS", "Lin/Quad Weighted", ""},
		{0, NULL, NULL, NULL}};

	srna= RNA_def_struct(brna, "Lamp", "ID", "Lamp");

	/* Enums */
	prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_items(prop, prop_type_items);
	RNA_def_property_ui_text(prop, "Type", "Type of Lamp.");

	prop= RNA_def_property(srna, "sky_colorspace", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_items(prop, prop_skycolorspace_items);
	RNA_def_property_ui_text(prop, "Sky Color Space", "");

	prop= RNA_def_property(srna, "sky_blend_type", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_sdna(prop, NULL, "skyblendtype");
	RNA_def_property_enum_items(prop, prop_blendmode_items);
	RNA_def_property_ui_text(prop, "Sky Blend Type", "Blend type for how sky is combined with world sky");

	prop= RNA_def_property(srna, "area_shape", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_items(prop, prop_areashape_items);
	RNA_def_property_ui_text(prop, "Area Shape", "Shape of the Area lamp");

	prop= RNA_def_property(srna, "ray_samp_method", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_items(prop, prop_raysampmethod_items);
	RNA_def_property_ui_text(prop, "Ray Sample Method", "The Method in how rays are sampled");

	prop= RNA_def_property(srna, "buffer_type", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_sdna(prop, NULL, "buftype");
	RNA_def_property_enum_items(prop, prop_shadbuftype_items);
	RNA_def_property_ui_text(prop, "Buffer Type", "Type of Shadow Buffer.");

	prop= RNA_def_property(srna, "filter_type", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_sdna(prop, NULL, "filtertype");
	RNA_def_property_enum_items(prop, prop_shadbuffiltertype_items);
	RNA_def_property_ui_text(prop, "Filter Type", "Type of Shadow Buffer Filter.");

	prop= RNA_def_property(srna, "buffers", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_items(prop, prop_numbuffer_items);
	RNA_def_property_ui_text(prop, "Sample Buffers", "Number of Buffers to sample.");

	prop= RNA_def_property(srna, "falloff_type", PROP_ENUM, PROP_NONE);
	RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* needs to be able to create curve mapping */
	RNA_def_property_enum_items(prop, prop_fallofftype_items);
	RNA_def_property_ui_text(prop, "Falloff Type", "Intensity Decay with distance.");

	prop= RNA_def_property(srna, "falloff_curve", PROP_POINTER, PROP_NONE);
	RNA_def_property_pointer_sdna(prop, NULL, "curfalloff");
	RNA_def_property_ui_text(prop, "Falloff Curve", "Custom Lamp Falloff Curve");

	/* Number values */
	prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "dist");
	RNA_def_property_range(prop, 0.0f, 9999.0f);
	RNA_def_property_ui_text(prop, "Distance", "Distance that the lamp emits light.");

	prop= RNA_def_property(srna, "linear_attenuation", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "att1");
	RNA_def_property_range(prop, 0.0f, 1.0f);
	RNA_def_property_ui_text(prop, "Linear Attenuation", "Linear distance attentuation.");

	prop= RNA_def_property(srna, "quadratic_attenuation", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "att2");
	RNA_def_property_range(prop, 0.0f, 1.0f);
	RNA_def_property_ui_text(prop, "Quadratic Attenuation", "Quadratic distance attentuation.");

	prop= RNA_def_property(srna, "spot_blend", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "spotblend");
	RNA_def_property_range(prop, 0.0f ,1.0f);
	RNA_def_property_ui_text(prop, "Spot Blend", "The softeness of the spotlight edge.");

	prop= RNA_def_property(srna, "spot_size", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "spotsize");
	RNA_def_property_range(prop, 1.0f ,180.0f);
	RNA_def_property_ui_text(prop, "Spot Size", "The angle of the spotlight beam in degrees.");

	prop= RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "clipsta");
	RNA_def_property_range(prop, 0.0f, 9999.0f);
	RNA_def_property_ui_text(prop, "Clip Start", "Distance that the buffer calculations start.");

	prop= RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "clipend");
	RNA_def_property_range(prop, 0.0f, 9999.0f);
	RNA_def_property_ui_text(prop, "Clip End", "Distance that the buffer calculations finish.");

	prop= RNA_def_property(srna, "bias", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 5.0f);
	RNA_def_property_ui_text(prop, "Bias", "Shadow Map sampling bias.");

	prop= RNA_def_property(srna, "soft", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 100.0f);
	RNA_def_property_ui_text(prop, "Soft", "Size of shadow sampling area.");

	prop= RNA_def_property(srna, "samples", PROP_INT, PROP_NONE);
	RNA_def_property_int_sdna(prop, NULL, "samp");
	RNA_def_property_range(prop, 1,16);
	RNA_def_property_ui_text(prop, "Samples", "Number of shadow map samples.");

	prop= RNA_def_property(srna, "energy", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 10.0f);
	RNA_def_property_ui_text(prop, "Energy", "Amount of light that the lamp emits.");

	prop= RNA_def_property(srna, "ray_samples", PROP_INT, PROP_NONE);
	RNA_def_property_int_sdna(prop, NULL, "ray_samp");
	RNA_def_property_range(prop, 1, 16);
	RNA_def_property_ui_text(prop, "Ray Samples", "Amount of samples taken extra (samples x samples).");

	prop= RNA_def_property(srna, "ray_sampy", PROP_INT, PROP_NONE);
	RNA_def_property_range(prop, 1,16);
	RNA_def_property_ui_text(prop, "Ray Samples Y", "Amount of samples taken extra (samples x samples).");

	prop= RNA_def_property(srna, "area_size", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 100.0f);
	RNA_def_property_ui_text(prop, "Area Size", "Size of the area of the Area Lamp.");

	prop= RNA_def_property(srna, "area_sizey", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 100.0f);
	RNA_def_property_ui_text(prop, "Area Size Y", "Size of the area of the Area Lamp.");

	prop= RNA_def_property(srna, "adapt_thresh", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 1.0f);
	RNA_def_property_ui_text(prop, "Adapt Threshold", "Threshold for Adaptive Sampling.");

	prop= RNA_def_property(srna, "buffer_size", PROP_INT, PROP_NONE);
	RNA_def_property_int_sdna(prop, NULL, "bufsize");
	RNA_def_property_range(prop, 512, 10240);
	RNA_def_property_ui_text(prop, "Buffer Size", "Sets the size of the shadow buffer to nearest multiple of 16");
	RNA_def_property_int_funcs(prop, NULL, "rna_Lamp_buffer_size_set", NULL);

	prop= RNA_def_property(srna, "halo_intensity", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "haint");
	RNA_def_property_range(prop, 0.0f, 5.0f);
	RNA_def_property_ui_text(prop, "Halo Intensity", "Intensity of Spot Halo");

	prop= RNA_def_property(srna, "horizon_brightness", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 20.0f);
	RNA_def_property_ui_text(prop, "Hor. Bright", "horizon brightness");

	prop= RNA_def_property(srna, "spread", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 10.0f);
	RNA_def_property_ui_text(prop, "Hor. Spread", "horizon Spread");

	prop= RNA_def_property(srna, "sun_brightness", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 10.0f);
	RNA_def_property_ui_text(prop, "Sun Bright", "Sun Brightness");

	prop= RNA_def_property(srna, "sun_size", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 10.0f);
	RNA_def_property_ui_text(prop, "Sun Size", "Sun Size");

  	prop= RNA_def_property(srna, "backscattered_light", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 1.0f);
	RNA_def_property_ui_text(prop, "Back Light", "Backscatter Light");

	prop= RNA_def_property(srna, "sun_intensity", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 10.0f);
	RNA_def_property_ui_text(prop, "Sun Intens", "Sun Intensity");

	prop= RNA_def_property(srna, "atm_turbidity", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 30.0f);
	RNA_def_property_ui_text(prop, "Turbidity", "Sky Tubidity");

	prop= RNA_def_property(srna, "atm_inscattering_factor", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 1.0f);
	RNA_def_property_ui_text(prop, "Inscatter", "Scatter contribution factor");

	prop= RNA_def_property(srna, "atm_extinction_factor", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 1.0f);
	RNA_def_property_ui_text(prop, "Extinction", "Extinction scattering contribution factor");

	prop= RNA_def_property(srna, "atm_distance_factor", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 500.0f);
	RNA_def_property_ui_text(prop, "Atmos Distance", "Scale blender distance to real distance");

	prop= RNA_def_property(srna, "sky_blend_factor", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "skyblendfac");
	RNA_def_property_range(prop, 0.0f, 2.0f);
	RNA_def_property_ui_text(prop, "Sky Blend Factor", "Blend factor with sky");

	prop= RNA_def_property(srna, "sky_exposure", PROP_FLOAT, PROP_NONE);
	RNA_def_property_range(prop, 0.0f, 20.0f);
	RNA_def_property_ui_text(prop, "Sky Exposure", "Exposure correction");


	/*short sky_colorspace, pad4;*/

	/* Colors */
	prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
	RNA_def_property_float_sdna(prop, NULL, "r");
	RNA_def_property_array(prop, 3);
	RNA_def_property_ui_text(prop, "Color", "");
	RNA_def_property_ui_range(prop, 0.0f, 1.0f, 10.0f, 3.0f);

	prop= RNA_def_property(srna, "shadow_color", PROP_FLOAT, PROP_COLOR);
	RNA_def_property_float_sdna(prop, NULL, "shdwr");
	RNA_def_property_array(prop, 3);
	RNA_def_property_ui_text(prop, "Shadow Color", "");
	RNA_def_property_ui_range(prop, 0.0f, 1.0f, 10.0f, 3.0f);

	/* Booleans */
	prop= RNA_def_property(srna, "auto_clip_start", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "bufflag", LA_SHADBUF_AUTO_START);
	RNA_def_property_ui_text(prop, "Autoclip Start", "Automatically Sets Clip start to the nearest pixel.");

	prop= RNA_def_property(srna, "auto_clip_end", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "bufflag", LA_SHADBUF_AUTO_END);
	RNA_def_property_ui_text(prop, "Autoclip End", "Automatically Sets Clip end to the farthest away pixel.");

	prop= RNA_def_property(srna, "umbra", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "ray_samp_type", LA_SAMP_UMBRA);
	RNA_def_property_ui_text(prop, "Umbra", "Emphasise parts in full shadow.");

	prop= RNA_def_property(srna, "dither", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "ray_samp_type", LA_SAMP_DITHER);
	RNA_def_property_ui_text(prop, "Dither", "Use 2x2 dithering for sampling.");

	prop= RNA_def_property(srna, "jitter", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "ray_samp_type", LA_SAMP_JITTER);
	RNA_def_property_ui_text(prop, "Jitter", "Use noise for sampling.");

	prop= RNA_def_property(srna, "sky", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "sun_effect_type", LA_SUN_EFFECT_SKY);
	RNA_def_property_ui_text(prop, "sky", "Apply sun effect on sky");

	prop= RNA_def_property(srna, "atmosphere", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "sun_effect_type", LA_SUN_EFFECT_AP);
	RNA_def_property_ui_text(prop, "Atmosphere", "Apply sun effect on Atmosphere");

	/* mode */
	prop= RNA_def_property(srna, "halo", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_HALO);
	RNA_def_property_ui_text(prop, "Halo", "Lamp creates a halo.");

	prop= RNA_def_property(srna, "layer", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_LAYER);
	RNA_def_property_ui_text(prop, "Layer", "Lamp is only used on the Scene layer the lamp is on.");

	prop= RNA_def_property(srna, "negative", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_NEG);
	RNA_def_property_ui_text(prop, "Negative", "Lamp casts negative light.");

	prop= RNA_def_property(srna, "specular", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_negative_sdna(prop, NULL, "mode", LA_NO_SPEC);
	RNA_def_property_ui_text(prop, "Specular", "Lamp creates specular highlights.");

	prop= RNA_def_property(srna, "diffuse", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_negative_sdna(prop, NULL, "mode", LA_NO_DIFF);
	RNA_def_property_ui_text(prop, "Diffuse", "Lamp does diffuse shading.");

	prop= RNA_def_property(srna, "only_shadow", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_ONLYSHADOW);
	RNA_def_property_ui_text(prop, "Only Shadow", "Lamp only creates shadows.");

	prop= RNA_def_property(srna, "shadow", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_bitflag_sdna(prop, NULL, "mode");
	RNA_def_property_enum_items(prop, prop_shadow_items);
	RNA_def_property_ui_text(prop, "Shadow", "Method to compute lamp shadow.");

	prop= RNA_def_property(srna, "sphere", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_SPHERE);
	RNA_def_property_ui_text(prop, "Sphere", "Sets square spotbundles.");

	prop= RNA_def_property(srna, "square", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "mode", LA_SQUARE);
	RNA_def_property_ui_text(prop, "Square", "Sets light intensity to zero beyond lamp distance.");
}

#endif