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