ID-Remap - Step one: core work (cleanup and rework of generic ID datablock handling).
[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 Base;
42 struct EvaluationContext;
43 struct Main;
44 struct Object;
45 struct QuicktimeCodecData;
46 struct RenderData;
47 struct SceneRenderLayer;
48 struct Scene;
49 struct UnitSettings;
50 struct Main;
51
52 #define SCE_COPY_NEW        0
53 #define SCE_COPY_EMPTY      1
54 #define SCE_COPY_LINK_OB    2
55 #define SCE_COPY_LINK_DATA  3
56 #define SCE_COPY_FULL       4
57
58 /* Use as the contents of a 'for' loop: for (SETLOOPER(...)) { ... */
59 #define SETLOOPER(_sce_basis, _sce_iter, _base)                               \
60         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL);   \
61         _base;                                                                    \
62         _base = _setlooper_base_step(&_sce_iter, _base)
63
64 struct Base *_setlooper_base_step(struct Scene **sce_iter, struct Base *base);
65
66 void free_avicodecdata(struct AviCodecData *acd);
67 void free_qtcodecdata(struct QuicktimeCodecData *acd);
68
69 void BKE_scene_free(struct Scene *sce);
70 void BKE_scene_init(struct Scene *sce);
71 struct Scene *BKE_scene_add(struct Main *bmain, const char *name);
72
73 /* base functions */
74 struct Base *BKE_scene_base_find_by_name(struct Scene *scene, const char *name);
75 struct Base *BKE_scene_base_find(struct Scene *scene, struct Object *ob);
76 struct Base *BKE_scene_base_add(struct Scene *sce, struct Object *ob);
77 void         BKE_scene_base_unlink(struct Scene *sce, struct Base *base);
78 void         BKE_scene_base_deselect_all(struct Scene *sce);
79 void         BKE_scene_base_select(struct Scene *sce, struct Base *selbase);
80
81 /* Scene base iteration function.
82  * Define struct here, so no need to bother with alloc/free it.
83  */
84 typedef struct SceneBaseIter {
85         struct ListBase *duplilist;
86         struct DupliObject *dupob;
87         float omat[4][4];
88         struct Object *dupli_refob;
89         int phase;
90 } SceneBaseIter;
91
92 int BKE_scene_base_iter_next(struct EvaluationContext *eval_ctx, 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 Scene *scene);
96 void BKE_scene_base_flag_from_objects(struct Scene *scene);
97
98 void BKE_scene_set_background(struct Main *bmain, struct Scene *sce);
99 struct Scene *BKE_scene_set_name(struct Main *bmain, const char *name);
100
101 struct Scene *BKE_scene_copy(struct Scene *sce, int type);
102 void BKE_scene_groups_relink(struct Scene *sce);
103
104 struct Object *BKE_scene_camera_find(struct Scene *sc);
105 #ifdef DURIAN_CAMERA_SWITCH
106 struct Object *BKE_scene_camera_switch_find(struct Scene *scene); // DURIAN_CAMERA_SWITCH
107 #endif
108 int BKE_scene_camera_switch_update(struct Scene *scene);
109
110 char *BKE_scene_find_marker_name(struct Scene *scene, int frame);
111 char *BKE_scene_find_last_marker_name(struct Scene *scene, int frame);
112
113 /* checks for cycle, returns 1 if it's all OK */
114 bool BKE_scene_validate_setscene(struct Main *bmain, struct Scene *sce);
115
116 float BKE_scene_frame_get(const struct Scene *scene);
117 float BKE_scene_frame_get_from_ctime(const struct Scene *scene, const float frame);
118 void  BKE_scene_frame_set(struct Scene *scene, double cfra);
119
120 /* **  Scene evaluation ** */
121 void BKE_scene_update_tagged(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce);
122 void BKE_scene_update_for_newframe(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce, unsigned int lay);
123 void BKE_scene_update_for_newframe_ex(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce, unsigned int lay, bool do_invisible_flush);
124
125 struct SceneRenderLayer *BKE_scene_add_render_layer(struct Scene *sce, const char *name);
126 bool BKE_scene_remove_render_layer(struct Main *main, struct Scene *scene, struct SceneRenderLayer *srl);
127
128 struct SceneRenderView *BKE_scene_add_render_view(struct Scene *sce, const char *name);
129 bool BKE_scene_remove_render_view(struct Scene *scene, struct SceneRenderView *srv);
130
131 /* render profile */
132 int get_render_subsurf_level(const struct RenderData *r, int level, bool for_render);
133 int get_render_child_particle_number(const struct RenderData *r, int num, bool for_render);
134 int get_render_shadow_samples(const struct RenderData *r, int samples);
135 float get_render_aosss_error(const struct RenderData *r, float error);
136
137 bool BKE_scene_use_new_shading_nodes(const struct Scene *scene);
138 bool BKE_scene_use_shading_nodes_custom(struct Scene *scene);
139 bool BKE_scene_use_world_space_shading(struct Scene *scene);
140 bool BKE_scene_use_spherical_stereo(struct Scene *scene);
141
142 bool BKE_scene_uses_blender_internal(const struct Scene *scene);
143 bool BKE_scene_uses_blender_game(const struct Scene *scene);
144
145 void BKE_scene_disable_color_management(struct Scene *scene);
146 bool BKE_scene_check_color_management_enabled(const struct Scene *scene);
147 bool BKE_scene_check_rigidbody_active(const struct Scene *scene);
148
149 int BKE_scene_num_threads(const struct Scene *scene);
150 int BKE_render_num_threads(const struct RenderData *r);
151
152 double BKE_scene_unit_scale(const struct UnitSettings *unit, const int unit_type, double value);
153
154 /* multiview */
155 bool        BKE_scene_multiview_is_stereo3d(const struct RenderData *rd);
156 bool        BKE_scene_multiview_is_render_view_active(const struct RenderData *rd, const struct SceneRenderView *srv);
157 bool        BKE_scene_multiview_is_render_view_first(const struct RenderData *rd, const char *viewname);
158 bool        BKE_scene_multiview_is_render_view_last(const struct RenderData *rd, const char *viewname);
159 int         BKE_scene_multiview_num_views_get(const struct RenderData *rd);
160 struct SceneRenderView *BKE_scene_multiview_render_view_findindex(const struct RenderData *rd, const int view_id);
161 const char *BKE_scene_multiview_render_view_name_get(const struct RenderData *rd, const int view_id);
162 int         BKE_scene_multiview_view_id_get(const struct RenderData *rd, const char *viewname);
163 void        BKE_scene_multiview_filepath_get(struct SceneRenderView *srv, const char *filepath, char *r_filepath);
164 void        BKE_scene_multiview_view_filepath_get(const struct RenderData *rd, const char *filepath, const char *view, char *r_filepath);
165 const char *BKE_scene_multiview_view_suffix_get(const struct RenderData *rd, const char *viewname);
166 const char *BKE_scene_multiview_view_id_suffix_get(const struct RenderData *rd, const int view_id);
167 void        BKE_scene_multiview_view_prefix_get(struct Scene *scene, const char *name, char *rprefix, const char **rext);
168 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);
169 int         BKE_scene_multiview_num_videos_get(const struct RenderData *rd);
170
171 #ifdef __cplusplus
172 }
173 #endif
174
175 #endif
176