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