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
  37 #ifdef WITH_CXX_GUARDEDALLOC
  38 #include "MEM_guardedalloc.h"
  39 #endif
  40
  41 class MT_CmMatrix4x4;
  42
  43 class KX_WorldInfo
  44 {
  45 public:
  46         /**
  47          * Mist options
  48          */
  49         enum MistType {
  50                 KX_MIST_QUADRATIC,
  51                 KX_MIST_LINEAR,
  52                 KX_MIST_INV_QUADRATIC,
  53         };
  54
  55         KX_WorldInfo() {}
  56         virtual ~KX_WorldInfo();
  57
  58         virtual bool hasWorld() = 0;
  59         virtual bool hasMist() = 0;
  60         virtual float getBackColorRed() = 0;
  61         virtual float getBackColorGreen() = 0;
  62         virtual float getBackColorBlue() = 0;
  63         virtual short getMistType() = 0;
  64         virtual float getMistStart() = 0;
  65         virtual float getMistDistance() = 0;
  66         virtual float getMistIntensity() = 0;
  67         virtual float getMistColorRed() = 0;
  68         virtual float getMistColorGreen() = 0;
  69         virtual float getMistColorBlue() = 0;
  70
  71         virtual float getAmbientColorRed() = 0;
  72         virtual float getAmbientColorGreen() = 0;
  73         virtual float getAmbientColorBlue() = 0;
  74
  75         virtual void setUseMist(bool enable) = 0;
  76         virtual void setMistType(short) = 0;
  77         virtual void setMistStart(float) = 0;
  78         virtual void setMistDistance(float) = 0;
  79         virtual void setMistIntensity(float) = 0;
  80         virtual void setMistColor(float, float, float) = 0;
  81         virtual void setBackColor(float, float, float) = 0;
  82         virtual void setAmbientColor(float,float,float) = 0;
  83
  84
  85 #ifdef WITH_CXX_GUARDEDALLOC
  86         MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_WorldInfo")
  87 #endif
  88 };
  89
  90 #endif  /* __KX_WORLDINFO_H__ */