BGE: Add new world API KX_WorldInfo (KX_Scene)
[blender.git] / source / gameengine / Ketsji / KX_WorldInfo.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
28 /** \file KX_WorldInfo.h
29  *  \ingroup ketsji
30  */
31
32 #ifndef __KX_WORLDINFO_H__
33 #define __KX_WORLDINFO_H__
34
35 #include "MT_Scalar.h"
36 #include "KX_KetsjiEngine.h"
37 #include "PyObjectPlus.h"
38
39 #ifdef WITH_CXX_GUARDEDALLOC
40 #include "MEM_guardedalloc.h"
41 #endif
42
43 #ifdef USE_MATHUTILS
44 void KX_WorldInfo_Mathutils_Callback_Init(void);
45 #endif
46
47 struct Scene;
48 struct World;
49
50 class KX_WorldInfo : public PyObjectPlus
51 {
52         Py_Header
53
54         STR_String m_name;
55         bool m_do_color_management;
56         bool m_hasworld;
57         bool m_hasmist;
58         short m_misttype;
59         float m_miststart;
60         float m_mistdistance;
61         float m_mistintensity;
62         float m_mistcolor[3];
63         float m_backgroundcolor[3];
64         float m_ambientcolor[3];
65         float m_con_mistcolor[3];
66         float m_con_backgroundcolor[3];
67         float m_con_ambientcolor[3];
68
69 public:
70         /**
71          * Mist options
72          */
73         enum MistType {
74                 KX_MIST_QUADRATIC,
75                 KX_MIST_LINEAR,
76                 KX_MIST_INV_QUADRATIC,
77         };
78
79         KX_WorldInfo(Scene *blenderscene, World *blenderworld);
80         ~KX_WorldInfo();
81
82         const STR_String &GetName();
83         bool hasWorld();
84         bool hasMist();
85         short getMistType();
86         float getMistStart();
87         float getMistDistance();
88         float getMistIntensity();
89         float getMistColorRed();
90         float getMistColorGreen();
91         float getMistColorBlue();
92         float getBackColorRed();
93         float getBackColorGreen();
94         float getBackColorBlue();
95         float getAmbientColorRed();
96         float getAmbientColorGreen();
97         float getAmbientColorBlue();
98         void setUseMist(bool enable);
99         void setMistType(short type);
100         void setMistStart(float d);
101         void setMistDistance(float d);
102         void setMistIntensity(float intensity);
103         void setMistColor(float r, float g, float b);
104         void setBackColor(float r, float g, float b);
105         void setAmbientColor(float r, float g, float b);
106         void UpdateBackGround();
107         void UpdateWorldSettings();
108
109 #ifdef WITH_PYTHON
110         /* attributes */
111         static PyObject *pyattr_get_mist_typeconst(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
112         static PyObject *pyattr_get_mist_color(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
113         static int pyattr_set_mist_color(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
114         static PyObject *pyattr_get_back_color(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
115         static int pyattr_set_back_color(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
116         static PyObject *pyattr_get_ambient_color(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
117         static int pyattr_set_ambient_color(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
118         virtual PyObject *py_repr(void);
119 #endif
120
121 #ifdef WITH_CXX_GUARDEDALLOC
122         MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_WorldInfo")
123 #endif
124 };
125
126 #endif  /* __KX_WORLDINFO_H__ */