Workbench: Cleaner Shadow edges own shadow
[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 Object;
46 struct AnimData;
47 struct Ipo;
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         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
81         
82         char type; /* CAM_PERSP, CAM_ORTHO or CAM_PANO */
83         char dtx; /* draw type extra */
84         short flag;
85         float passepartalpha;
86         float clipsta, clipend;
87         float lens, ortho_scale, drawsize;
88         float sensor_x, sensor_y;
89         float shiftx, shifty;
90
91         /* yafray: dof params */
92         /* qdn: yafray var 'YF_dofdist' now enabled for defocus composite node as well.
93          * The name was not changed so that no other files need to be modified */
94         float YF_dofdist;
95
96         struct Ipo *ipo  DNA_DEPRECATED; /* old animation system, deprecated for 2.5 */
97         
98         struct Object *dof_ob;
99         struct GPUDOFSettings gpu_dof;
100
101         /* CameraBGImage reference images */
102         struct ListBase bg_images;
103
104         char sensor_fit;
105         char pad[7];
106
107         /* runtime only, used for drawing */
108         float drwcorners[4][2];
109         float drwtria[2][2];
110         float drwdepth, pad1;
111         float drwfocusmat[4][4];
112         float drwnormalmat[4][4];
113
114         /* Stereo settings */
115         struct CameraStereoSettings stereo;
116 } Camera;
117
118 /* **************** CAMERA ********************* */
119
120 /* type */
121 enum {
122         CAM_PERSP       = 0,
123         CAM_ORTHO       = 1,
124         CAM_PANO        = 2,
125 };
126
127 /* dtx */
128 enum {
129         CAM_DTX_CENTER          = (1 << 0),
130         CAM_DTX_CENTER_DIAG     = (1 << 1),
131         CAM_DTX_THIRDS          = (1 << 2),
132         CAM_DTX_GOLDEN          = (1 << 3),
133         CAM_DTX_GOLDEN_TRI_A    = (1 << 4),
134         CAM_DTX_GOLDEN_TRI_B    = (1 << 5),
135         CAM_DTX_HARMONY_TRI_A   = (1 << 6),
136         CAM_DTX_HARMONY_TRI_B   = (1 << 7),
137 };
138
139 /* flag */
140 enum {
141         CAM_SHOWLIMITS          = (1 << 0),
142         CAM_SHOWMIST            = (1 << 1),
143         CAM_SHOWPASSEPARTOUT    = (1 << 2),
144         CAM_SHOW_SAFE_MARGINS       = (1 << 3),
145         CAM_SHOWNAME            = (1 << 4),
146         CAM_ANGLETOGGLE         = (1 << 5),
147         CAM_DS_EXPAND           = (1 << 6),
148 #ifdef DNA_DEPRECATED
149         CAM_PANORAMA            = (1 << 7), /* deprecated */
150 #endif
151         CAM_SHOWSENSOR          = (1 << 8),
152         CAM_SHOW_SAFE_CENTER    = (1 << 9),
153         CAM_SHOW_BG_IMAGE       = (1 << 10),
154 };
155
156 /* yafray: dof sampling switch */
157 /* #define CAM_YF_NO_QMC        512 */ /* deprecated */
158
159 /* Sensor fit */
160 enum {
161         CAMERA_SENSOR_FIT_AUTO  = 0,
162         CAMERA_SENSOR_FIT_HOR   = 1,
163         CAMERA_SENSOR_FIT_VERT  = 2,
164 };
165
166 #define DEFAULT_SENSOR_WIDTH    32.0f
167 #define DEFAULT_SENSOR_HEIGHT   18.0f
168
169 /* stereo->convergence_mode */
170 enum {
171         CAM_S3D_OFFAXIS    = 0,
172         CAM_S3D_PARALLEL   = 1,
173         CAM_S3D_TOE        = 2,
174 };
175
176 /* stereo->pivot */
177 enum {
178         CAM_S3D_PIVOT_LEFT      = 0,
179         CAM_S3D_PIVOT_RIGHT     = 1,
180         CAM_S3D_PIVOT_CENTER    = 2,
181 };
182
183 /* stereo->flag */
184 enum {
185         CAM_S3D_SPHERICAL       = (1 << 0),
186         CAM_S3D_POLE_MERGE      = (1 << 1),
187 };
188
189 /* CameraBGImage->flag */
190 /* may want to use 1 for select ? */
191 enum {
192         CAM_BGIMG_FLAG_EXPANDED      = (1 << 1),
193         CAM_BGIMG_FLAG_CAMERACLIP    = (1 << 2),
194         CAM_BGIMG_FLAG_DISABLED      = (1 << 3),
195         CAM_BGIMG_FLAG_FOREGROUND    = (1 << 4),
196
197         /* Camera framing options */
198         CAM_BGIMG_FLAG_CAMERA_ASPECT = (1 << 5),  /* don't stretch to fit the camera view  */
199         CAM_BGIMG_FLAG_CAMERA_CROP   = (1 << 6),  /* crop out the image */
200
201         /* Axis flip options */
202         CAM_BGIMG_FLAG_FLIP_X        = (1 << 7),
203         CAM_BGIMG_FLAG_FLIP_Y        = (1 << 8),
204 };
205
206 #define CAM_BGIMG_FLAG_EXPANDED (CAM_BGIMG_FLAG_EXPANDED | CAM_BGIMG_FLAG_CAMERACLIP)
207
208 /* CameraBGImage->source */
209 /* may want to use 1 for select ?*/
210 enum {
211         CAM_BGIMG_SOURCE_IMAGE          = 0,
212         CAM_BGIMG_SOURCE_MOVIE          = 1,
213 };
214
215 #ifdef __cplusplus
216 }
217 #endif
218
219 #endif