Fix T64842: crash rendering files with bevel curves
[blender.git] / source / blender / blenkernel / BKE_scene.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_SCENE_H__
20 #define __BKE_SCENE_H__
21
22 /** \file
23  * \ingroup bke
24  */
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 struct AviCodecData;
31 struct Collection;
32 struct Depsgraph;
33 struct Main;
34 struct Object;
35 struct RenderData;
36 struct Scene;
37 struct TransformOrientation;
38 struct UnitSettings;
39 struct View3DCursor;
40 struct ViewLayer;
41 struct ViewRender;
42 struct WorkSpace;
43
44 typedef enum eSceneCopyMethod {
45   SCE_COPY_NEW = 0,
46   SCE_COPY_EMPTY = 1,
47   SCE_COPY_LINK_COLLECTION = 2,
48   SCE_COPY_FULL = 3,
49 } eSceneCopyMethod;
50
51 /* Use as the contents of a 'for' loop: for (SETLOOPER(...)) { ... */
52 #define SETLOOPER(_sce_basis, _sce_iter, _base) \
53   _sce_iter = _sce_basis, \
54   _base = _setlooper_base_step( \
55       &_sce_iter, BKE_view_layer_context_active_PLACEHOLDER(_sce_basis), NULL); \
56   _base; \
57   _base = _setlooper_base_step(&_sce_iter, NULL, _base)
58
59 #define SETLOOPER_VIEW_LAYER(_sce_basis, _view_layer, _sce_iter, _base) \
60   _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, _view_layer, NULL); \
61   _base; \
62   _base = _setlooper_base_step(&_sce_iter, NULL, _base)
63
64 #define SETLOOPER_SET_ONLY(_sce_basis, _sce_iter, _base) \
65   _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL, NULL); \
66   _base; \
67   _base = _setlooper_base_step(&_sce_iter, NULL, _base)
68
69 struct Base *_setlooper_base_step(struct Scene **sce_iter,
70                                   struct ViewLayer *view_layer,
71                                   struct Base *base);
72
73 void free_avicodecdata(struct AviCodecData *acd);
74
75 void BKE_scene_free_ex(struct Scene *sce, const bool do_id_user);
76 void BKE_scene_free(struct Scene *sce);
77 void BKE_scene_init(struct Scene *sce);
78 struct Scene *BKE_scene_add(struct Main *bmain, const char *name);
79
80 void BKE_scene_remove_rigidbody_object(struct Main *bmain, struct Scene *scene, struct Object *ob);
81
82 bool BKE_scene_object_find(struct Scene *scene, struct Object *ob);
83 struct Object *BKE_scene_object_find_by_name(struct Scene *scene, const char *name);
84
85 /* Scene base iteration function.
86  * Define struct here, so no need to bother with alloc/free it.
87  */
88 typedef struct SceneBaseIter {
89   struct ListBase *duplilist;
90   struct DupliObject *dupob;
91   float omat[4][4];
92   struct Object *dupli_refob;
93   int phase;
94 } SceneBaseIter;
95
96 int BKE_scene_base_iter_next(struct Depsgraph *depsgraph,
97                              struct SceneBaseIter *iter,
98                              struct Scene **scene,
99                              int val,
100                              struct Base **base,
101                              struct Object **ob);
102
103 void BKE_scene_base_flag_to_objects(struct ViewLayer *view_layer);
104 void BKE_scene_object_base_flag_sync_from_base(struct Base *base);
105
106 void BKE_scene_set_background(struct Main *bmain, struct Scene *sce);
107 struct Scene *BKE_scene_set_name(struct Main *bmain, const char *name);
108
109 struct ToolSettings *BKE_toolsettings_copy(struct ToolSettings *toolsettings, const int flag);
110 void BKE_toolsettings_free(struct ToolSettings *toolsettings);
111
112 void BKE_scene_copy_data(struct Main *bmain,
113                          struct Scene *sce_dst,
114                          const struct Scene *sce_src,
115                          const int flag);
116 struct Scene *BKE_scene_copy(struct Main *bmain, struct Scene *sce, int type);
117 void BKE_scene_groups_relink(struct Scene *sce);
118
119 void BKE_scene_make_local(struct Main *bmain, struct Scene *sce, const bool lib_local);
120
121 struct Scene *BKE_scene_find_from_collection(const struct Main *bmain,
122                                              const struct Collection *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 int BKE_scene_frame_snap_by_seconds(struct Scene *scene, double interval_in_seconds, int cfra);
133
134 /* checks for cycle, returns 1 if it's all OK */
135 bool BKE_scene_validate_setscene(struct Main *bmain, struct Scene *sce);
136
137 float BKE_scene_frame_get(const struct Scene *scene);
138 float BKE_scene_frame_get_from_ctime(const struct Scene *scene, const float frame);
139 void BKE_scene_frame_set(struct Scene *scene, double cfra);
140
141 struct TransformOrientationSlot *BKE_scene_orientation_slot_get_from_flag(struct Scene *scene,
142                                                                           int slot_index);
143 struct TransformOrientationSlot *BKE_scene_orientation_slot_get(struct Scene *scene, int flag);
144 void BKE_scene_orientation_slot_set_index(struct TransformOrientationSlot *orient_slot,
145                                           int orientation);
146 int BKE_scene_orientation_slot_get_index(const struct TransformOrientationSlot *orient_slot);
147
148 /* **  Scene evaluation ** */
149
150 void BKE_scene_graph_update_tagged(struct Depsgraph *depsgraph, struct Main *bmain);
151
152 void BKE_scene_graph_update_for_newframe(struct Depsgraph *depsgraph, struct Main *bmain);
153
154 void BKE_scene_view_layer_graph_evaluated_ensure(struct Main *bmain,
155                                                  struct Scene *scene,
156                                                  struct ViewLayer *view_layer);
157
158 struct SceneRenderView *BKE_scene_add_render_view(struct Scene *sce, const char *name);
159 bool BKE_scene_remove_render_view(struct Scene *scene, struct SceneRenderView *srv);
160
161 /* render profile */
162 int get_render_subsurf_level(const struct RenderData *r, int level, bool for_render);
163 int get_render_child_particle_number(const struct RenderData *r, int num, bool for_render);
164
165 bool BKE_scene_use_shading_nodes_custom(struct Scene *scene);
166 bool BKE_scene_use_spherical_stereo(struct Scene *scene);
167
168 bool BKE_scene_uses_blender_eevee(const struct Scene *scene);
169 bool BKE_scene_uses_blender_workbench(const struct Scene *scene);
170 bool BKE_scene_uses_cycles(const struct Scene *scene);
171
172 void BKE_scene_disable_color_management(struct Scene *scene);
173 bool BKE_scene_check_color_management_enabled(const struct Scene *scene);
174 bool BKE_scene_check_rigidbody_active(const struct Scene *scene);
175
176 int BKE_scene_num_threads(const struct Scene *scene);
177 int BKE_render_num_threads(const struct RenderData *r);
178
179 int BKE_render_preview_pixel_size(const struct RenderData *r);
180
181 /**********************************/
182
183 double BKE_scene_unit_scale(const struct UnitSettings *unit, const int unit_type, double value);
184
185 /* multiview */
186 bool BKE_scene_multiview_is_stereo3d(const struct RenderData *rd);
187 bool BKE_scene_multiview_is_render_view_active(const struct RenderData *rd,
188                                                const struct SceneRenderView *srv);
189 bool BKE_scene_multiview_is_render_view_first(const struct RenderData *rd, const char *viewname);
190 bool BKE_scene_multiview_is_render_view_last(const struct RenderData *rd, const char *viewname);
191 int BKE_scene_multiview_num_views_get(const struct RenderData *rd);
192 struct SceneRenderView *BKE_scene_multiview_render_view_findindex(const struct RenderData *rd,
193                                                                   const int view_id);
194 const char *BKE_scene_multiview_render_view_name_get(const struct RenderData *rd,
195                                                      const int view_id);
196 int BKE_scene_multiview_view_id_get(const struct RenderData *rd, const char *viewname);
197 void BKE_scene_multiview_filepath_get(struct SceneRenderView *srv,
198                                       const char *filepath,
199                                       char *r_filepath);
200 void BKE_scene_multiview_view_filepath_get(const struct RenderData *rd,
201                                            const char *filepath,
202                                            const char *view,
203                                            char *r_filepath);
204 const char *BKE_scene_multiview_view_suffix_get(const struct RenderData *rd, const char *viewname);
205 const char *BKE_scene_multiview_view_id_suffix_get(const struct RenderData *rd, const int view_id);
206 void BKE_scene_multiview_view_prefix_get(struct Scene *scene,
207                                          const char *name,
208                                          char *rprefix,
209                                          const char **rext);
210 void BKE_scene_multiview_videos_dimensions_get(const struct RenderData *rd,
211                                                const size_t width,
212                                                const size_t height,
213                                                size_t *r_width,
214                                                size_t *r_height);
215 int BKE_scene_multiview_num_videos_get(const struct RenderData *rd);
216
217 /* depsgraph */
218 void BKE_scene_allocate_depsgraph_hash(struct Scene *scene);
219 void BKE_scene_ensure_depsgraph_hash(struct Scene *scene);
220 void BKE_scene_free_depsgraph_hash(struct Scene *scene);
221
222 struct Depsgraph *BKE_scene_get_depsgraph(struct Scene *scene,
223                                           struct ViewLayer *view_layer,
224                                           bool allocate);
225
226 void BKE_scene_transform_orientation_remove(struct Scene *scene,
227                                             struct TransformOrientation *orientation);
228 struct TransformOrientation *BKE_scene_transform_orientation_find(const struct Scene *scene,
229                                                                   const int index);
230 int BKE_scene_transform_orientation_get_index(const struct Scene *scene,
231                                               const struct TransformOrientation *orientation);
232
233 void BKE_scene_cursor_rot_to_mat3(const struct View3DCursor *cursor, float mat[3][3]);
234 void BKE_scene_cursor_mat3_to_rot(struct View3DCursor *cursor,
235                                   const float mat[3][3],
236                                   bool use_compat);
237
238 void BKE_scene_cursor_rot_to_quat(const struct View3DCursor *cursor, float quat[4]);
239 void BKE_scene_cursor_quat_to_rot(struct View3DCursor *cursor,
240                                   const float quat[4],
241                                   bool use_compat);
242
243 void BKE_scene_cursor_to_mat4(const struct View3DCursor *cursor, float mat[4][4]);
244 void BKE_scene_cursor_from_mat4(struct View3DCursor *cursor,
245                                 const float mat[4][4],
246                                 bool use_compat);
247
248 #ifdef __cplusplus
249 }
250 #endif
251
252 #endif