Merge branch 'blender2.7'
[blender.git] / source / blender / makesdna / DNA_camera_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_camera_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_CAMERA_TYPES_H__
33 #define __DNA_CAMERA_TYPES_H__
34
35 #include "DNA_defs.h"
36 #include "DNA_gpu_types.h"
37 #include "DNA_movieclip_types.h"
38 #include "DNA_image_types.h"
39 #include "DNA_ID.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 struct AnimData;
46 struct Ipo;
47 struct Object;
48
49 /* ------------------------------------------- */
50 /* Stereo Settings */
51 typedef struct CameraStereoSettings {
52         float interocular_distance;
53         float convergence_distance;
54         short convergence_mode;
55         short pivot;
56         short flag;
57         short pad;
58         /* Cut-off angle at which interocular distance start to fade down. */
59         float pole_merge_angle_from;
60         /* Cut-off angle at which interocular distance stops to fade down. */
61         float pole_merge_angle_to;
62 } CameraStereoSettings;
63
64 /* Background Picture */
65 typedef struct CameraBGImage {
66         struct CameraBGImage *next, *prev;
67
68         struct Image *ima;
69         struct ImageUser iuser;
70         struct MovieClip *clip;
71         struct MovieClipUser cuser;
72         float offset[2], scale, rotation;
73         float alpha;
74         short flag;
75         short source;
76 } CameraBGImage;
77
78 typedef struct Camera {
79         ID id;
80         /** Animation data (must be immediately after id for utilities to use it). */
81         struct AnimData *adt;
82
83         /** CAM_PERSP, CAM_ORTHO or CAM_PANO. */
84         char type;
85         /** Draw type extra. */
86         char dtx;
87         short flag;
88         float passepartalpha;
89         float clipsta, clipend;
90         float lens, ortho_scale, drawsize;
91         float sensor_x, sensor_y;
92         float shiftx, shifty;
93
94         /* yafray: dof params */
95         /* qdn: yafray var 'YF_dofdist' now enabled for defocus composite node as well.
96          * The name was not changed so that no other files need to be modified */
97         float YF_dofdist;
98
99         /** Old animation system, deprecated for 2.5. */
100         struct Ipo *ipo  DNA_DEPRECATED;
101
102         struct Object *dof_ob;
103         struct GPUDOFSettings gpu_dof;
104
105         /* CameraBGImage reference images */
106         struct ListBase bg_images;
107
108         char sensor_fit;
109         char pad[7];
110
111         /* runtime only, used for drawing */
112         float drwcorners[2][4][2];
113         float drwtria[2][2];
114         float drwdepth[2];
115         float drwfocusmat[4][4];
116         float drwnormalmat[4][4];
117
118         /* Stereo settings */
119         struct CameraStereoSettings stereo;
120 } Camera;
121
122 /* **************** CAMERA ********************* */
123
124 /* type */
125 enum {
126         CAM_PERSP       = 0,
127         CAM_ORTHO       = 1,
128         CAM_PANO        = 2,
129 };
130
131 /* dtx */
132 enum {
133         CAM_DTX_CENTER          = (1 << 0),
134         CAM_DTX_CENTER_DIAG     = (1 << 1),
135         CAM_DTX_THIRDS          = (1 << 2),
136         CAM_DTX_GOLDEN          = (1 << 3),
137         CAM_DTX_GOLDEN_TRI_A    = (1 << 4),
138         CAM_DTX_GOLDEN_TRI_B    = (1 << 5),
139         CAM_DTX_HARMONY_TRI_A   = (1 << 6),
140         CAM_DTX_HARMONY_TRI_B   = (1 << 7),
141 };
142
143 /* flag */
144 enum {
145         CAM_SHOWLIMITS          = (1 << 0),
146         CAM_SHOWMIST            = (1 << 1),
147         CAM_SHOWPASSEPARTOUT    = (1 << 2),
148         CAM_SHOW_SAFE_MARGINS       = (1 << 3),
149         CAM_SHOWNAME            = (1 << 4),
150         CAM_ANGLETOGGLE         = (1 << 5),
151         CAM_DS_EXPAND           = (1 << 6),
152 #ifdef DNA_DEPRECATED
153         CAM_PANORAMA            = (1 << 7), /* deprecated */
154 #endif
155         CAM_SHOWSENSOR          = (1 << 8),
156         CAM_SHOW_SAFE_CENTER    = (1 << 9),
157         CAM_SHOW_BG_IMAGE       = (1 << 10),
158 };
159
160 /* Sensor fit */
161 enum {
162         CAMERA_SENSOR_FIT_AUTO  = 0,
163         CAMERA_SENSOR_FIT_HOR   = 1,
164         CAMERA_SENSOR_FIT_VERT  = 2,
165 };
166
167 #define DEFAULT_SENSOR_WIDTH    36.0f
168 #define DEFAULT_SENSOR_HEIGHT   24.0f
169
170 /* stereo->convergence_mode */
171 enum {
172         CAM_S3D_OFFAXIS    = 0,
173         CAM_S3D_PARALLEL   = 1,
174         CAM_S3D_TOE        = 2,
175 };
176
177 /* stereo->pivot */
178 enum {
179         CAM_S3D_PIVOT_LEFT      = 0,
180         CAM_S3D_PIVOT_RIGHT     = 1,
181         CAM_S3D_PIVOT_CENTER    = 2,
182 };
183
184 /* stereo->flag */
185 enum {
186         CAM_S3D_SPHERICAL       = (1 << 0),
187         CAM_S3D_POLE_MERGE      = (1 << 1),
188 };
189
190 /* CameraBGImage->flag */
191 /* may want to use 1 for select ? */
192 enum {
193         CAM_BGIMG_FLAG_EXPANDED      = (1 << 1),
194         CAM_BGIMG_FLAG_CAMERACLIP    = (1 << 2),
195         CAM_BGIMG_FLAG_DISABLED      = (1 << 3),
196         CAM_BGIMG_FLAG_FOREGROUND    = (1 << 4),
197
198         /* Camera framing options */
199         CAM_BGIMG_FLAG_CAMERA_ASPECT = (1 << 5),  /* don't stretch to fit the camera view  */
200         CAM_BGIMG_FLAG_CAMERA_CROP   = (1 << 6),  /* crop out the image */
201
202         /* Axis flip options */
203         CAM_BGIMG_FLAG_FLIP_X        = (1 << 7),
204         CAM_BGIMG_FLAG_FLIP_Y        = (1 << 8),
205 };
206
207 #define CAM_BGIMG_FLAG_EXPANDED (CAM_BGIMG_FLAG_EXPANDED | CAM_BGIMG_FLAG_CAMERACLIP)
208
209 /* CameraBGImage->source */
210 /* may want to use 1 for select ?*/
211 enum {
212         CAM_BGIMG_SOURCE_IMAGE          = 0,
213         CAM_BGIMG_SOURCE_MOVIE          = 1,
214 };
215
216 #ifdef __cplusplus
217 }
218 #endif
219
220 #endif