BKE_scene.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once

 
#include "BLI_sys_types.h"
 
#include "BKE_duplilist.hh"
 
#include "DNA_userdef_enums.h"
 
struct Base;
struct Collection;
struct Depsgraph;
struct ImageFormatData;
struct GHash;
struct Main;
struct Object;
struct RenderData;
struct Scene;
struct SceneRenderView;
struct ToolSettings;
struct TransformOrientation;
struct TransformOrientationSlot;
struct UnitSettings;
struct ViewLayer;
 
enum eSceneCopyMethod {
  SCE_COPY_NEW = 0,
  SCE_COPY_EMPTY = 1,
  SCE_COPY_LINK_COLLECTION = 2,
  SCE_COPY_FULL = 3,
};

#define SETLOOPER(_sce_basis, _sce_iter, _base) \
  _sce_iter = _sce_basis, \
  _base = _setlooper_base_step( \
      &_sce_iter, BKE_view_layer_context_active_PLACEHOLDER(_sce_basis), NULL); \
  _base; \
  _base = _setlooper_base_step(&_sce_iter, NULL, _base)
 
#define SETLOOPER_VIEW_LAYER(_sce_basis, _view_layer, _sce_iter, _base) \
  _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, _view_layer, NULL); \
  _base; \
  _base = _setlooper_base_step(&_sce_iter, NULL, _base)
 
#define SETLOOPER_SET_ONLY(_sce_basis, _sce_iter, _base) \
  _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL, NULL); \
  _base; \
  _base = _setlooper_base_step(&_sce_iter, NULL, _base)

Base *_setlooper_base_step(Scene **sce_iter, ViewLayer *view_layer, Base *base);
 
Scene *BKE_scene_add(Main *bmain, const char *name);
 
void BKE_scene_remove_rigidbody_object(Main *bmain, Scene *scene, Object *ob, bool free_us);

bool BKE_scene_object_find(Scene *scene, Object *ob);
Object *BKE_scene_object_find_by_name(const Scene *scene, const char *name);
 
/* Scene base iteration function.
 * Define struct here, so no need to bother with alloc/free it.
 */
struct SceneBaseIter {
  DupliList duplilist;
  DupliObject *dupob;
  int dupob_index;
  float omat[4][4];
  Object *dupli_refob;
  int phase;
};

int BKE_scene_base_iter_next(
    Depsgraph *depsgraph, SceneBaseIter *iter, Scene **scene, int val, Base **base, Object **ob);
 
void BKE_scene_base_flag_to_objects(const Scene *scene, ViewLayer *view_layer);
void BKE_scene_object_base_flag_sync_from_base(Base *base);

void BKE_scene_set_background(Main *bmain, Scene *sce);
Scene *BKE_scene_set_name(Main *bmain, const char *name);

ToolSettings *BKE_toolsettings_copy(ToolSettings *toolsettings, int flag);
void BKE_toolsettings_free(ToolSettings *toolsettings);
 
Scene *BKE_scene_duplicate(Main *bmain,
                           Scene *sce,
                           eSceneCopyMethod type,
                           eDupli_ID_Flags duplicate_flags,
                           /*eLibIDDuplicateFlags*/ uint duplicate_options);
void BKE_scene_groups_relink(Scene *sce);
 
bool BKE_scene_can_be_removed(const Main *bmain, const Scene *scene);
 
bool BKE_scene_has_view_layer(const Scene *scene, const ViewLayer *layer);
Scene *BKE_scene_find_from_collection(const Main *bmain, const Collection *collection);
 
Object *BKE_scene_camera_switch_find(Scene *scene);
bool BKE_scene_camera_switch_update(Scene *scene);
 
const char *BKE_scene_find_marker_name(const Scene *scene, int frame);
const char *BKE_scene_find_last_marker_name(const Scene *scene, int frame);
 
float BKE_scene_frame_snap_by_seconds(const Scene *scene, double interval_in_seconds, float frame);

bool BKE_scene_validate_setscene(Main *bmain, Scene *sce);

float BKE_scene_ctime_get(const Scene *scene);
float BKE_scene_frame_to_ctime(const Scene *scene, int frame);

float BKE_scene_frame_get(const Scene *scene);
void BKE_scene_frame_set(Scene *scene, float frame);
 
TransformOrientationSlot *BKE_scene_orientation_slot_get_from_flag(Scene *scene, int flag);
TransformOrientationSlot *BKE_scene_orientation_slot_get(Scene *scene, int slot_index);
void BKE_scene_orientation_slot_set_index(TransformOrientationSlot *orient_slot, int orientation);
int BKE_scene_orientation_slot_get_index(const TransformOrientationSlot *orient_slot);
int BKE_scene_orientation_get_index(Scene *scene, int slot_index);
int BKE_scene_orientation_get_index_from_flag(Scene *scene, int flag);
 
/* **  Scene evaluation ** */
 
void BKE_scene_update_sound(Depsgraph *depsgraph, Main *bmain);
void BKE_scene_update_tag_audio_volume(Depsgraph *, Scene *scene);
 
void BKE_scene_graph_update_tagged(Depsgraph *depsgraph, Main *bmain);
void BKE_scene_graph_evaluated_ensure(Depsgraph *depsgraph, Main *bmain);
 
void BKE_scene_graph_update_for_newframe(Depsgraph *depsgraph);
void BKE_scene_graph_update_for_newframe_ex(Depsgraph *depsgraph, bool clear_recalc);

void BKE_scene_view_layer_graph_evaluated_ensure(Main *bmain, Scene *scene, ViewLayer *view_layer);

SceneRenderView *BKE_scene_add_render_view(Scene *sce, const char *name);
bool BKE_scene_remove_render_view(Scene *scene, SceneRenderView *srv);
 
/* Render profile. */
 
int get_render_subsurf_level(const RenderData *r, int lvl, bool for_render);
int get_render_child_particle_number(const RenderData *r, int child_num, bool for_render);
 
bool BKE_scene_use_shading_nodes_custom(Scene *scene);
bool BKE_scene_use_spherical_stereo(Scene *scene);
 
bool BKE_scene_uses_blender_eevee(const Scene *scene);
bool BKE_scene_uses_blender_workbench(const Scene *scene);
bool BKE_scene_uses_cycles(const Scene *scene);
 
bool BKE_scene_uses_shader_previews(const Scene *scene);
 
void BKE_scene_copy_data_eevee(Scene *sce_dst, const Scene *sce_src);
 
void BKE_scene_disable_color_management(Scene *scene);
bool BKE_scene_check_rigidbody_active(const Scene *scene);
 
int BKE_scene_num_threads(const Scene *scene);
int BKE_render_num_threads(const RenderData *r);
 
void BKE_render_resolution(const RenderData *r, const bool use_crop, int *r_width, int *r_height);
int BKE_render_preview_pixel_size(const RenderData *r);
 
/**********************************/
 
/* Multi-view. */
 
bool BKE_scene_multiview_is_stereo3d(const RenderData *rd);
bool BKE_scene_multiview_is_render_view_active(const RenderData *rd, const SceneRenderView *srv);
bool BKE_scene_multiview_is_render_view_first(const RenderData *rd, const char *viewname);
bool BKE_scene_multiview_is_render_view_last(const RenderData *rd, const char *viewname);
int BKE_scene_multiview_num_views_get(const RenderData *rd);
SceneRenderView *BKE_scene_multiview_render_view_findindex(const RenderData *rd, int view_id);
const char *BKE_scene_multiview_render_view_name_get(const RenderData *rd, int view_id);
int BKE_scene_multiview_view_id_get(const RenderData *rd, const char *viewname);
void BKE_scene_multiview_filepath_get(const SceneRenderView *srv,
                                      const char *filepath,
                                      char *r_filepath);
void BKE_scene_multiview_view_filepath_get(const RenderData *rd,
                                           const char *filepath,
                                           const char *view,
                                           char *r_filepath);
const char *BKE_scene_multiview_view_suffix_get(const RenderData *rd, const char *viewname);
const char *BKE_scene_multiview_view_id_suffix_get(const RenderData *rd, int view_id);
void BKE_scene_multiview_view_prefix_get(Scene *scene,
                                         const char *filepath,
                                         char *r_prefix,
                                         const char **r_ext);
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);
int BKE_scene_multiview_num_videos_get(const RenderData *rd, const ImageFormatData *imf);
void BKE_scene_ppm_get(const RenderData *rd, double r_ppm[2]);
 
/* depsgraph */
void BKE_scene_allocate_depsgraph_hash(Scene *scene);
void BKE_scene_ensure_depsgraph_hash(Scene *scene);
void BKE_scene_free_depsgraph_hash(Scene *scene);
void BKE_scene_free_view_layer_depsgraph(Scene *scene, ViewLayer *view_layer);

Depsgraph *BKE_scene_get_depsgraph(const Scene *scene, const ViewLayer *view_layer);
Depsgraph *BKE_scene_ensure_depsgraph(Main *bmain, Scene *scene, ViewLayer *view_layer);
 
GHash *BKE_scene_undo_depsgraphs_extract(Main *bmain);
void BKE_scene_undo_depsgraphs_restore(Main *bmain, GHash *depsgraph_extract);
 
void BKE_scene_transform_orientation_remove(Scene *scene, TransformOrientation *orientation);
TransformOrientation *BKE_scene_transform_orientation_find(const Scene *scene, int index);
int BKE_scene_transform_orientation_get_index(const Scene *scene,
                                              const TransformOrientation *orientation);