Removed the omat matrix from DupliObject.
[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 bglMats;
44 struct Main;
45 struct Object;
46 struct QuicktimeCodecData;
47 struct RenderData;
48 struct SceneRenderLayer;
49 struct Scene;
50 struct Text;
51 struct Main;
52
53 #define SCE_COPY_NEW        0
54 #define SCE_COPY_EMPTY      1
55 #define SCE_COPY_LINK_OB    2
56 #define SCE_COPY_LINK_DATA  3
57 #define SCE_COPY_FULL       4
58
59 /* Use as the contents of a 'for' loop: for (SETLOOPER(...)) { ... */
60 #define SETLOOPER(_sce_basis, _sce_iter, _base)                               \
61         _sce_iter = _sce_basis, _base = _setlooper_base_step(&_sce_iter, NULL);   \
62         _base;                                                                    \
63         _base = _setlooper_base_step(&_sce_iter, _base)
64
65 struct Base *_setlooper_base_step(struct Scene **sce_iter, struct Base *base);
66
67 void free_avicodecdata(struct AviCodecData *acd);
68 void free_qtcodecdata(struct QuicktimeCodecData *acd);
69
70 void BKE_scene_free(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(struct Scene *scene, struct Object *ob);
75 struct Base *BKE_scene_base_add(struct Scene *sce, struct Object *ob);
76 void         BKE_scene_base_unlink(struct Scene *sce, struct Base *base);
77 void         BKE_scene_base_deselect_all(struct Scene *sce);
78 void         BKE_scene_base_select(struct Scene *sce, struct Base *selbase);
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         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 Scene *BKE_scene_copy(struct Scene *sce, int type);
100 void BKE_scene_groups_relink(struct Scene *sce);
101 void BKE_scene_unlink(struct Main *bmain, struct Scene *sce, struct Scene *newsce);
102
103 struct Object *BKE_scene_camera_find(struct Scene *sc);
104 struct Object *BKE_scene_camera_switch_find(struct Scene *scene); // DURIAN_CAMERA_SWITCH
105 int BKE_scene_camera_switch_update(struct Scene *scene);
106
107 char *BKE_scene_find_marker_name(struct Scene *scene, int frame);
108 char *BKE_scene_find_last_marker_name(struct Scene *scene, int frame);
109
110 /* checks for cycle, returns 1 if it's all OK */
111 int BKE_scene_validate_setscene(struct Main *bmain, struct Scene *sce);
112
113 float BKE_scene_frame_get(struct Scene *scene);
114 float BKE_scene_frame_get_from_ctime(struct Scene *scene, const float frame);
115 void  BKE_scene_frame_set(struct Scene *scene, double cfra);
116
117 /* **  Scene evaluation ** */
118 void BKE_scene_update_tagged(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce);
119 void BKE_scene_update_for_newframe(struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce, unsigned int lay);
120
121 struct SceneRenderLayer *BKE_scene_add_render_layer(struct Scene *sce, const char *name);
122 int BKE_scene_remove_render_layer(struct Main *main, struct Scene *scene, struct SceneRenderLayer *srl);
123
124 /* render profile */
125 int get_render_subsurf_level(struct RenderData *r, int level);
126 int get_render_child_particle_number(struct RenderData *r, int num);
127 int get_render_shadow_samples(struct RenderData *r, int samples);
128 float get_render_aosss_error(struct RenderData *r, float error);
129
130 int BKE_scene_use_new_shading_nodes(struct Scene *scene);
131
132 void BKE_scene_disable_color_management(struct Scene *scene);
133 int BKE_scene_check_color_management_enabled(const struct Scene *scene);
134 int BKE_scene_check_rigidbody_active(const struct Scene *scene);
135
136 int BKE_scene_num_threads(const struct Scene *scene);
137 int BKE_render_num_threads(const struct RenderData *r);
138
139 #ifdef __cplusplus
140 }
141 #endif
142
143 #endif
144