CrystalSpace

Public API Reference

cstool/noise/module/const.h
00001 // const.h
00002 //
00003 // Copyright (C) 2003, 2004 Jason Bevins
00004 //
00005 // This library is free software; you can redistribute it and/or modify it
00006 // under the terms of the GNU Lesser General Public License as published by
00007 // the Free Software Foundation; either version 2.1 of the License, or (at
00008 // your option) any later version.
00009 //
00010 // This library is distributed in the hope that it will be useful, but WITHOUT
00011 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00013 // License (COPYING.txt) for more details.
00014 //
00015 // You should have received a copy of the GNU Lesser General Public License
00016 // along with this library; if not, write to the Free Software Foundation,
00017 // Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00018 //
00019 // The developer's email is jlbezigvins@gmzigail.com (for great email, take
00020 // off every 'zig'.)
00021 //
00022 
00023 #ifndef NOISE_MODULE_CONST_H
00024 #define NOISE_MODULE_CONST_H
00025 
00026 #include "modulebase.h"
00027 
00028 namespace CS {
00029 namespace Math {
00030 namespace Noise {
00031 namespace Module {
00032 
00035 
00038 
00042 
00044     const double DEFAULT_CONST_VALUE = 0.0;
00045 
00056     class CS_CRYSTALSPACE_EXPORT Const: public Module
00057     {
00058 
00059       public:
00060 
00065         Const ();
00066 
00070         double GetConstValue () const
00071         {
00072           return m_constValue;
00073         }
00074 
00075         virtual int GetSourceModuleCount () const
00076         {
00077           return 0;
00078         }
00079 
00080         virtual double GetValue (double x, double y, double z) const
00081         {
00082           return m_constValue;
00083         }
00084 
00088         void SetConstValue (double constValue)
00089         {
00090           m_constValue = constValue;
00091         }
00092 
00093       protected:
00094 
00096         double m_constValue;
00097 
00098     };
00099 
00101 
00103 
00105 
00106 } // namespace Module
00107 } // namespace Noise
00108 } // namespace Math
00109 } // namespace CS
00110 
00111 #endif

Generated for Crystal Space 2.0 by doxygen 1.7.6.1