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