ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / BKE_camera.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_CAMERA_H__
21 #define __BKE_CAMERA_H__
22
23 /** \file
24  * \ingroup bke
25  * \brief Camera datablock and utility functions.
26  */
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #include "DNA_vec_types.h"
32
33 struct Camera;
34 struct Depsgraph;
35 struct GPUFXSettings;
36 struct Main;
37 struct Object;
38 struct RegionView3D;
39 struct RenderData;
40 struct Scene;
41 struct View3D;
42 struct ViewLayer;
43 struct rctf;
44
45 /* Camera Datablock */
46
47 void BKE_camera_init(struct Camera *cam);
48 void *BKE_camera_add(struct Main *bmain, const char *name);
49 void BKE_camera_copy_data(struct Main *bmain,
50                           struct Camera *cam_dst,
51                           const struct Camera *cam_src,
52                           const int flag);
53 struct Camera *BKE_camera_copy(struct Main *bmain, const struct Camera *cam);
54 void BKE_camera_make_local(struct Main *bmain, struct Camera *cam, const bool lib_local);
55 void BKE_camera_free(struct Camera *ca);
56
57 /* Camera Usage */
58
59 float BKE_camera_object_dof_distance(struct Object *ob);
60
61 int BKE_camera_sensor_fit(int sensor_fit, float sizex, float sizey);
62 float BKE_camera_sensor_size(int sensor_fit, float sensor_x, float sensor_y);
63
64 /* Camera Parameters:
65  *
66  * Intermediate struct for storing camera parameters from various sources,
67  * to unify computation of viewplane, window matrix, ... */
68
69 typedef struct CameraParams {
70   /* lens */
71   bool is_ortho;
72   float lens;
73   float ortho_scale;
74   float zoom;
75
76   float shiftx;
77   float shifty;
78   float offsetx;
79   float offsety;
80
81   /* sensor */
82   float sensor_x;
83   float sensor_y;
84   int sensor_fit;
85
86   /* clipping */
87   float clip_start;
88   float clip_end;
89
90   /* computed viewplane */
91   float ycor;
92   float viewdx;
93   float viewdy;
94   rctf viewplane;
95
96   /* computed matrix */
97   float winmat[4][4];
98 } CameraParams;
99
100 /* values for CameraParams.zoom, need to be taken into account for some operations */
101 #define CAMERA_PARAM_ZOOM_INIT_CAMOB 1.0f
102 #define CAMERA_PARAM_ZOOM_INIT_PERSP 2.0f
103
104 void BKE_camera_params_init(CameraParams *params);
105 void BKE_camera_params_from_object(CameraParams *params, const struct Object *camera);
106 void BKE_camera_params_from_view3d(CameraParams *params,
107                                    struct Depsgraph *depsgraph,
108                                    const struct View3D *v3d,
109                                    const struct RegionView3D *rv3d);
110
111 void BKE_camera_params_compute_viewplane(
112     CameraParams *params, int winx, int winy, float aspx, float aspy);
113 void BKE_camera_params_compute_matrix(CameraParams *params);
114
115 /* Camera View Frame */
116
117 void BKE_camera_view_frame_ex(const struct Scene *scene,
118                               const struct Camera *camera,
119                               const float drawsize,
120                               const bool do_clip,
121                               const float scale[3],
122                               float r_asp[2],
123                               float r_shift[2],
124                               float *r_drawsize,
125                               float r_vec[4][3]);
126 void BKE_camera_view_frame(const struct Scene *scene,
127                            const struct Camera *camera,
128                            float r_vec[4][3]);
129
130 bool BKE_camera_view_frame_fit_to_scene(struct Depsgraph *depsgraph,
131                                         struct Scene *scene,
132                                         struct Object *camera_ob,
133                                         float r_co[3],
134                                         float *r_scale);
135 bool BKE_camera_view_frame_fit_to_coords(const struct Depsgraph *depsgraph,
136                                          const float (*cos)[3],
137                                          int num_cos,
138                                          struct Object *camera_ob,
139                                          float r_co[3],
140                                          float *r_scale);
141
142 void BKE_camera_to_gpu_dof(struct Object *camera, struct GPUFXSettings *r_fx_settings);
143
144 /* Camera multi-view API */
145
146 struct Object *BKE_camera_multiview_render(struct Scene *scene,
147                                            struct Object *camera,
148                                            const char *viewname);
149 void BKE_camera_multiview_view_matrix(struct RenderData *rd,
150                                       const struct Object *camera,
151                                       const bool is_left,
152                                       float r_viewmat[4][4]);
153 void BKE_camera_multiview_model_matrix(struct RenderData *rd,
154                                        const struct Object *camera,
155                                        const char *viewname,
156                                        float r_modelmat[4][4]);
157 void BKE_camera_multiview_model_matrix_scaled(struct RenderData *rd,
158                                               const struct Object *camera,
159                                               const char *viewname,
160                                               float r_modelmat[4][4]);
161 void BKE_camera_multiview_window_matrix(struct RenderData *rd,
162                                         const struct Object *camera,
163                                         const char *viewname,
164                                         float r_winmat[4][4]);
165 float BKE_camera_multiview_shift_x(struct RenderData *rd,
166                                    const struct Object *camera,
167                                    const char *viewname);
168 void BKE_camera_multiview_params(struct RenderData *rd,
169                                  struct CameraParams *params,
170                                  const struct Object *camera,
171                                  const char *viewname);
172 bool BKE_camera_multiview_spherical_stereo(struct RenderData *rd, const struct Object *camera);
173
174 /* Camera background image API */
175 struct CameraBGImage *BKE_camera_background_image_new(struct Camera *cam);
176 void BKE_camera_background_image_remove(struct Camera *cam, struct CameraBGImage *bgpic);
177 void BKE_camera_background_image_clear(struct Camera *cam);
178
179 #ifdef __cplusplus
180 }
181 #endif
182
183 #endif