Cleanup: remove redundant doxygen \file argument
[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 \ingroup bke
23  */
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 struct AviCodecData;
30 struct Collection;
31 struct Depsgraph;
32 struct Main;
33 struct Object;
34 struct RenderData;
35 struct Scene;
36 struct TransformOrientation;
37 struct UnitSettings;
38 struct ViewLayer;
39 struct ViewRender;
40 struct WorkSpace;
41
42 typedef enum eSceneCopyMethod {
43         SCE_COPY_NEW       = 0,
44         SCE_COPY_EMPTY     = 1,
45         SCE_COPY_LINK_OB   = 2,
46         SCE_COPY_LINK_DATA = 3,
47         SCE_COPY_FULL      = 4,
48 } eSceneCopyMethod;
49
50 /* Use as the contents of a 'for' loop: for (SETLOOPER(...)) { ... */
51 #define SETLOOPER(_sce_basis, _sce_iter, _base)                               \
52         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, BKE_view_layer_context_active_PLACEHOLDER(_sce_basis), NULL); \
53         _base;                                                                    \
54         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
55
56 #define SETLOOPER_VIEW_LAYER(_sce_basis, _view_layer, _sce_iter, _base)     \
57         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, _view_layer, NULL);   \
58         _base;                                                                    \
59         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
60
61 #define SETLOOPER_SET_ONLY(_sce_basis, _sce_iter, _base)     \
62         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL, NULL);   \
63         _base;                                                                    \
64         _base = _setlooper_base_step(&_sce_iter, NULL, _base)
65
66 struct Base *_setlooper_base_step(struct Scene **sce_iter, struct ViewLayer *view_layer, struct Base *base);
67
68 void free_avicodecdata(struct AviCodecData *acd);
69
70 void BKE_scene_free_ex(struct Scene *sce, const bool do_id_user);
71 void BKE_scene_free(struct Scene *sce);
72 void BKE_scene_init(struct Scene *sce);
73 struct Scene *BKE_scene_add(struct Main *bmain, const char *name);
74
75 void BKE_scene_remove_rigidbody_object(struct Main *bmain, struct Scene *scene, struct Object *ob);
76
77 bool BKE_scene_object_find(struct Scene *scene, struct Object *ob);
78 struct Object *BKE_scene_object_find_by_name(struct Scene *scene, const char *name);
79
80 /* Scene base iteration function.
81  * Define struct here, so no need to bother with alloc/free it.
82  */
83 typedef struct SceneBaseIter {
84         struct ListBase *duplilist;
85         struct DupliObject *dupob;
86         float omat[4][4];
87         struct Object *dupli_refob;
88         int phase;
89 } SceneBaseIter;
90
91 int BKE_scene_base_iter_next(
92         struct Depsgraph *depsgraph, struct SceneBaseIter *iter,
93         struct Scene **scene, int val, struct Base **base, struct Object **ob);
94
95 void BKE_scene_base_flag_to_objects(struct ViewLayer *view_layer);
96 void BKE_scene_object_base_flag_sync_from_base(struct Base *base);
97 void BKE_scene_object_base_flag_sync_from_object(struct Base *base);
98
99 void BKE_scene_set_background(struct Main *bmain, struct Scene *sce);
100 struct Scene *BKE_scene_set_name(struct Main *bmain, const char *name);
101
102 struct ToolSettings *BKE_toolsettings_copy(struct ToolSettings *toolsettings, const int flag);
103 void BKE_toolsettings_free(struct ToolSettings *toolsettings);
104
105 void BKE_scene_copy_data(struct Main *bmain, struct Scene *sce_dst, const struct Scene *sce_src, const int flag);
106 struct Scene *BKE_scene_copy(struct Main *bmain, struct Scene *sce, int type);
107 void BKE_scene_groups_relink(struct Scene *sce);
108
109 void BKE_scene_make_local(struct Main *bmain, struct Scene *sce, const bool lib_local);
110
111 struct Scene *BKE_scene_find_from_collection(const struct Main *bmain, const struct Collection *collection);
112
113 #ifdef DURIAN_CAMERA_SWITCH
114 struct Object *BKE_scene_camera_switch_find(struct Scene *scene); // DURIAN_CAMERA_SWITCH
115 #endif
116 int BKE_scene_camera_switch_update(struct Scene *scene);
117
118 char *BKE_scene_find_marker_name(struct Scene *scene, int frame);
119 char *BKE_scene_find_last_marker_name(struct Scene *scene, int frame);
120
121 int BKE_scene_frame_snap_by_seconds(struct Scene *scene, double interval_in_seconds, int cfra);
122
123 /* checks for cycle, returns 1 if it's all OK */
124 bool BKE_scene_validate_setscene(struct Main *bmain, struct Scene *sce);
125
126 float BKE_scene_frame_get(const struct Scene *scene);
127 float BKE_scene_frame_get_from_ctime(const struct Scene *scene, const float frame);
128 void  BKE_scene_frame_set(struct Scene *scene, double cfra);
129
130 struct TransformOrientationSlot *BKE_scene_orientation_slot_get(struct Scene *scene, int flag);
131 void BKE_scene_orientation_slot_set_index(struct TransformOrientationSlot *orient_slot, int orientation);
132 int BKE_scene_orientation_slot_get_index(const struct TransformOrientationSlot *orient_slot);
133
134 /* **  Scene evaluation ** */
135
136 void BKE_scene_graph_update_tagged(struct Depsgraph *depsgraph,
137                                    struct Main *bmain);
138
139 void BKE_scene_graph_update_for_newframe(struct Depsgraph *depsgraph,
140                                          struct Main *bmain);
141
142 void BKE_scene_view_layer_graph_evaluated_ensure(
143         struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer);
144
145 struct SceneRenderView *BKE_scene_add_render_view(struct Scene *sce, const char *name);
146 bool BKE_scene_remove_render_view(struct Scene *scene, struct SceneRenderView *srv);
147
148 /* render profile */
149 int get_render_subsurf_level(const struct RenderData *r, int level, bool for_render);
150 int get_render_child_particle_number(const struct RenderData *r, int num, bool for_render);
151
152 bool BKE_scene_use_shading_nodes_custom(struct Scene *scene);
153 bool BKE_scene_use_spherical_stereo(struct Scene *scene);
154
155 bool BKE_scene_uses_blender_eevee(const struct Scene *scene);
156 bool BKE_scene_uses_blender_workbench(const struct Scene *scene);
157 bool BKE_scene_uses_cycles(const struct Scene *scene);
158
159 void BKE_scene_disable_color_management(struct Scene *scene);
160 bool BKE_scene_check_color_management_enabled(const struct Scene *scene);
161 bool BKE_scene_check_rigidbody_active(const struct Scene *scene);
162
163 int BKE_scene_num_threads(const struct Scene *scene);
164 int BKE_render_num_threads(const struct RenderData *r);
165
166 int BKE_render_preview_pixel_size(const struct RenderData *r);
167
168 /**********************************/
169
170 double BKE_scene_unit_scale(const struct UnitSettings *unit, const int unit_type, double value);
171
172 /* multiview */
173 bool        BKE_scene_multiview_is_stereo3d(const struct RenderData *rd);
174 bool        BKE_scene_multiview_is_render_view_active(const struct RenderData *rd, const struct SceneRenderView *srv);
175 bool        BKE_scene_multiview_is_render_view_first(const struct RenderData *rd, const char *viewname);
176 bool        BKE_scene_multiview_is_render_view_last(const struct RenderData *rd, const char *viewname);
177 int         BKE_scene_multiview_num_views_get(const struct RenderData *rd);
178 struct SceneRenderView *BKE_scene_multiview_render_view_findindex(const struct RenderData *rd, const int view_id);
179 const char *BKE_scene_multiview_render_view_name_get(const struct RenderData *rd, const int view_id);
180 int         BKE_scene_multiview_view_id_get(const struct RenderData *rd, const char *viewname);
181 void        BKE_scene_multiview_filepath_get(struct SceneRenderView *srv, const char *filepath, char *r_filepath);
182 void        BKE_scene_multiview_view_filepath_get(const struct RenderData *rd, const char *filepath, const char *view, char *r_filepath);
183 const char *BKE_scene_multiview_view_suffix_get(const struct RenderData *rd, const char *viewname);
184 const char *BKE_scene_multiview_view_id_suffix_get(const struct RenderData *rd, const int view_id);
185 void        BKE_scene_multiview_view_prefix_get(struct Scene *scene, const char *name, char *rprefix, const char **rext);
186 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);
187 int         BKE_scene_multiview_num_videos_get(const struct RenderData *rd);
188
189 /* depsgraph */
190 void BKE_scene_allocate_depsgraph_hash(struct Scene *scene);
191 void BKE_scene_ensure_depsgraph_hash(struct Scene *scene);
192 void BKE_scene_free_depsgraph_hash(struct Scene *scene);
193
194 struct Depsgraph *BKE_scene_get_depsgraph(struct Scene *scene, struct ViewLayer *view_layer, bool allocate);
195
196 void BKE_scene_transform_orientation_remove(
197         struct Scene *scene, struct TransformOrientation *orientation);
198 struct TransformOrientation *BKE_scene_transform_orientation_find(
199         const struct Scene *scene, const int index);
200 int BKE_scene_transform_orientation_get_index(
201         const struct Scene *scene, const struct TransformOrientation *orientation);
202
203 #ifdef __cplusplus
204 }
205 #endif
206
207 #endif