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