Blender V5.3
BKE_scene.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4#pragma once
5
9
10#include "BLI_function_ref.hh"
11#include "BLI_sys_types.hh"
12
13#include "BKE_duplilist.hh"
14
15#include "DNA_userdef_enums.h"
16
17namespace blender {
18
19struct Base;
20struct Collection;
21struct Depsgraph;
22struct ImageFormatData;
23struct GHash;
24struct Main;
25struct Object;
26struct RenderData;
27struct Scene;
28struct SceneRenderView;
29struct ToolSettings;
32struct UnitSettings;
33struct ViewLayer;
34
41
43#define SETLOOPER(_bmain, _sce_basis, _sce_iter, _base) \
44 _sce_iter = _sce_basis, \
45 _base = _setlooper_base_step( \
46 (_bmain), &_sce_iter, BKE_view_layer_context_active_PLACEHOLDER(_sce_basis), NULL); \
47 _base; \
48 _base = _setlooper_base_step((_bmain), &_sce_iter, NULL, _base)
49
50#define SETLOOPER_VIEW_LAYER(_bmain, _sce_basis, _view_layer, _sce_iter, _base) \
51 _sce_iter = _sce_basis, _base = _setlooper_base_step((_bmain), &_sce_iter, _view_layer, NULL); \
52 _base; \
53 _base = _setlooper_base_step((_bmain), &_sce_iter, NULL, _base)
54
55#define SETLOOPER_SET_ONLY(_bmain, _sce_basis, _sce_iter, _base) \
56 _sce_iter = _sce_basis, _base = _setlooper_base_step((_bmain), &_sce_iter, NULL, NULL); \
57 _base; \
58 _base = _setlooper_base_step((_bmain), &_sce_iter, NULL, _base)
59
66Base *_setlooper_base_step(const Main &bmain, Scene **sce_iter, ViewLayer *view_layer, Base *base);
67
68Scene *BKE_scene_add(Main *bmain, const char *name);
69
70void BKE_scene_remove_rigidbody_object(Main *bmain, Scene *scene, Object *ob, bool free_us);
71
75bool BKE_scene_object_find(const Main &bmain, Scene *scene, Object *ob);
76Object *BKE_scene_object_find_by_name(const Main &bmain, const Scene *scene, const char *name);
77
78/* Scene base iteration function.
79 * Define struct here, so no need to bother with alloc/free it.
80 */
89
95 Depsgraph *depsgraph, SceneBaseIter *iter, Scene **scene, int val, Base **base, Object **ob);
96
97void BKE_scene_base_flag_to_objects(const Main &bmain, const Scene *scene, ViewLayer *view_layer);
109
116void BKE_scene_set_background(Main *bmain, Scene *sce);
120Scene *BKE_scene_set_name(Main *bmain, const char *name);
121
125ToolSettings *BKE_toolsettings_copy(ToolSettings *toolsettings, int flag);
126void BKE_toolsettings_free(ToolSettings *toolsettings);
127
129 Scene *sce,
130 eSceneCopyMethod type,
131 eDupli_ID_Flags duplicate_flags,
132 /*eLibIDDuplicateFlags*/ uint duplicate_options);
134
139bool BKE_scene_can_be_removed(const Main *bmain, const Scene *scene);
154 const Main &bmain,
155 const Scene &scene,
156 FunctionRef<bool(const Scene &scene)> scene_validate_cb = nullptr);
157
158bool BKE_scene_has_view_layer(const Scene *scene, const ViewLayer *layer);
159Scene *BKE_scene_find_from_collection(const Main *bmain, const Collection *collection);
160
161Object *BKE_scene_camera_switch_find(const Scene *scene, const int time);
163
164const char *BKE_scene_find_marker_name(const Scene *scene, int frame);
169const char *BKE_scene_find_last_marker_name(const Scene *scene, int frame);
170
171float BKE_scene_frame_snap_by_seconds(const Scene *scene, double interval_in_seconds, float frame);
172
176bool BKE_scene_validate_setscene(Main *bmain, Scene *sce);
177
183float BKE_scene_ctime_get(const Scene *scene);
188float BKE_scene_frame_to_ctime(const Scene *scene, int frame);
189
193float BKE_scene_frame_get(const Scene *scene);
197void BKE_scene_frame_set(Scene *scene, float frame);
198
203
205 bool contains(const int frame) const
206 {
207 return frame >= start_frame && frame <= end_frame;
208 }
209};
210
214ScenePlaybackRange BKE_scene_get_playback_range(const Scene *scene);
218void BKE_scene_frame_clamp_for_playback(Scene *scene, bool is_playing_forward);
219
220TransformOrientationSlot *BKE_scene_orientation_slot_get_from_flag(Scene *scene, int flag);
221TransformOrientationSlot *BKE_scene_orientation_slot_get(Scene *scene, int slot_index);
228void BKE_scene_orientation_slot_set_index(TransformOrientationSlot *orient_slot, int orientation);
229int BKE_scene_orientation_slot_get_index(const TransformOrientationSlot *orient_slot);
230int BKE_scene_orientation_get_index(Scene *scene, int slot_index);
232
233/* ** Scene evaluation ** */
234
235void BKE_scene_update_sound(Depsgraph *depsgraph, Main *bmain);
236void BKE_scene_update_tag_audio_volume(Depsgraph *, Scene *scene);
237
238void BKE_scene_graph_update_tagged(Depsgraph *depsgraph, Main *bmain);
239void BKE_scene_graph_evaluated_ensure(Depsgraph *depsgraph, Main *bmain);
240
241void BKE_scene_graph_update_for_newframe(Depsgraph *depsgraph);
245void BKE_scene_graph_update_for_newframe_ex(Depsgraph *depsgraph, bool clear_recalc);
246
253void BKE_scene_view_layer_graph_evaluated_ensure(Main *bmain, Scene *scene, ViewLayer *view_layer);
254
258SceneRenderView *BKE_scene_add_render_view(Scene *sce, const char *name);
259bool BKE_scene_remove_render_view(Scene *scene, SceneRenderView *srv);
260
261/* Render profile. */
262
263int get_render_subsurf_level(const RenderData *r, int lvl, bool for_render);
264int get_render_child_particle_number(const RenderData *r, int child_num, bool for_render);
265
268
269bool BKE_scene_uses_blender_eevee(const Scene *scene);
270bool BKE_scene_uses_blender_workbench(const Scene *scene);
271bool BKE_scene_uses_cycles(const Scene *scene);
272
273bool BKE_scene_uses_shader_previews(const Scene *scene);
274
275void BKE_scene_copy_data_eevee(Scene *sce_dst, const Scene *sce_src);
276
278bool BKE_scene_check_rigidbody_active(const Scene *scene);
279
280int BKE_scene_num_threads(const Scene *scene);
281int BKE_render_num_threads(const RenderData *r);
282
283void BKE_render_resolution(const RenderData *r, const bool use_crop, int *r_width, int *r_height);
284int BKE_render_preview_pixel_size(const RenderData *r);
285
286/**********************************/
287
288/* Multi-view. */
289
290bool BKE_scene_multiview_is_stereo3d(const RenderData *rd);
294bool BKE_scene_multiview_is_render_view_active(const RenderData *rd, const SceneRenderView *srv);
298bool BKE_scene_multiview_is_render_view_first(const RenderData *rd, const char *viewname);
302bool BKE_scene_multiview_is_render_view_last(const RenderData *rd, const char *viewname);
303int BKE_scene_multiview_num_views_get(const RenderData *rd);
304SceneRenderView *BKE_scene_multiview_render_view_findindex(const RenderData *rd, int view_id);
305const char *BKE_scene_multiview_render_view_name_get(const RenderData *rd, int view_id);
306int BKE_scene_multiview_view_id_get(const RenderData *rd, const char *viewname);
307void BKE_scene_multiview_filepath_get(const SceneRenderView *srv,
308 const char *filepath,
309 char *r_filepath);
316void BKE_scene_multiview_view_filepath_get(const RenderData *rd,
317 const char *filepath,
318 const char *view,
319 char *r_filepath);
320const char *BKE_scene_multiview_view_suffix_get(const RenderData *rd, const char *viewname);
321const char *BKE_scene_multiview_view_id_suffix_get(const RenderData *rd, int view_id);
323 const char *filepath,
324 char *r_prefix,
325 const char **r_ext);
326void BKE_scene_multiview_videos_dimensions_get(const RenderData *rd,
327 const ImageFormatData *imf,
328 size_t width,
329 size_t height,
330 size_t *r_width,
331 size_t *r_height);
332int BKE_scene_multiview_num_videos_get(const RenderData *rd, const ImageFormatData *imf);
336void BKE_scene_ppm_get(const RenderData *rd, double r_ppm[2]);
337
338/* depsgraph */
342void BKE_scene_free_view_layer_depsgraph(Scene *scene, ViewLayer *view_layer);
343
347Depsgraph *BKE_scene_get_depsgraph(const Scene *scene, const ViewLayer *view_layer);
351Depsgraph *BKE_scene_ensure_depsgraph(Main *bmain, Scene *scene, ViewLayer *view_layer);
352
353GHash *BKE_scene_undo_depsgraphs_extract(Main *bmain);
354void BKE_scene_undo_depsgraphs_restore(Main *bmain, GHash *depsgraph_extract);
355
356void BKE_scene_transform_orientation_remove(Scene *scene, TransformOrientation *orientation);
357TransformOrientation *BKE_scene_transform_orientation_find(const Scene *scene, int index);
363 const TransformOrientation *orientation);
364
365} // namespace blender
Definition scene.h:133
#define index(i)
#define layer
BMesh Iterators.
bool BKE_scene_multiview_is_render_view_active(const RenderData *rd, const SceneRenderView *srv)
Definition scene.cc:3241
int BKE_render_preview_pixel_size(const RenderData *r)
Definition scene.cc:3183
void BKE_scene_graph_update_for_newframe(Depsgraph *depsgraph)
Definition scene.cc:2953
void BKE_scene_view_layer_graph_evaluated_ensure(Main *bmain, Scene *scene, ViewLayer *view_layer)
Definition scene.cc:2958
bool BKE_scene_use_spherical_stereo(Scene *scene)
Definition scene.cc:3071
const char * BKE_scene_multiview_render_view_name_get(const RenderData *rd, int view_id)
Definition scene.cc:3324
Scene * BKE_scene_find_replacement(const Main &bmain, const Scene &scene, FunctionRef< bool(const Scene &scene)> scene_validate_cb=nullptr)
Definition scene.cc:2170
void BKE_scene_ensure_depsgraph_hash(Scene *scene)
Definition scene.cc:3541
void BKE_scene_frame_clamp_for_playback(Scene *scene, bool is_playing_forward)
Definition scene.cc:2615
int BKE_scene_num_threads(const Scene *scene)
Definition scene.cc:3163
unsigned int uint
Definition BKE_text.h:55
Scene * BKE_scene_set_name(Main *bmain, const char *name)
Definition scene.cc:2255
Depsgraph * BKE_scene_get_depsgraph(const Scene *scene, const ViewLayer *view_layer)
Definition scene.cc:3631
int BKE_scene_multiview_view_id_get(const RenderData *rd, const char *viewname)
Definition scene.cc:3335
bool BKE_scene_can_be_removed(const Main *bmain, const Scene *scene)
Definition scene.cc:2150
void BKE_scene_multiview_filepath_get(const SceneRenderView *srv, const char *filepath, char *r_filepath)
Definition scene.cc:3361
void BKE_scene_allocate_depsgraph_hash(Scene *scene)
Definition scene.cc:3536
bool BKE_scene_has_view_layer(const Scene *scene, const ViewLayer *layer)
Definition scene.cc:2422
void BKE_scene_remove_rigidbody_object(Main *bmain, Scene *scene, Object *ob, bool free_us)
Definition scene.cc:2547
int get_render_subsurf_level(const RenderData *r, int lvl, bool for_render)
Definition scene.cc:3006
float BKE_scene_frame_to_ctime(const Scene *scene, int frame)
Definition scene.cc:2586
void BKE_scene_disable_color_management(Scene *scene)
Definition scene.cc:3117
void BKE_scene_free_view_layer_depsgraph(Scene *scene, ViewLayer *view_layer)
Definition scene.cc:3560
eSceneCopyMethod
Definition BKE_scene.hh:35
@ SCE_COPY_NEW
Definition BKE_scene.hh:36
@ SCE_COPY_FULL
Definition BKE_scene.hh:39
@ SCE_COPY_LINK_COLLECTION
Definition BKE_scene.hh:38
@ SCE_COPY_EMPTY
Definition BKE_scene.hh:37
int BKE_scene_orientation_get_index(Scene *scene, int slot_index)
Definition scene.cc:2678
const char * BKE_scene_multiview_view_suffix_get(const RenderData *rd, const char *viewname)
Definition scene.cc:3390
int BKE_scene_multiview_num_views_get(const RenderData *rd)
Definition scene.cc:3193
bool BKE_scene_validate_setscene(Main *bmain, Scene *sce)
Definition scene.cc:2559
bool BKE_scene_use_shading_nodes_custom(Scene *scene)
Definition scene.cc:3065
void BKE_toolsettings_free(ToolSettings *toolsettings)
Definition scene.cc:1828
void BKE_scene_update_tag_audio_volume(Depsgraph *, Scene *scene)
Definition scene.cc:2775
void BKE_scene_frame_set(Scene *scene, float frame)
Definition scene.cc:2600
void BKE_render_resolution(const RenderData *r, const bool use_crop, int *r_width, int *r_height)
Definition scene.cc:3168
void BKE_scene_graph_evaluated_ensure(Depsgraph *depsgraph, Main *bmain)
Definition scene.cc:2872
ScenePlaybackRange BKE_scene_get_playback_range(const Scene *scene)
Definition scene.cc:2607
int BKE_scene_base_iter_next(Depsgraph *depsgraph, SceneBaseIter *iter, Scene **scene, int val, Base **base, Object **ob)
Definition scene.cc:2268
void BKE_scene_ppm_get(const RenderData *rd, double r_ppm[2])
Definition scene.cc:3487
int BKE_render_num_threads(const RenderData *r)
Definition scene.cc:3141
bool BKE_scene_multiview_is_render_view_first(const RenderData *rd, const char *viewname)
Definition scene.cc:3267
const char * BKE_scene_find_last_marker_name(const Scene *scene, int frame)
Definition scene.cc:2514
bool BKE_scene_uses_blender_eevee(const Scene *scene)
Definition scene.cc:3077
float BKE_scene_frame_get(const Scene *scene)
Definition scene.cc:2595
int BKE_scene_orientation_get_index_from_flag(Scene *scene, int flag)
Definition scene.cc:2684
TransformOrientationSlot * BKE_scene_orientation_slot_get(Scene *scene, int slot_index)
Definition scene.cc:2639
ToolSettings * BKE_toolsettings_copy(ToolSettings *toolsettings, int flag)
Definition scene.cc:1746
void BKE_scene_object_base_flag_sync_from_base(Base *base)
Definition scene.cc:3111
void BKE_scene_free_depsgraph_hash(Scene *scene)
Definition scene.cc:3548
const char * BKE_scene_multiview_view_id_suffix_get(const RenderData *rd, int view_id)
Definition scene.cc:3407
void BKE_scene_graph_update_tagged(Depsgraph *depsgraph, Main *bmain)
Definition scene.cc:2867
Scene * BKE_scene_add(Main *bmain, const char *name)
Definition scene.cc:2200
VectorList< DupliObject > DupliList
bool BKE_scene_multiview_is_render_view_last(const RenderData *rd, const char *viewname)
Definition scene.cc:3286
SceneRenderView * BKE_scene_multiview_render_view_findindex(const RenderData *rd, int view_id)
Definition scene.cc:3305
Scene * BKE_scene_find_from_collection(const Main *bmain, const Collection *collection)
Definition scene.cc:2427
bool BKE_scene_multiview_is_stereo3d(const RenderData *rd)
Definition scene.cc:3224
TransformOrientation * BKE_scene_transform_orientation_find(const Scene *scene, int index)
Definition scene.cc:3753
void BKE_scene_multiview_videos_dimensions_get(const RenderData *rd, const ImageFormatData *imf, size_t width, size_t height, size_t *r_width, size_t *r_height)
Definition scene.cc:3448
bool BKE_scene_uses_shader_previews(const Scene *scene)
Definition scene.cc:3092
int BKE_scene_transform_orientation_get_index(const Scene *scene, const TransformOrientation *orientation)
Definition scene.cc:3758
void BKE_scene_transform_orientation_remove(Scene *scene, TransformOrientation *orientation)
Definition scene.cc:3733
SceneRenderView * BKE_scene_add_render_view(Scene *sce, const char *name)
Definition scene.cc:2965
int BKE_scene_multiview_num_videos_get(const RenderData *rd, const ImageFormatData *imf)
Definition scene.cc:3469
void BKE_scene_set_background(Main *bmain, Scene *sce)
Definition scene.cc:2233
Object * BKE_scene_camera_switch_find(const Scene *scene, const int time)
Definition scene.cc:2440
bool BKE_scene_uses_blender_workbench(const Scene *scene)
Definition scene.cc:3082
float BKE_scene_ctime_get(const Scene *scene)
Definition scene.cc:2581
void BKE_scene_orientation_slot_set_index(TransformOrientationSlot *orient_slot, int orientation)
Definition scene.cc:2664
void BKE_scene_undo_depsgraphs_restore(Main *bmain, GHash *depsgraph_extract)
Definition scene.cc:3696
bool BKE_scene_camera_switch_update(Scene *scene)
Definition scene.cc:2480
bool BKE_scene_uses_cycles(const Scene *scene)
Definition scene.cc:3087
void BKE_scene_base_flag_to_objects(const Main &bmain, const Scene *scene, ViewLayer *view_layer)
Definition scene.cc:3103
bool BKE_scene_object_find(const Main &bmain, Scene *scene, Object *ob)
Definition scene.cc:2209
float BKE_scene_frame_snap_by_seconds(const Scene *scene, double interval_in_seconds, float frame)
Definition scene.cc:2532
bool BKE_scene_remove_render_view(Scene *scene, SceneRenderView *srv)
Definition scene.cc:2984
TransformOrientationSlot * BKE_scene_orientation_slot_get_from_flag(Scene *scene, int flag)
Definition scene.cc:2647
GHash * BKE_scene_undo_depsgraphs_extract(Main *bmain)
Definition scene.cc:3667
int BKE_scene_orientation_slot_get_index(const TransformOrientationSlot *orient_slot)
Definition scene.cc:2671
void BKE_scene_copy_data_eevee(Scene *sce_dst, const Scene *sce_src)
Definition scene.cc:1911
Depsgraph * BKE_scene_ensure_depsgraph(Main *bmain, Scene *scene, ViewLayer *view_layer)
Definition scene.cc:3644
Base * _setlooper_base_step(const Main &bmain, Scene **sce_iter, ViewLayer *view_layer, Base *base)
Definition scene.cc:3032
void BKE_scene_update_sound(Depsgraph *depsgraph, Main *bmain)
Definition scene.cc:2750
void BKE_scene_groups_relink(Scene *sce)
Definition scene.cc:2143
Object * BKE_scene_object_find_by_name(const Main &bmain, const Scene *scene, const char *name)
Definition scene.cc:2220
void BKE_scene_multiview_view_filepath_get(const RenderData *rd, const char *filepath, const char *view, char *r_filepath)
Definition scene.cc:3369
void BKE_scene_graph_update_for_newframe_ex(Depsgraph *depsgraph, bool clear_recalc)
Definition scene.cc:2877
void BKE_scene_multiview_view_prefix_get(const Scene *scene, const char *filepath, char *r_prefix, const char **r_ext)
Definition scene.cc:3417
bool BKE_scene_check_rigidbody_active(const Scene *scene)
Definition scene.cc:3135
const char * BKE_scene_find_marker_name(const Scene *scene, int frame)
Definition scene.cc:2491
Scene * BKE_scene_duplicate(Main *bmain, Scene *sce, eSceneCopyMethod type, eDupli_ID_Flags duplicate_flags, uint duplicate_options)
Definition scene.cc:1917
int get_render_child_particle_number(const RenderData *r, int child_num, bool for_render)
Definition scene.cc:3019
DupliObject * dupob
Definition BKE_scene.hh:83
bool contains(const int frame) const
Definition BKE_scene.hh:205