Blender Python API
[blender.git] / source / blender / blenkernel / BKE_scene.h
1 /**
2  * blenlib/BKE_scene.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef BKE_SCENE_H
32 #define BKE_SCENE_H
33
34 struct bglMats;
35 struct Scene;
36 struct Object;
37 struct Base;
38 struct Text;
39 struct AviCodecData;
40 struct QuicktimeCodecData;
41 struct SculptData;
42 struct RenderData;
43
44 /* sequence related defines */
45 #define WHILE_SEQ(base) {                                                                                       \
46         int totseq_, seq_; Sequence **seqar;    \
47                 build_seqar( base,  &seqar, &totseq_);  \
48                         for(seq_ = 0; seq_ < totseq_; seq_++) { \
49                                 seq= seqar[seq_];
50                                 
51                                 
52 #define END_SEQ                                 }                                               \
53                                 if(seqar) MEM_freeN(seqar);             \
54 }
55
56 /* note; doesn't work when scene is empty */
57 #define SETLOOPER(s, b) sce= s, b= (Base*)sce->base.first; b; b= (Base*)(b->next?b->next:sce->set?(sce=sce->set)->base.first:NULL)
58
59
60 void free_avicodecdata(struct AviCodecData *acd);
61 void free_qtcodecdata(struct QuicktimeCodecData *acd);
62
63 void free_scene(struct Scene *me);
64 struct Scene *add_scene(char *name);
65 struct Base *object_in_scene(struct Object *ob, struct Scene *sce);
66
67 void set_scene_bg(struct Scene *sce);
68 void set_scene_name(char *name);
69
70 int next_object(int val, struct Base **base, struct Object **ob);
71 struct Object *scene_find_camera(struct Scene *sc);
72
73 struct Base *scene_add_base(struct Scene *sce, struct Object *ob);
74 void scene_deselect_all(struct Scene *sce);
75 void scene_select_base(struct Scene *sce, struct Base *selbase);
76
77 /* checks for cycle, returns 1 if it's all OK */
78 int scene_check_setscene(struct Scene *sce);
79
80 void scene_update_for_newframe(struct Scene *sce, unsigned int lay);
81
82 void scene_add_render_layer(struct Scene *sce);
83
84 /* render profile */
85 int get_render_subsurf_level(struct RenderData *r, int level);
86 int get_render_child_particle_number(struct RenderData *r, int num);
87 int get_render_shadow_samples(struct RenderData *r, int samples);
88 float get_render_aosss_error(struct RenderData *r, float error);
89
90 void free_dome_warp_text(struct Text *txt);
91
92 #endif
93