d5bf2177f71d79e2afecc5c43bac7ecce0ea9cb2
[blender.git] / source / blender / blenkernel / BKE_camera.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 #ifndef __BKE_CAMERA_H__
29 #define __BKE_CAMERA_H__
30
31 /** \file BKE_camera.h
32  *  \ingroup bke
33  *  \brief Camera datablock and utility functions.
34  */
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include "DNA_vec_types.h"
40
41 struct Camera;
42 struct Depsgraph;
43 struct Main;
44 struct Object;
45 struct RegionView3D;
46 struct RenderData;
47 struct Scene;
48 struct ViewLayer;
49 struct rctf;
50 struct View3D;
51 struct GPUFXSettings;
52
53 /* Camera Datablock */
54
55 void BKE_camera_init(struct Camera *cam);
56 void *BKE_camera_add(struct Main *bmain, const char *name);
57 void BKE_camera_copy_data(struct Main *bmain, struct Camera *cam_dst, const struct Camera *cam_src, const int flag);
58 struct Camera *BKE_camera_copy(struct Main *bmain, const struct Camera *cam);
59 void BKE_camera_make_local(struct Main *bmain, struct Camera *cam, const bool lib_local);
60 void BKE_camera_free(struct Camera *ca);
61
62 /* Camera Usage */
63
64 float BKE_camera_object_dof_distance(struct Object *ob);
65 void BKE_camera_object_mode(struct RenderData *rd, struct Object *ob);
66
67 int BKE_camera_sensor_fit(int sensor_fit, float sizex, float sizey);
68 float BKE_camera_sensor_size(int sensor_fit, float sensor_x, float sensor_y);
69
70 /* Camera Parameters:
71  *
72  * Intermediate struct for storing camera parameters from various sources,
73  * to unify computation of viewplane, window matrix, ... */
74
75 typedef struct CameraParams {
76         /* lens */
77         bool is_ortho;
78         float lens;
79         float ortho_scale;
80         float zoom;
81
82         float shiftx;
83         float shifty;
84         float offsetx;
85         float offsety;
86
87         /* sensor */
88         float sensor_x;
89         float sensor_y;
90         int sensor_fit;
91
92         /* clipping */
93         float clipsta;
94         float clipend;
95
96         /* fields */
97         int use_fields;
98         int field_second;
99         int field_odd;
100
101         /* computed viewplane */
102         float ycor;
103         float viewdx;
104         float viewdy;
105         rctf viewplane;
106
107         /* computed matrix */
108         float winmat[4][4];
109 } CameraParams;
110
111 /* values for CameraParams.zoom, need to be taken into account for some operations */
112 #define CAMERA_PARAM_ZOOM_INIT_CAMOB 1.0f
113 #define CAMERA_PARAM_ZOOM_INIT_PERSP 2.0f
114
115 void BKE_camera_params_init(CameraParams *params);
116 void BKE_camera_params_from_object(CameraParams *params, const struct Object *camera);
117 void BKE_camera_params_from_view3d(CameraParams *params, const struct Depsgraph *depsgraph, const struct View3D *v3d, const struct RegionView3D *rv3d);
118
119 void BKE_camera_params_compute_viewplane(CameraParams *params, int winx, int winy, float aspx, float aspy);
120 void BKE_camera_params_compute_matrix(CameraParams *params);
121
122 /* Camera View Frame */
123
124 void BKE_camera_view_frame_ex(
125         const struct Scene *scene, const struct Camera *camera,
126         const float drawsize, const bool do_clip, const float scale[3],
127         float r_asp[2], float r_shift[2], float *r_drawsize, float r_vec[4][3]);
128 void BKE_camera_view_frame(
129         const struct Scene *scene, const struct Camera *camera,
130         float r_vec[4][3]);
131
132 bool BKE_camera_view_frame_fit_to_scene(
133         struct Scene *scene, struct ViewLayer *view_layer, struct Object *camera_ob,
134         float r_co[3], float *r_scale);
135 bool BKE_camera_view_frame_fit_to_coords(
136         const struct Scene *scene,
137         const float (*cos)[3], int num_cos,
138         const struct Object *camera_ob,
139         float r_co[3], float *r_scale);
140
141 void BKE_camera_to_gpu_dof(struct Object *camera, struct GPUFXSettings *r_fx_settings);
142
143 /* Camera multi-view API */
144
145 struct Object *BKE_camera_multiview_render(struct Scene *scene, struct Object *camera, const char *viewname);
146 void           BKE_camera_multiview_view_matrix(struct RenderData *rd, struct Object *camera, const bool is_left, float r_viewmat[4][4]);
147 void           BKE_camera_multiview_model_matrix(struct RenderData *rd, struct Object *camera, const char *viewname, float r_modelmat[4][4]);
148 float          BKE_camera_multiview_shift_x(struct RenderData *rd, struct Object *camera, const char *viewname);
149 void           BKE_camera_multiview_params(struct RenderData *rd, struct CameraParams *params, struct Object *camera, const char *viewname);
150 bool           BKE_camera_multiview_spherical_stereo(struct RenderData *rd, struct Object *camera);
151
152 /* Camera background image API */
153 struct CameraBGImage *BKE_camera_background_image_new(struct Camera *cam);
154 void BKE_camera_background_image_remove(struct Camera *cam, struct CameraBGImage *bgpic);
155 void BKE_camera_background_image_clear(struct Camera *cam);
156
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif
162