Fix #34040: Moving Normal Node with enabled Cycles Material Preview crashes
[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
50 /* Camera Datablock */
51
52 void *BKE_camera_add(struct Main *bmain, const char *name);
53 struct Camera *BKE_camera_copy(struct Camera *cam);
54 void BKE_camera_make_local(struct Camera *cam);
55 void BKE_camera_free(struct Camera *ca);
56
57 /* Camera Usage */
58
59 float BKE_camera_object_dof_distance(struct Object *ob);
60 void BKE_camera_object_mode(struct RenderData *rd, struct Object *ob);
61
62 int BKE_camera_sensor_fit(int sensor_fit, float sizex, float sizey);
63 float BKE_camera_sensor_size(int sensor_fit, float sensor_x, float sensor_y);
64
65 /* Camera Parameters:
66  *
67  * Intermediate struct for storing camera parameters from various sources,
68  * to unify computation of viewplane, window matrix, ... */
69
70 typedef struct CameraParams {
71         /* lens */
72         int is_ortho;
73         float lens;
74         float ortho_scale;
75         float zoom;
76
77         float shiftx;
78         float shifty;
79         float offsetx;
80         float offsety;
81
82         /* sensor */
83         float sensor_x;
84         float sensor_y;
85         int sensor_fit;
86
87         /* clipping */
88         float clipsta;
89         float clipend;
90
91         /* fields */
92         int use_fields;
93         int field_second;
94         int field_odd;
95
96         /* computed viewplane */
97         float ycor;
98         float viewdx;
99         float viewdy;
100         rctf viewplane;
101
102         /* computed matrix */
103         float winmat[4][4];
104 } CameraParams;
105
106 void BKE_camera_params_init(CameraParams *params);
107 void BKE_camera_params_from_object(CameraParams *params, struct Object *camera);
108 void BKE_camera_params_from_view3d(CameraParams *params, struct View3D *v3d, struct RegionView3D *rv3d);
109
110 void BKE_camera_params_compute_viewplane(CameraParams *params, int winx, int winy, float aspx, float aspy);
111 void BKE_camera_params_compute_matrix(CameraParams *params);
112
113 /* Camera View Frame */
114
115 void BKE_camera_view_frame_ex(struct Scene *scene, struct Camera *camera, float drawsize, const short do_clip, const float scale[3],
116                               float r_asp[2], float r_shift[2], float *r_drawsize, float r_vec[4][3]);
117
118 void BKE_camera_view_frame(struct Scene *scene, struct Camera *camera, float r_vec[4][3]);
119
120 int BKE_camera_view_frame_fit_to_scene(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