Merge branch 'master' into blender2.8
[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 Collection;
42 struct Depsgraph;
43 struct Main;
44 struct Object;
45 struct RenderData;
46 struct Scene;
47 struct ViewLayer;
48 struct UnitSettings;
49 struct ViewRender;
50 struct WorkSpace;
51 struct TransformOrientation;
52
53 typedef enum eSceneCopyMethod {
54         SCE_COPY_NEW       = 0,
55         SCE_COPY_EMPTY     = 1,
56         SCE_COPY_LINK_OB   = 2,
57         SCE_COPY_LINK_DATA = 3,
58         SCE_COPY_FULL      = 4,
59 } eSceneCopyMethod;
60
61 /* Use as the contents of a 'for' loop: for (SETLOOPER(...)) { ... */
62 #define SETLOOPER(_sce_basis, _sce_iter, _base)                               \
63         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, BKE_view_layer_context_active_PLACEHOLDER(_sce_basis), NULL); \
64         _base;                                                                    \
65         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
66
67 #define SETLOOPER_VIEW_LAYER(_sce_basis, _view_layer, _sce_iter, _base)     \
68         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, _view_layer, NULL);   \
69         _base;                                                                    \
70         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
71
72 #define SETLOOPER_SET_ONLY(_sce_basis, _sce_iter, _base)     \
73         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL, NULL);   \
74         _base;                                                                    \
75         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
76
77 struct Base *_setlooper_base_step(struct Scene **sce_iter, struct ViewLayer *view_layer, struct Base *base);
78
79 void free_avicodecdata(struct AviCodecData *acd);
80
81 void BKE_scene_free_ex(struct Scene *sce, const bool do_id_user);
82 void BKE_scene_free(struct Scene *sce);
83 void BKE_scene_init(struct Scene *sce);
84 struct Scene *BKE_scene_add(struct Main *bmain, const char *name);
85
86 void BKE_scene_remove_rigidbody_object(struct Main *bmain, struct Scene *scene, struct Object *ob);
87
88 bool BKE_scene_object_find(struct Scene *scene, struct Object *ob);
89 struct Object *BKE_scene_object_find_by_name(struct Scene *scene, const char *name);
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         struct Depsgraph *depsgraph, struct SceneBaseIter *iter,
104         struct Scene **scene, int val, struct Base **base, struct Object **ob);
105
106 void BKE_scene_base_flag_to_objects(struct ViewLayer *view_layer);
107 void BKE_scene_base_flag_from_objects(struct Scene *scene);
108 void BKE_scene_object_base_flag_sync_from_base(struct Base *base);
109 void BKE_scene_object_base_flag_sync_from_object(struct Base *base);
110
111 void BKE_scene_set_background(struct Main *bmain, struct Scene *sce);
112 struct Scene *BKE_scene_set_name(struct Main *bmain, const char *name);
113
114 struct ToolSettings *BKE_toolsettings_copy(struct ToolSettings *toolsettings, const int flag);
115 void BKE_toolsettings_free(struct ToolSettings *toolsettings);
116
117 void BKE_scene_copy_data(struct Main *bmain, struct Scene *sce_dst, const struct Scene *sce_src, const int flag);
118 struct Scene *BKE_scene_copy(struct Main *bmain, struct Scene *sce, int type);
119 void BKE_scene_groups_relink(struct Scene *sce);
120
121 void BKE_scene_make_local(struct Main *bmain, struct Scene *sce, const bool lib_local);
122
123 struct Scene *BKE_scene_find_from_collection(const struct Main *bmain, const struct Collection *collection);
124
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 int BKE_scene_frame_snap_by_seconds(struct Scene *scene, double interval_in_seconds, int cfra);
134
135 /* checks for cycle, returns 1 if it's all OK */
136 bool BKE_scene_validate_setscene(struct Main *bmain, struct Scene *sce);
137
138 float BKE_scene_frame_get(const struct Scene *scene);
139 float BKE_scene_frame_get_from_ctime(const struct Scene *scene, const float frame);
140 void  BKE_scene_frame_set(struct Scene *scene, double cfra);
141
142 /* **  Scene evaluation ** */
143
144 void BKE_scene_graph_update_tagged(struct Depsgraph *depsgraph,
145                                    struct Main *bmain);
146
147 void BKE_scene_graph_update_for_newframe(struct Depsgraph *depsgraph,
148                                          struct Main *bmain);
149
150 void BKE_scene_view_layer_graph_evaluated_ensure(
151         struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer);
152
153 struct SceneRenderView *BKE_scene_add_render_view(struct Scene *sce, const char *name);
154 bool BKE_scene_remove_render_view(struct Scene *scene, struct SceneRenderView *srv);
155
156 /* render profile */
157 int get_render_subsurf_level(const struct RenderData *r, int level, bool for_render);
158 int get_render_child_particle_number(const struct RenderData *r, int num, bool for_render);
159
160 bool BKE_scene_use_shading_nodes_custom(struct Scene *scene);
161 bool BKE_scene_use_spherical_stereo(struct Scene *scene);
162
163 bool BKE_scene_uses_blender_eevee(const struct Scene *scene);
164 bool BKE_scene_uses_blender_workbench(const struct Scene *scene);
165 bool BKE_scene_uses_cycles(const struct Scene *scene);
166
167 void BKE_scene_disable_color_management(struct Scene *scene);
168 bool BKE_scene_check_color_management_enabled(const struct Scene *scene);
169 bool BKE_scene_check_rigidbody_active(const struct Scene *scene);
170
171 int BKE_scene_num_threads(const struct Scene *scene);
172 int BKE_render_num_threads(const struct RenderData *r);
173
174 int BKE_render_preview_pixel_size(const struct RenderData *r);
175
176 /**********************************/
177
178 double BKE_scene_unit_scale(const struct UnitSettings *unit, const int unit_type, double value);
179
180 /* multiview */
181 bool        BKE_scene_multiview_is_stereo3d(const struct RenderData *rd);
182 bool        BKE_scene_multiview_is_render_view_active(const struct RenderData *rd, const struct SceneRenderView *srv);
183 bool        BKE_scene_multiview_is_render_view_first(const struct RenderData *rd, const char *viewname);
184 bool        BKE_scene_multiview_is_render_view_last(const struct RenderData *rd, const char *viewname);
185 int         BKE_scene_multiview_num_views_get(const struct RenderData *rd);
186 struct SceneRenderView *BKE_scene_multiview_render_view_findindex(const struct RenderData *rd, const int view_id);
187 const char *BKE_scene_multiview_render_view_name_get(const struct RenderData *rd, const int view_id);
188 int         BKE_scene_multiview_view_id_get(const struct RenderData *rd, const char *viewname);
189 void        BKE_scene_multiview_filepath_get(struct SceneRenderView *srv, const char *filepath, char *r_filepath);
190 void        BKE_scene_multiview_view_filepath_get(const struct RenderData *rd, const char *filepath, const char *view, char *r_filepath);
191 const char *BKE_scene_multiview_view_suffix_get(const struct RenderData *rd, const char *viewname);
192 const char *BKE_scene_multiview_view_id_suffix_get(const struct RenderData *rd, const int view_id);
193 void        BKE_scene_multiview_view_prefix_get(struct Scene *scene, const char *name, char *rprefix, const char **rext);
194 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);
195 int         BKE_scene_multiview_num_videos_get(const struct RenderData *rd);
196
197 /* depsgraph */
198 void BKE_scene_allocate_depsgraph_hash(struct Scene *scene);
199 void BKE_scene_ensure_depsgraph_hash(struct Scene *scene);
200 void BKE_scene_free_depsgraph_hash(struct Scene *scene);
201
202 struct Depsgraph *BKE_scene_get_depsgraph(struct Scene *scene, struct ViewLayer *view_layer, bool allocate);
203
204 void BKE_scene_transform_orientation_remove(
205         struct Scene *scene, struct TransformOrientation *orientation);
206 struct TransformOrientation *BKE_scene_transform_orientation_find(
207         const struct Scene *scene, const int index);
208 int BKE_scene_transform_orientation_get_index(
209         const struct Scene *scene, const struct TransformOrientation *orientation);
210
211 #ifdef __cplusplus
212 }
213 #endif
214
215 #endif