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