Splash: Increase contrast of build info text
[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 BaseLegacy;
42 struct Depsgraph;
43 struct EvaluationContext;
44 struct Main;
45 struct Object;
46 struct Base;
47 struct QuicktimeCodecData;
48 struct RenderData;
49 struct SceneLayer;
50 struct SceneRenderLayer;
51 struct Scene;
52 struct SceneCollection;
53 struct SceneLayer;
54 struct UnitSettings;
55 struct Main;
56
57 typedef enum eSceneCopyMethod {
58         SCE_COPY_NEW       = 0,
59         SCE_COPY_EMPTY     = 1,
60         SCE_COPY_LINK_OB   = 2,
61         SCE_COPY_LINK_DATA = 3,
62         SCE_COPY_FULL      = 4,
63 } eSceneCopyMethod;
64
65 /* Use as the contents of a 'for' loop: for (SETLOOPER(...)) { ... */
66 #define SETLOOPER(_sce_basis, _sce_iter, _base)                               \
67         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL);   \
68         _base;                                                                    \
69         _base = _setlooper_base_step(&_sce_iter, _base)
70
71 struct Base *_setlooper_base_step(struct Scene **sce_iter, struct Base *base);
72
73 void free_avicodecdata(struct AviCodecData *acd);
74 void free_qtcodecdata(struct QuicktimeCodecData *acd);
75
76 void BKE_scene_free_ex(struct Scene *sce, const bool do_id_user);
77 void BKE_scene_free(struct Scene *sce);
78 void BKE_scene_init(struct Scene *sce);
79 struct Scene *BKE_scene_add(struct Main *bmain, const char *name);
80
81 void BKE_scene_remove_rigidbody_object(struct Scene *scene, struct Object *ob);
82
83 /* base functions */
84 struct BaseLegacy *BKE_scene_base_find_by_name(struct Scene *scene, const char *name);
85 struct BaseLegacy *BKE_scene_base_find(struct Scene *scene, struct Object *ob);
86 struct BaseLegacy *BKE_scene_base_add(struct Scene *sce, struct Object *ob);
87 void         BKE_scene_base_unlink(struct Scene *sce, struct BaseLegacy *base);
88 void         BKE_scene_base_deselect_all(struct Scene *sce);
89 void         BKE_scene_base_select(struct Scene *sce, struct BaseLegacy *selbase);
90
91 /* Scene base iteration function.
92  * Define struct here, so no need to bother with alloc/free it.
93  */
94 typedef struct SceneBaseIter {
95         struct ListBase *duplilist;
96         struct DupliObject *dupob;
97         float omat[4][4];
98         struct Object *dupli_refob;
99         int phase;
100 } SceneBaseIter;
101
102 int BKE_scene_base_iter_next(
103         const struct EvaluationContext *eval_ctx, struct SceneBaseIter *iter,
104         struct Scene **scene, int val, struct BaseLegacy **base, struct Object **ob);
105
106 void BKE_scene_base_flag_to_objects(struct SceneLayer *sl);
107 void BKE_scene_base_flag_from_objects(struct Scene *scene);
108 void BKE_scene_base_flag_sync_from_base(struct BaseLegacy *base);
109 void BKE_scene_base_flag_sync_from_object(struct BaseLegacy *base);
110 void BKE_scene_object_base_flag_sync_from_base(struct Base *base);
111 void BKE_scene_object_base_flag_sync_from_object(struct Base *base);
112
113 void BKE_scene_set_background(struct Main *bmain, struct Scene *sce);
114 struct Scene *BKE_scene_set_name(struct Main *bmain, const char *name);
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 struct Object *BKE_scene_camera_find(struct Scene *sc);
125 #ifdef DURIAN_CAMERA_SWITCH
126 struct Object *BKE_scene_camera_switch_find(struct Scene *scene); // DURIAN_CAMERA_SWITCH
127 #endif
128 int BKE_scene_camera_switch_update(struct Scene *scene);
129
130 char *BKE_scene_find_marker_name(struct Scene *scene, int frame);
131 char *BKE_scene_find_last_marker_name(struct Scene *scene, int frame);
132
133 /* checks for cycle, returns 1 if it's all OK */
134 bool BKE_scene_validate_setscene(struct Main *bmain, struct Scene *sce);
135
136 float BKE_scene_frame_get(const struct Scene *scene);
137 float BKE_scene_frame_get_from_ctime(const struct Scene *scene, const float frame);
138 void  BKE_scene_frame_set(struct Scene *scene, double cfra);
139
140 /* **  Scene evaluation ** */
141 void BKE_scene_update_tagged(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce);
142 void BKE_scene_update_for_newframe(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce);
143
144 struct SceneRenderLayer *BKE_scene_add_render_layer(struct Scene *sce, const char *name);
145 bool BKE_scene_remove_render_layer(struct Main *main, struct Scene *scene, struct SceneRenderLayer *srl);
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 double BKE_scene_unit_scale(const struct UnitSettings *unit, const int unit_type, double value);
175
176 /* multiview */
177 bool        BKE_scene_multiview_is_stereo3d(const struct RenderData *rd);
178 bool        BKE_scene_multiview_is_render_view_active(const struct RenderData *rd, const struct SceneRenderView *srv);
179 bool        BKE_scene_multiview_is_render_view_first(const struct RenderData *rd, const char *viewname);
180 bool        BKE_scene_multiview_is_render_view_last(const struct RenderData *rd, const char *viewname);
181 int         BKE_scene_multiview_num_views_get(const struct RenderData *rd);
182 struct SceneRenderView *BKE_scene_multiview_render_view_findindex(const struct RenderData *rd, const int view_id);
183 const char *BKE_scene_multiview_render_view_name_get(const struct RenderData *rd, const int view_id);
184 int         BKE_scene_multiview_view_id_get(const struct RenderData *rd, const char *viewname);
185 void        BKE_scene_multiview_filepath_get(struct SceneRenderView *srv, const char *filepath, char *r_filepath);
186 void        BKE_scene_multiview_view_filepath_get(const struct RenderData *rd, const char *filepath, const char *view, char *r_filepath);
187 const char *BKE_scene_multiview_view_suffix_get(const struct RenderData *rd, const char *viewname);
188 const char *BKE_scene_multiview_view_id_suffix_get(const struct RenderData *rd, const int view_id);
189 void        BKE_scene_multiview_view_prefix_get(struct Scene *scene, const char *name, char *rprefix, const char **rext);
190 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);
191 int         BKE_scene_multiview_num_videos_get(const struct RenderData *rd);
192
193 /* depsgraph */
194 struct Depsgraph* BKE_scene_get_depsgraph(struct Scene *scene, struct SceneLayer *scene_layer);
195
196 #ifdef __cplusplus
197 }
198 #endif
199
200 #endif
201