Cleanup: style, whitespace, doxy filepaths
[blender-staging.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_ID.h"
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 struct Object;
44 struct AnimData;
45 struct Ipo;
46
47 /* ------------------------------------------- */
48 /* Stereo Settings */
49 typedef struct CameraStereoSettings {
50         float interocular_distance;
51         float convergence_distance;
52         short convergence_mode;
53         short pivot;
54         short flag;
55         short pad;
56         /* Cut-off angle at which interocular distance start to fade down. */
57         float pole_merge_angle_from;
58         /* Cut-off angle at which interocular distance stops to fade down. */
59         float pole_merge_angle_to;
60 } CameraStereoSettings;
61
62 typedef struct Camera {
63         ID id;
64         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
65         
66         char type; /* CAM_PERSP, CAM_ORTHO or CAM_PANO */
67         char dtx; /* draw type extra */
68         short flag;
69         float passepartalpha;
70         float clipsta, clipend;
71         float lens, ortho_scale, drawsize;
72         float sensor_x, sensor_y;
73         float shiftx, shifty;
74
75         /* yafray: dof params */
76         /* qdn: yafray var 'YF_dofdist' now enabled for defocus composite node as well.
77          * The name was not changed so that no other files need to be modified */
78         float YF_dofdist;
79
80         struct Ipo *ipo  DNA_DEPRECATED; /* old animation system, deprecated for 2.5 */
81         
82         struct Object *dof_ob;
83         struct GPUDOFSettings gpu_dof;
84
85         char sensor_fit;
86         char pad[7];
87
88         /* Stereo settings */
89         struct CameraStereoSettings stereo;
90 } Camera;
91
92 /* **************** CAMERA ********************* */
93
94 /* type */
95 enum {
96         CAM_PERSP       = 0,
97         CAM_ORTHO       = 1,
98         CAM_PANO        = 2,
99 };
100
101 /* dtx */
102 enum {
103         CAM_DTX_CENTER          = (1 << 0),
104         CAM_DTX_CENTER_DIAG     = (1 << 1),
105         CAM_DTX_THIRDS          = (1 << 2),
106         CAM_DTX_GOLDEN          = (1 << 3),
107         CAM_DTX_GOLDEN_TRI_A    = (1 << 4),
108         CAM_DTX_GOLDEN_TRI_B    = (1 << 5),
109         CAM_DTX_HARMONY_TRI_A   = (1 << 6),
110         CAM_DTX_HARMONY_TRI_B   = (1 << 7),
111 };
112
113 /* flag */
114 enum {
115         CAM_SHOWLIMITS          = (1 << 0),
116         CAM_SHOWMIST            = (1 << 1),
117         CAM_SHOWPASSEPARTOUT    = (1 << 2),
118         CAM_SHOW_SAFE_MARGINS       = (1 << 3),
119         CAM_SHOWNAME            = (1 << 4),
120         CAM_ANGLETOGGLE         = (1 << 5),
121         CAM_DS_EXPAND           = (1 << 6),
122 #ifdef DNA_DEPRECATED
123         CAM_PANORAMA            = (1 << 7), /* deprecated */
124 #endif
125         CAM_SHOWSENSOR          = (1 << 8),
126         CAM_SHOW_SAFE_CENTER    = (1 << 9),
127 };
128
129 /* yafray: dof sampling switch */
130 /* #define CAM_YF_NO_QMC        512 */ /* deprecated */
131
132 /* Sensor fit */
133 enum {
134         CAMERA_SENSOR_FIT_AUTO  = 0,
135         CAMERA_SENSOR_FIT_HOR   = 1,
136         CAMERA_SENSOR_FIT_VERT  = 2,
137 };
138
139 #define DEFAULT_SENSOR_WIDTH    32.0f
140 #define DEFAULT_SENSOR_HEIGHT   18.0f
141
142 /* stereo->convergence_mode */
143 enum {
144         CAM_S3D_OFFAXIS    = 0,
145         CAM_S3D_PARALLEL   = 1,
146         CAM_S3D_TOE        = 2,
147 };
148
149 /* stereo->pivot */
150 enum {
151         CAM_S3D_PIVOT_LEFT      = 0,
152         CAM_S3D_PIVOT_RIGHT     = 1,
153         CAM_S3D_PIVOT_CENTER    = 2,
154 };
155
156 /* stereo->flag */
157 enum {
158         CAM_S3D_SPHERICAL       = (1 << 0),
159         CAM_S3D_POLE_MERGE      = (1 << 1),
160 };
161
162 #ifdef __cplusplus
163 }
164 #endif
165
166 #endif