svn merge ^/trunk/blender -r43436:43443
[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 Object;
43 struct RegionView3D;
44 struct RenderData;
45 struct Scene;
46 struct rctf;
47 struct View3D;
48
49 /* Camera Datablock */
50
51 void *add_camera(const char *name);
52 struct Camera *copy_camera(struct Camera *cam);
53 void make_local_camera(struct Camera *cam);
54 void free_camera(struct Camera *ca);
55
56 /* Camera Usage */
57
58 float object_camera_dof_distance(struct Object *ob);
59 void object_camera_mode(struct RenderData *rd, struct Object *ob);
60
61 int camera_sensor_fit(int sensor_fit, float sizex, float sizey);
62 float camera_sensor_size(int sensor_fit, float sensor_x, float sensor_y);
63
64 /* Camera Parameters:
65  *
66  * Intermediate struct for storing camera parameters from various sources,
67  * to unify computation of viewplane, window matrix, ... */
68
69 typedef struct CameraParams {
70         /* lens */
71         int is_ortho;
72         float lens;
73         float ortho_scale;
74         float zoom;
75
76         float shiftx;
77         float shifty;
78         float offsetx;
79         float offsety;
80
81         /* sensor */
82         float sensor_x;
83         float sensor_y;
84         int sensor_fit;
85
86         /* clipping */
87         float clipsta;
88         float clipend;
89
90         /* fields */
91         int use_fields;
92         int field_second;
93         int field_odd;
94
95         /* computed viewplane */
96         float ycor;
97         float viewdx;
98         float viewdy;
99         rctf viewplane;
100
101         /* computed matrix */
102         float winmat[4][4];
103 } CameraParams;
104
105 void camera_params_init(CameraParams *params);
106 void camera_params_from_object(CameraParams *params, struct Object *camera);
107 void camera_params_from_view3d(CameraParams *params, struct View3D *v3d, struct RegionView3D *rv3d);
108
109 void camera_params_compute_viewplane(CameraParams *params, int winx, int winy, float aspx, float aspy);
110 void camera_params_compute_matrix(CameraParams *params);
111
112 /* Camera View Frame */
113
114 void camera_view_frame_ex(struct Scene *scene, struct Camera *camera, float drawsize, const short do_clip, const float scale[3],
115                           float r_asp[2], float r_shift[2], float *r_drawsize, float r_vec[4][3]);
116
117 void camera_view_frame(struct Scene *scene, struct Camera *camera, float r_vec[4][3]);
118
119 int camera_view_frame_fit_to_scene(
120         struct Scene *scene, struct View3D *v3d, struct Object *camera_ob,
121         float r_co[3]);
122
123 #ifdef __cplusplus
124 }
125 #endif
126
127 #endif
128