svn merge -r 30566:30717 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / blender / makesrna / intern / rna_camera.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  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28
29 #include "rna_internal.h"
30
31 #include "DNA_camera_types.h"
32
33 #include "BLI_math.h"
34
35 #include "WM_types.h"
36
37 #ifdef RNA_RUNTIME
38
39 #include "BKE_object.h"
40
41 /* only for rad/deg conversion! can remove later */
42 static float rna_Camera_angle_get(PointerRNA *ptr)
43 {
44         Camera *cam= ptr->id.data;
45
46         return lens_to_angle(cam->lens);
47 }
48
49 static void rna_Camera_angle_set(PointerRNA *ptr, float value)
50 {
51         Camera *cam= ptr->id.data;
52         cam->lens= angle_to_lens(value);
53 }
54
55 #else
56
57 void RNA_def_camera(BlenderRNA *brna)
58 {
59         StructRNA *srna;
60         PropertyRNA *prop;
61         static EnumPropertyItem prop_type_items[] = {
62                 {CAM_PERSP, "PERSP", 0, "Perspective", ""},
63                 {CAM_ORTHO, "ORTHO", 0, "Orthographic", ""},
64                 {0, NULL, 0, NULL, NULL}};
65         static EnumPropertyItem prop_lens_unit_items[] = {
66                 {0, "MILLIMETERS", 0, "Millimeters", ""},
67                 {CAM_ANGLETOGGLE, "DEGREES", 0, "Degrees", ""},
68                 {0, NULL, 0, NULL, NULL}};
69
70         srna= RNA_def_struct(brna, "Camera", "ID");
71         RNA_def_struct_ui_text(srna, "Camera", "Camera datablock for storing camera settings");
72         RNA_def_struct_ui_icon(srna, ICON_CAMERA_DATA);
73
74         /* Enums */
75         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
76         RNA_def_property_enum_items(prop, prop_type_items);
77         RNA_def_property_ui_text(prop, "Type", "Camera types");
78         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
79         
80         /* Number values */
81
82         prop= RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_FACTOR);
83         RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
84         RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view");
85         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
86
87         prop= RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_DISTANCE);
88         RNA_def_property_float_sdna(prop, NULL, "clipsta");
89         RNA_def_property_range(prop, 0.0f, FLT_MAX);
90         RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance");
91         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
92
93         prop= RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_DISTANCE);
94         RNA_def_property_float_sdna(prop, NULL, "clipend");
95         RNA_def_property_range(prop, 1.0f, FLT_MAX);
96         RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance");
97         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
98
99         prop= RNA_def_property(srna, "lens", PROP_FLOAT, PROP_NONE);
100         RNA_def_property_float_sdna(prop, NULL, "lens");
101         RNA_def_property_range(prop, 1.0f, 5000.0f);
102         RNA_def_property_ui_text(prop, "Lens", "Perspective Camera lens value in millimeters");
103         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
104         
105         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_ANGLE);
106         RNA_def_property_range(prop, M_PI * (0.367/180.0), M_PI * (172.847/180.0));
107         RNA_def_property_ui_text(prop, "Angle", "Perspective Camera lens field of view in degrees");
108         RNA_def_property_float_funcs(prop, "rna_Camera_angle_get", "rna_Camera_angle_set", NULL); /* only for deg/rad conversion */
109         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
110
111         prop= RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
112         RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
113         RNA_def_property_range(prop, 0.01f, 1000.0f);
114         RNA_def_property_ui_text(prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom)");
115         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
116
117         prop= RNA_def_property(srna, "draw_size", PROP_FLOAT, PROP_DISTANCE);
118         RNA_def_property_float_sdna(prop, NULL, "drawsize");
119         RNA_def_property_range(prop, 0.1f, 1000.0f);
120         RNA_def_property_ui_range(prop, 0.01, 100, 1, 1);
121         RNA_def_property_ui_text(prop, "Draw Size", "Apparent size of the Camera object in the 3D View");
122         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
123
124         prop= RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
125         RNA_def_property_float_sdna(prop, NULL, "shiftx");
126         RNA_def_property_range(prop, -10.0f, 10.0f);
127         RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
128         RNA_def_property_ui_text(prop, "Shift X", "Perspective Camera horizontal shift");
129         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
130
131         prop= RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
132         RNA_def_property_float_sdna(prop, NULL, "shifty");
133         RNA_def_property_range(prop, -10.0f, 10.0f);
134         RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
135         RNA_def_property_ui_text(prop, "Shift Y", "Perspective Camera vertical shift");
136         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
137
138         prop= RNA_def_property(srna, "dof_distance", PROP_FLOAT, PROP_DISTANCE);
139         RNA_def_property_float_sdna(prop, NULL, "YF_dofdist");
140         RNA_def_property_range(prop, 0.0f, 5000.0f);
141         RNA_def_property_ui_text(prop, "DOF Distance", "Distance to the focus point for depth of field");
142         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
143
144         /* flag */
145         prop= RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
146         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
147         RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focus point on the camera");
148         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
149
150         prop= RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
151         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
152         RNA_def_property_ui_text(prop, "Show Mist", "Draw a line from the Camera to indicate the mist area");
153         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
154
155         prop= RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
156         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
157         RNA_def_property_ui_text(prop, "Show Passepartout", "Show a darkened overlay outside the image area in Camera view");
158         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
159
160         prop= RNA_def_property(srna, "show_title_safe", PROP_BOOLEAN, PROP_NONE);
161         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWTITLESAFE);
162         RNA_def_property_ui_text(prop, "Show Title Safe", "Show indicators for the title safe zone in Camera view");
163         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
164
165         prop= RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
166         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
167         RNA_def_property_ui_text(prop, "Show Name", "Show the active Camera's name in Camera view");
168         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
169
170         prop= RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
171         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
172         RNA_def_property_enum_items(prop, prop_lens_unit_items);
173         RNA_def_property_ui_text(prop, "Lens Unit", "Unit to edit lens in for the user interface");
174
175         prop= RNA_def_property(srna, "panorama", PROP_BOOLEAN, PROP_NONE);
176         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_PANORAMA);
177         RNA_def_property_ui_text(prop, "Panorama", "Render the scene with a cylindrical camera for pseudo-fisheye lens effects");
178         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
179
180         /* pointers */
181         rna_def_animdata_common(srna);
182
183         prop= RNA_def_property(srna, "dof_object", PROP_POINTER, PROP_NONE);
184         RNA_def_property_struct_type(prop, "Object");
185         RNA_def_property_pointer_sdna(prop, NULL, "dof_ob");
186         RNA_def_property_flag(prop, PROP_EDITABLE);
187         RNA_def_property_ui_text(prop, "DOF Object", "Use this object to define the depth of field focal point");
188         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
189 }
190
191 #endif
192