Depsgraph: remove EvaluationContext, pass Depsgraph instead.
[blender.git] / source / blender / blenkernel / BKE_scene.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 #ifndef __BKE_SCENE_H__
28 #define __BKE_SCENE_H__
29
30 /** \file BKE_scene.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct AviCodecData;
41 struct Depsgraph;
42 struct Main;
43 struct Object;
44 struct RenderData;
45 struct Scene;
46 struct SceneCollection;
47 struct ViewLayer;
48 struct UnitSettings;
49 struct ViewRender;
50 struct WorkSpace;
51
52 typedef enum eSceneCopyMethod {
53         SCE_COPY_NEW       = 0,
54         SCE_COPY_EMPTY     = 1,
55         SCE_COPY_LINK_OB   = 2,
56         SCE_COPY_LINK_DATA = 3,
57         SCE_COPY_FULL      = 4,
58 } eSceneCopyMethod;
59
60 /* Use as the contents of a 'for' loop: for (SETLOOPER(...)) { ... */
61 #define SETLOOPER(_sce_basis, _sce_iter, _base)                               \
62         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, BKE_view_layer_from_scene_get(_sce_basis), NULL); \
63         _base;                                                                    \
64         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
65
66 #define SETLOOPER_VIEW_LAYER(_sce_basis, _view_layer, _sce_iter, _base)     \
67         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, _view_layer, NULL);   \
68         _base;                                                                    \
69         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
70
71 #define SETLOOPER_SET_ONLY(_sce_basis, _sce_iter, _base)     \
72         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL, NULL);   \
73         _base;                                                                    \
74         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
75
76 struct Base *_setlooper_base_step(struct Scene **sce_iter, struct ViewLayer *view_layer, struct Base *base);
77
78 void free_avicodecdata(struct AviCodecData *acd);
79
80 void BKE_scene_free_ex(struct Scene *sce, const bool do_id_user);
81 void BKE_scene_free(struct Scene *sce);
82 void BKE_scene_init(struct Scene *sce);
83 struct Scene *BKE_scene_add(struct Main *bmain, const char *name);
84
85 void BKE_scene_remove_rigidbody_object(struct Scene *scene, struct Object *ob);
86
87 bool BKE_scene_object_find(struct Scene *scene, struct Object *ob);
88 struct Object *BKE_scene_object_find_by_name(struct Scene *scene, const char *name);
89
90 /* Scene base iteration function.
91  * Define struct here, so no need to bother with alloc/free it.
92  */
93 typedef struct SceneBaseIter {
94         struct ListBase *duplilist;
95         struct DupliObject *dupob;
96         float omat[4][4];
97         struct Object *dupli_refob;
98         int phase;
99 } SceneBaseIter;
100
101 int BKE_scene_base_iter_next(
102         struct Depsgraph *depsgraph, struct SceneBaseIter *iter,
103         struct Scene **scene, int val, struct Base **base, struct Object **ob);
104
105 void BKE_scene_base_flag_to_objects(struct ViewLayer *view_layer);
106 void BKE_scene_base_flag_from_objects(struct Scene *scene);
107 void BKE_scene_object_base_flag_sync_from_base(struct Base *base);
108 void BKE_scene_object_base_flag_sync_from_object(struct Base *base);
109
110 void BKE_scene_set_background(struct Main *bmain, struct Scene *sce);
111 struct Scene *BKE_scene_set_name(struct Main *bmain, const char *name);
112
113 struct ToolSettings *BKE_toolsettings_copy(struct ToolSettings *toolsettings, const int flag);
114 void BKE_toolsettings_free(struct ToolSettings *toolsettings);
115
116 void BKE_scene_copy_data(struct Main *bmain, struct Scene *sce_dst, const struct Scene *sce_src, const int flag);
117 struct Scene *BKE_scene_copy(struct Main *bmain, struct Scene *sce, int type);
118 void BKE_scene_groups_relink(struct Scene *sce);
119
120 void BKE_scene_make_local(struct Main *bmain, struct Scene *sce, const bool lib_local);
121
122 struct Scene *BKE_scene_find_from_collection(const struct Main *bmain, const struct SceneCollection *scene_collection);
123
124 #ifdef DURIAN_CAMERA_SWITCH
125 struct Object *BKE_scene_camera_switch_find(struct Scene *scene); // DURIAN_CAMERA_SWITCH
126 #endif
127 int BKE_scene_camera_switch_update(struct Scene *scene);
128
129 char *BKE_scene_find_marker_name(struct Scene *scene, int frame);
130 char *BKE_scene_find_last_marker_name(struct Scene *scene, int frame);
131
132 /* checks for cycle, returns 1 if it's all OK */
133 bool BKE_scene_validate_setscene(struct Main *bmain, struct Scene *sce);
134
135 float BKE_scene_frame_get(const struct Scene *scene);
136 float BKE_scene_frame_get_from_ctime(const struct Scene *scene, const float frame);
137 void  BKE_scene_frame_set(struct Scene *scene, double cfra);
138
139 /* **  Scene evaluation ** */
140
141 void BKE_scene_graph_update_tagged(struct Depsgraph *depsgraph,
142                                    struct Main *bmain);
143
144 void BKE_scene_graph_update_for_newframe(struct Depsgraph *depsgraph,
145                                          struct Main *bmain);
146
147 struct SceneRenderView *BKE_scene_add_render_view(struct Scene *sce, const char *name);
148 bool BKE_scene_remove_render_view(struct Scene *scene, struct SceneRenderView *srv);
149
150 /* render profile */
151 int get_render_subsurf_level(const struct RenderData *r, int level, bool for_render);
152 int get_render_child_particle_number(const struct RenderData *r, int num, bool for_render);
153 int get_render_shadow_samples(const struct RenderData *r, int samples);
154 float get_render_aosss_error(const struct RenderData *r, float error);
155
156 bool BKE_scene_use_new_shading_nodes(const struct Scene *scene);
157 bool BKE_scene_use_shading_nodes_custom(struct Scene *scene);
158 bool BKE_scene_use_world_space_shading(struct Scene *scene);
159 bool BKE_scene_use_spherical_stereo(struct Scene *scene);
160
161 bool BKE_scene_uses_blender_internal(const struct Scene *scene);
162 bool BKE_scene_uses_blender_game(const struct Scene *scene);
163 bool BKE_scene_uses_blender_eevee(const struct Scene *scene);
164
165 void BKE_scene_disable_color_management(struct Scene *scene);
166 bool BKE_scene_check_color_management_enabled(const struct Scene *scene);
167 bool BKE_scene_check_rigidbody_active(const struct Scene *scene);
168
169 int BKE_scene_num_threads(const struct Scene *scene);
170 int BKE_render_num_threads(const struct RenderData *r);
171
172 int BKE_render_preview_pixel_size(const struct RenderData *r);
173
174 /**********************************/
175
176 struct ViewRender *BKE_viewrender_get(struct Scene *scene, struct WorkSpace *workspace);
177 void BKE_viewrender_init(struct ViewRender *view_render);
178 void BKE_viewrender_free(struct ViewRender *view_render);
179 void BKE_viewrender_copy(struct ViewRender *view_render_dst, const struct ViewRender *view_render_src);
180 bool BKE_viewrender_use_new_shading_nodes(const struct ViewRender *view_render);
181 bool BKE_viewrender_use_shading_nodes_custom(const struct ViewRender *view_render);
182 bool BKE_viewrender_use_world_space_shading(const struct ViewRender *view_render);
183 bool BKE_viewrender_use_spherical_stereo(const struct ViewRender *view_render);
184 bool BKE_viewrender_uses_blender_internal(const struct ViewRender *view_render);
185 bool BKE_viewrender_uses_blender_game(const struct ViewRender *view_render);
186 bool BKE_viewrender_uses_blender_eevee(const struct ViewRender *view_render);
187
188 /**********************************/
189
190 double BKE_scene_unit_scale(const struct UnitSettings *unit, const int unit_type, double value);
191
192 /* multiview */
193 bool        BKE_scene_multiview_is_stereo3d(const struct RenderData *rd);
194 bool        BKE_scene_multiview_is_render_view_active(const struct RenderData *rd, const struct SceneRenderView *srv);
195 bool        BKE_scene_multiview_is_render_view_first(const struct RenderData *rd, const char *viewname);
196 bool        BKE_scene_multiview_is_render_view_last(const struct RenderData *rd, const char *viewname);
197 int         BKE_scene_multiview_num_views_get(const struct RenderData *rd);
198 struct SceneRenderView *BKE_scene_multiview_render_view_findindex(const struct RenderData *rd, const int view_id);
199 const char *BKE_scene_multiview_render_view_name_get(const struct RenderData *rd, const int view_id);
200 int         BKE_scene_multiview_view_id_get(const struct RenderData *rd, const char *viewname);
201 void        BKE_scene_multiview_filepath_get(struct SceneRenderView *srv, const char *filepath, char *r_filepath);
202 void        BKE_scene_multiview_view_filepath_get(const struct RenderData *rd, const char *filepath, const char *view, char *r_filepath);
203 const char *BKE_scene_multiview_view_suffix_get(const struct RenderData *rd, const char *viewname);
204 const char *BKE_scene_multiview_view_id_suffix_get(const struct RenderData *rd, const int view_id);
205 void        BKE_scene_multiview_view_prefix_get(struct Scene *scene, const char *name, char *rprefix, const char **rext);
206 void        BKE_scene_multiview_videos_dimensions_get(const struct RenderData *rd, const size_t width, const size_t height, size_t *r_width, size_t *r_height);
207 int         BKE_scene_multiview_num_videos_get(const struct RenderData *rd);
208
209 /* depsgraph */
210 void BKE_scene_allocate_depsgraph_hash(struct Scene *scene);
211 void BKE_scene_ensure_depsgraph_hash(struct Scene *scene);
212 void BKE_scene_free_depsgraph_hash(struct Scene *scene);
213
214 struct Depsgraph *BKE_scene_get_depsgraph(struct Scene *scene, struct ViewLayer *view_layer, bool allocate);
215
216 #ifdef __cplusplus
217 }
218 #endif
219
220 #endif