doxygen: add newline after \file
[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, struct Camera *cam_dst, const struct Camera *cam_src, const int flag);
50 struct Camera *BKE_camera_copy(struct Main *bmain, const struct Camera *cam);
51 void BKE_camera_make_local(struct Main *bmain, struct Camera *cam, const bool lib_local);
52 void BKE_camera_free(struct Camera *ca);
53
54 /* Camera Usage */
55
56 float BKE_camera_object_dof_distance(struct Object *ob);
57
58 int BKE_camera_sensor_fit(int sensor_fit, float sizex, float sizey);
59 float BKE_camera_sensor_size(int sensor_fit, float sensor_x, float sensor_y);
60
61 /* Camera Parameters:
62  *
63  * Intermediate struct for storing camera parameters from various sources,
64  * to unify computation of viewplane, window matrix, ... */
65
66 typedef struct CameraParams {
67         /* lens */
68         bool is_ortho;
69         float lens;
70         float ortho_scale;
71         float zoom;
72
73         float shiftx;
74         float shifty;
75         float offsetx;
76         float offsety;
77
78         /* sensor */
79         float sensor_x;
80         float sensor_y;
81         int sensor_fit;
82
83         /* clipping */
84         float clip_start;
85         float clip_end;
86
87         /* computed viewplane */
88         float ycor;
89         float viewdx;
90         float viewdy;
91         rctf viewplane;
92
93         /* computed matrix */
94         float winmat[4][4];
95 } CameraParams;
96
97 /* values for CameraParams.zoom, need to be taken into account for some operations */
98 #define CAMERA_PARAM_ZOOM_INIT_CAMOB 1.0f
99 #define CAMERA_PARAM_ZOOM_INIT_PERSP 2.0f
100
101 void BKE_camera_params_init(CameraParams *params);
102 void BKE_camera_params_from_object(CameraParams *params, const struct Object *camera);
103 void BKE_camera_params_from_view3d(CameraParams *params, struct Depsgraph *depsgraph, const struct View3D *v3d, const struct RegionView3D *rv3d);
104
105 void BKE_camera_params_compute_viewplane(CameraParams *params, int winx, int winy, float aspx, float aspy);
106 void BKE_camera_params_compute_matrix(CameraParams *params);
107
108 /* Camera View Frame */
109
110 void BKE_camera_view_frame_ex(
111         const struct Scene *scene, const struct Camera *camera,
112         const float drawsize, const bool do_clip, const float scale[3],
113         float r_asp[2], float r_shift[2], float *r_drawsize, float r_vec[4][3]);
114 void BKE_camera_view_frame(
115         const struct Scene *scene, const struct Camera *camera,
116         float r_vec[4][3]);
117
118 bool BKE_camera_view_frame_fit_to_scene(
119         struct Depsgraph *depsgraph,
120         struct Scene *scene, struct Object *camera_ob,
121         float r_co[3], float *r_scale);
122 bool BKE_camera_view_frame_fit_to_coords(
123         const struct Depsgraph *depsgraph,
124         const float (*cos)[3], int num_cos,
125         struct Object *camera_ob,
126         float r_co[3], float *r_scale);
127
128 void BKE_camera_to_gpu_dof(struct Object *camera, struct GPUFXSettings *r_fx_settings);
129
130 /* Camera multi-view API */
131
132 struct Object *BKE_camera_multiview_render(struct Scene *scene, struct Object *camera, const char *viewname);
133 void           BKE_camera_multiview_view_matrix(struct RenderData *rd, const struct Object *camera, const bool is_left, float r_viewmat[4][4]);
134 void           BKE_camera_multiview_model_matrix(struct RenderData *rd, const struct Object *camera, const char *viewname, float r_modelmat[4][4]);
135 void           BKE_camera_multiview_model_matrix_scaled(struct RenderData *rd, const struct Object *camera, const char *viewname, float r_modelmat[4][4]);
136 void           BKE_camera_multiview_window_matrix(struct RenderData *rd, const struct Object *camera, const char *viewname, float r_winmat[4][4]);
137 float          BKE_camera_multiview_shift_x(struct RenderData *rd, const struct Object *camera, const char *viewname);
138 void           BKE_camera_multiview_params(struct RenderData *rd, struct CameraParams *params, const struct Object *camera, const char *viewname);
139 bool           BKE_camera_multiview_spherical_stereo(struct RenderData *rd, const struct Object *camera);
140
141 /* Camera background image API */
142 struct CameraBGImage *BKE_camera_background_image_new(struct Camera *cam);
143 void BKE_camera_background_image_remove(struct Camera *cam, struct CameraBGImage *bgpic);
144 void BKE_camera_background_image_clear(struct Camera *cam);
145
146 #ifdef __cplusplus
147 }
148 #endif
149
150 #endif