VirtualRenderingSystem: fog.h Source File

00001  /**********************************************************************
00002  VRS - The Virtual Rendering System
00003  Copyright (C) 2001 Computer Graphics Systems Group at the 
00004  Hasso-Plattner-Institute, Potsdam, Germany.
00005  This library is free software; you can redistribute it and/or 
00006  modify it under the terms of the GNU Lesser General Public 
00007  License as published by the Free Software Foundation; either 
00008  version 2.1 of the License, or (at your option) any later version.
00009  This library is distributed in the hope that it will be useful, but 
00010  WITHOUT ANY WARRANTY; without even the implied warranty of 
00011  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
00012  See the GNU Lesser General Public License for more details.
00013  You should have received a copy of the GNU Lesser+ General Public
00014  License along with this library; if not, write to the FreeSoftware 
00015  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA, 02111-1307, USA.
00016  **********************************************************************/
00017 // $Id: fog.h 4633 2005-01-03 01:43:11Z klimetschek $
00018 // $Date: 2005-01-03 02:43:11 +0100 (Mon, 03 Jan 2005) $
00019 // $Revision: 4633 $
00020 // $State$
00021 // $Author: klimetschek $
00022 //
00023 // $Log$
00024 // Revision 1.18  2005/01/03 01:43:07  klimetschek
00025 // - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
00026 // - removed vrs.vcproj
00027 // minor things:
00028 // - added all glutexamples to vrs4glut.sln
00029 // - fixed some problems in glutexamples
00030 // - removed all project references from all VS projects (using solution wide project dependencies instead)
00031 //
00032 // Revision 1.17  2004/11/05 13:58:09  basch
00033 // Class comment changed (Doxygen style)
00034 //
00035 // Revision 1.16  2004/03/12 16:28:38  baumann
00036 // macros VRS_NAMESPACE_BEGIN/_END expanded and removed
00037 //
00038 // Revision 1.15  2004/01/28 15:20:30  neumann
00039 // serialization mechanism:
00040 // - adjusted method serialize for usage with new class SerializationManager
00041 //
00042 // Revision 1.14  2004/01/19 11:43:57  baumann
00043 // serialization mechanism improved
00044 //
00045 // Revision 1.13  2004/01/19 07:28:03  baumann
00046 // serialization mechanism improved
00047 //
00048 // Revision 1.12  2003/11/07 14:19:24  kirsch
00049 // removed leading underscore from include guards
00050 //
00051 // Revision 1.11  2002/10/29 10:32:52  baumann
00052 // macros VRS_CLASSNAME_* and VRS_IMPL_TYPEINFO_* removed
00053 //
00054 // Revision 1.10  2002/03/03 21:44:24  kosta
00055 // VRS_TYPEINFO-macro rewritten
00056 //
00057 // Revision 1.9  2002/02/19 10:34:08  kosta
00058 // undone all changes since 2002-02-15
00059 //
00060 // Revision 1.6  2002/02/05 07:48:25  kosta
00061 // new persistency macros:
00062 //     VRS_SERIALIZABLE(CLASS_NAME);
00063 //     VRS_SERIALIZABLE_ABSTRACT_CLASS(CLASS_NAME);
00064 //     VRS_SERIALIZABLE_NO_SO_CLASS(CLASS_NAME)
00065 //
00066 // Revision 1.5  2002/02/04 13:07:19  kosta
00067 // VRS_SERIALIZABLE macros completely rewritten
00068 //
00069 // Revision 1.4  2002/01/15 16:25:53  kosta
00070 // macros rewritten for a better namespace support
00071 //
00072 // Revision 1.3  2001/11/13 16:36:30  kirsch
00073 // changed line feed to unix style (removed control-M)
00074 //
00075 // Revision 1.2  2001/07/05 12:43:14  kersting
00076 // added enum name and set method parameters due to enum name
00077 //
00078 // Revision 1.1.1.1  2001/06/08 08:09:20  kirsch
00079 // imported alpha-version by olli 
00080 //
00081 
00082 
00083 #ifndef VRS_FOG_H
00084 #define VRS_FOG_H
00085 
00086 #include <vrs/color.h>
00087 #include <vrs/monoattribute.h>
00088 
00089 namespace VRS {
00090 
00092 class VRS_CORE_API Fog : public MonoAttribute {
00093 
00094 public:
00095     enum FogMode { Linear, Exp, Exp2 };
00096     VRS_SERIALIZABLE_CLASS_ENUM(FogMode);
00097 
00098     Fog(
00099         double density = 1,
00100         const Color& fogcolor = Color(0.7,0.7,0.7),
00101         FogMode mode = Fog::Linear,
00102         double start = 0.,
00103         double end = 1.
00104     );
00109     virtual void setColor(const Color&);
00110     virtual Color getColor() const;
00112 
00113     virtual void setMode(FogMode mode);
00114     virtual FogMode getMode() const;
00116 
00117     virtual void setDensity(double);
00118     virtual double getDensity() const;
00123     virtual void setStart(double);
00124     virtual double getStart() const;
00125 
00126     virtual void setEnd(double);
00127     virtual double getEnd() const;
00128 
00129     VRS_TYPEINFO(Fog, MonoAttribute);
00130     VRS_SERIALIZABLE(Fog);
00131 
00132 private:
00133     Color color_;
00134     double density_;
00135     FogMode mode_;
00136     double start_;
00137     double end_;
00138 };
00139 
00140 inline Color Fog::getColor() const { return color_; }
00141 inline double Fog::getDensity() const { return density_; }
00142 inline Fog::FogMode Fog::getMode() const { return (Fog::FogMode)mode_; }
00143 inline double Fog::getStart() const { return start_; }
00144 inline double Fog::getEnd() const { return end_; }
00145 
00146 } // namespace VRS
00147 
00148 #endif // VRS_FOG_H