Merged changes in the trunk up to revision 42116.
[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 bglMats;
43 struct Main;
44 struct Object;
45 struct QuicktimeCodecData;
46 struct RenderData;
47 struct SceneRenderLayer;
48 struct Scene;
49 struct Text;
50 struct Text;
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 #define SETLOOPER(_sce_basis, _sce_iter, _base) _sce_iter= _sce_basis, _base= _setlooper_base_step(&_sce_iter, NULL); _base; _base= _setlooper_base_step(&_sce_iter, _base)
59 struct Base *_setlooper_base_step(struct Scene **sce_iter, struct Base *base);
60
61 void free_avicodecdata(struct AviCodecData *acd);
62 void free_qtcodecdata(struct QuicktimeCodecData *acd);
63
64 void free_scene(struct Scene *sce);
65 struct Scene *add_scene(const char *name);
66 struct Base *object_in_scene(struct Object *ob, struct Scene *sce);
67
68 void set_scene_bg(struct Main *bmain, struct Scene *sce);
69 struct Scene *set_scene_name(struct Main *bmain, const char *name);
70
71 struct Scene *copy_scene(struct Scene *sce, int type);
72 void unlink_scene(struct Main *bmain, struct Scene *sce, struct Scene *newsce);
73
74 int next_object(struct Scene **scene, int val, struct Base **base, struct Object **ob);
75 struct Object *scene_find_camera(struct Scene *sc);
76 struct Object *scene_camera_switch_find(struct Scene *scene); // DURIAN_CAMERA_SWITCH
77 int scene_camera_switch_update(struct Scene *scene);
78
79 char *scene_find_marker_name(struct Scene *scene, int frame);
80 char *scene_find_last_marker_name(struct Scene *scene, int frame);
81
82 struct Base *scene_add_base(struct Scene *sce, struct Object *ob);
83 void scene_deselect_all(struct Scene *sce);
84 void scene_select_base(struct Scene *sce, struct Base *selbase);
85
86 /* checks for cycle, returns 1 if it's all OK */
87 int scene_check_setscene(struct Main *bmain, struct Scene *sce);
88
89 float BKE_curframe(struct Scene *scene);
90 float BKE_frame_to_ctime(struct Scene *scene, const float frame);
91
92 void scene_update_tagged(struct Main *bmain, struct Scene *sce);
93 void scene_clear_tagged(struct Main *bmain, struct Scene *sce);
94
95 void scene_update_for_newframe(struct Main *bmain, struct Scene *sce, unsigned int lay);
96
97 struct SceneRenderLayer *scene_add_render_layer(struct Scene *sce, const char *name);
98 int scene_remove_render_layer(struct Main *main, struct Scene *scene, struct SceneRenderLayer *srl);
99
100 /* render profile */
101 int get_render_subsurf_level(struct RenderData *r, int level);
102 int get_render_child_particle_number(struct RenderData *r, int num);
103 int get_render_shadow_samples(struct RenderData *r, int samples);
104 float get_render_aosss_error(struct RenderData *r, float error);
105
106 int scene_use_new_shading_nodes(struct Scene *scene);
107
108 #ifdef __cplusplus
109 }
110 #endif
111
112 #endif
113