41b8872a6d1c4124f4b1d1123a95bb06e18f583a
[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., 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_camera_types.h"
33
34 #include "WM_types.h"
35
36 #ifdef RNA_RUNTIME
37
38 #else
39
40 void RNA_def_camera(BlenderRNA *brna)
41 {
42         StructRNA *srna;
43         PropertyRNA *prop;
44         static EnumPropertyItem prop_type_items[] = {
45                 {CAM_PERSP, "PERSP", "Perspective", ""},
46                 {CAM_ORTHO, "ORTHO", "Orthographic", ""},
47                 {0, NULL, NULL, NULL}};
48         static EnumPropertyItem prop_lens_unit_items[] = {
49                 {0, "MILLIMETERS", "Millimeters", ""},
50                 {CAM_ANGLETOGGLE, "DEGREES", "Degrees", ""},
51                 {0, NULL, NULL, NULL}};
52
53         srna= RNA_def_struct(brna, "Camera", "ID");
54         RNA_def_struct_ui_text(srna, "Camera", "'Object' data where camera settings are stored and animated");
55
56         /* Enums */
57         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
58         RNA_def_property_enum_items(prop, prop_type_items);
59         RNA_def_property_ui_text(prop, "Type", "Camera types.");
60
61         /* Number values */
62
63         prop= RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_NONE);
64         RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
65         RNA_def_property_range(prop, 0.0f, 1.0f);
66         RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view.");
67         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
68
69         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_NONE);
70         RNA_def_property_float_sdna(prop, NULL, "angle");
71         RNA_def_property_range(prop, 0.0f, 100.0f);
72         RNA_def_property_ui_text(prop, "Angle", "Perspective Camera lend field of view in degrees.");
73         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
74
75         prop= RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_NONE);
76         RNA_def_property_float_sdna(prop, NULL, "clipsta");
77         RNA_def_property_range(prop, 0.0f, 100.0f);
78         RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance.");
79         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
80
81         prop= RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_NONE);
82         RNA_def_property_float_sdna(prop, NULL, "clipend");
83         RNA_def_property_range(prop, 1.0f, 5000.0f);
84         RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance.");
85         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
86
87         prop= RNA_def_property(srna, "lens", PROP_FLOAT, PROP_NONE);
88         RNA_def_property_float_sdna(prop, NULL, "lens");
89         RNA_def_property_range(prop, 1.0f, 250.0f);
90         RNA_def_property_ui_text(prop, "Lens", "Perspective Camera lens value in mm.");
91         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
92
93         prop= RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
94         RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
95         RNA_def_property_range(prop, 0.01f, 1000.0f);
96         RNA_def_property_ui_text(prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom).");
97         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
98
99         prop= RNA_def_property(srna, "draw_size", PROP_FLOAT, PROP_NONE);
100         RNA_def_property_float_sdna(prop, NULL, "drawsize");
101         RNA_def_property_range(prop, 0.1f, 10.0f);
102         RNA_def_property_ui_text(prop, "Draw Size", "Apparent size of the Camera object in the 3D View.");
103         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
104
105         prop= RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
106         RNA_def_property_float_sdna(prop, NULL, "shiftx");
107         RNA_def_property_range(prop, -2.0f, 2.0f);
108         RNA_def_property_ui_text(prop, "Shift X", "Perspective Camera horizontal shift.");
109         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
110
111         prop= RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
112         RNA_def_property_float_sdna(prop, NULL, "shifty");
113         RNA_def_property_range(prop, -2.0f, 2.0f);
114         RNA_def_property_ui_text(prop, "Shift Y", "Perspective Camera vertical shift.");
115         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
116
117         prop= RNA_def_property(srna, "dof_distance", PROP_FLOAT, PROP_NONE);
118         RNA_def_property_float_sdna(prop, NULL, "YF_dofdist");
119         RNA_def_property_range(prop, 0.0f, 5000.0f);
120         RNA_def_property_ui_text(prop, "DOF Distance", "Distance to the focus point for depth of field.");
121         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
122
123         /* flag */
124         prop= RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
125         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
126         RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focus point on the camera.");
127         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
128
129         prop= RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
130         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
131         RNA_def_property_ui_text(prop, "Show Mist", "Draw a line from the Camera to indicate the mist area.");
132         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
133
134         prop= RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
135         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
136         RNA_def_property_ui_text(prop, "Show Passepartout", "Show a darkened overlay outside the image area in Camera view.");
137         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
138
139         prop= RNA_def_property(srna, "show_title_safe", PROP_BOOLEAN, PROP_NONE);
140         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWTITLESAFE);
141         RNA_def_property_ui_text(prop, "Show Title Safe", "Show indicators for the title safe zone in Camera view.");
142         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
143
144         prop= RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
145         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
146         RNA_def_property_ui_text(prop, "Show Name", "Show the active Camera's name in Camera view.");
147         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
148
149         prop= RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
150         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
151         RNA_def_property_enum_items(prop, prop_lens_unit_items);
152         RNA_def_property_ui_text(prop, "Lens Unit", "Unit to edit lens in for the user interface.");
153
154         /* pointers */
155         rna_def_ipo_common(srna);
156
157         prop= RNA_def_property(srna, "dof_object", PROP_POINTER, PROP_NONE);
158         RNA_def_property_struct_type(prop, "Object");
159         RNA_def_property_pointer_sdna(prop, NULL, "dof_ob");
160         RNA_def_property_ui_text(prop, "DOF Object", "Use this object to define the depth of field focal point.");
161         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
162 }
163
164 #endif
165