RNA
[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 #ifdef RNA_RUNTIME
35
36 #else
37
38 void RNA_def_camera(BlenderRNA *brna)
39 {
40         StructRNA *srna;
41         PropertyRNA *prop;
42         static EnumPropertyItem prop_type_items[] = {
43                 {CAM_PERSP, "PERSP", "Perspective", ""},
44                 {CAM_ORTHO, "ORTHO", "Orthographic", ""},
45                 {0, NULL, NULL, NULL}};
46
47         srna= RNA_def_struct(brna, "Camera", "ID", "Camera");
48
49         /* Enums */
50         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
51         RNA_def_property_enum_items(prop, prop_type_items);
52         RNA_def_property_ui_text(prop, "Type", "Camera types.");
53
54         /* Number values */
55
56         prop= RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_NONE);
57         RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
58         RNA_def_property_range(prop, 0.0f, 1.0f);
59         RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the passepartout area in Camera view.");
60
61         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_NONE);
62         RNA_def_property_float_sdna(prop, NULL, "angle");
63         RNA_def_property_range(prop, 0.0f, 100.0f);
64         RNA_def_property_ui_text(prop, "Angle", "Perspective Camera lens value in degrees.");
65
66         prop= RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_NONE);
67         RNA_def_property_float_sdna(prop, NULL, "clipsta");
68         RNA_def_property_range(prop, 0.0f, 100.0f);
69         RNA_def_property_ui_text(prop, "Clip Start", "Camera clipping start.");
70
71         prop= RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_NONE);
72         RNA_def_property_float_sdna(prop, NULL, "clipend");
73         RNA_def_property_range(prop, 1.0f, 5000.0f);
74         RNA_def_property_ui_text(prop, "Clip End", "Camera clipping end.");
75
76         prop= RNA_def_property(srna, "lens", PROP_FLOAT, PROP_NONE);
77         RNA_def_property_float_sdna(prop, NULL, "lens");
78         RNA_def_property_range(prop, 1.0f, 250.0f);
79         RNA_def_property_ui_text(prop, "Lens", "Perspective Camera lens value in mm.");
80
81         prop= RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
82         RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
83         RNA_def_property_range(prop, 0.01f, 1000.0f);
84         RNA_def_property_ui_text(prop, "Orthographic Scale", "Ortographic Camera scale.");
85
86         prop= RNA_def_property(srna, "draw_size", PROP_FLOAT, PROP_NONE);
87         RNA_def_property_float_sdna(prop, NULL, "drawsize");
88         RNA_def_property_range(prop, 0.1f, 10.0f);
89         RNA_def_property_ui_text(prop, "Draw Size", "Apparent size of the Camera object in the 3D View.");
90
91         prop= RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
92         RNA_def_property_float_sdna(prop, NULL, "shiftx");
93         RNA_def_property_range(prop, -2.0f, 2.0f);
94         RNA_def_property_ui_text(prop, "Shift X", "Perspective Camera horizontal shift.");
95
96         prop= RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
97         RNA_def_property_float_sdna(prop, NULL, "shifty");
98         RNA_def_property_range(prop, -2.0f, 2.0f);
99         RNA_def_property_ui_text(prop, "Shift Y", "Perspective Camera vertical shift.");
100
101         prop= RNA_def_property(srna, "dof_distance", PROP_FLOAT, PROP_NONE);
102         RNA_def_property_float_sdna(prop, NULL, "YF_dofdist");
103         RNA_def_property_range(prop, 0.0f, 5000.0f);
104         RNA_def_property_ui_text(prop, "DOF Distance", "Depth of field distance.");
105
106         /* flag */
107         prop= RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
108         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
109         RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focal point in Camera view.");
110
111         prop= RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
112         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
113         RNA_def_property_ui_text(prop, "Show Mist", "Draw a line from the Camera to indicate the mist area.");
114
115         prop= RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
116         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
117         RNA_def_property_ui_text(prop, "Show Passepartout", "Enable passepartout mode in Camera view.");
118
119         prop= RNA_def_property(srna, "show_title_safe", PROP_BOOLEAN, PROP_NONE);
120         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWTITLESAFE);
121         RNA_def_property_ui_text(prop, "Show Title Safe", "Draw a title safe zone in Camera view.");
122
123         prop= RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
124         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
125         RNA_def_property_ui_text(prop, "Show Name", "Draw the active Camera's name in Camera view.");
126
127         prop= RNA_def_property(srna, "use_degrees", PROP_BOOLEAN, PROP_NONE);
128         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_ANGLETOGGLE);
129         RNA_def_property_ui_text(prop, "Use Degrees", "Use degrees instead of mm as the unit of the Camera lens.");
130
131         /* Pointers */
132
133         prop= RNA_def_property(srna, "ipo", PROP_POINTER, PROP_NONE);
134         RNA_def_property_struct_type(prop, "Ipo");
135         RNA_def_property_ui_text(prop, "Ipo Curve", "");
136
137         prop= RNA_def_property(srna, "dof_object", PROP_POINTER, PROP_NONE);
138         RNA_def_property_struct_type(prop, "Object");
139         RNA_def_property_pointer_sdna(prop, NULL, "dof_ob");
140         RNA_def_property_ui_text(prop, "DOF Object", "Use this object to define depth of field focal point.");
141 }
142
143 #endif
144