CrystalSpace

Public API Reference

cstool/noise/module/clamp.h
00001 // clamp.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_CLAMP_H
00024 #define NOISE_MODULE_CLAMP_H
00025 
00026 #include "modulebase.h"
00027 
00028 namespace CS {
00029 namespace Math {
00030 namespace Noise {
00031 namespace Module {
00032 
00035 
00038 
00041 
00044     const double DEFAULT_CLAMP_LOWER_BOUND = -1.0;
00045 
00048     const double DEFAULT_CLAMP_UPPER_BOUND = 1.0;
00049 
00068     class CS_CRYSTALSPACE_EXPORT Clamp: public Module
00069     {
00070 
00071       public:
00072 
00080         Clamp ();
00081 
00089         double GetLowerBound () const
00090         {
00091           return m_lowerBound;
00092         }
00093 
00094         virtual int GetSourceModuleCount () const
00095         {
00096           return 1;
00097         }
00098 
00106         double GetUpperBound () const
00107         {
00108           return m_upperBound;
00109         }
00110 
00111         virtual double GetValue (double x, double y, double z) const;
00112 
00129         void SetBounds (double lowerBound, double upperBound);
00130 
00131       protected:
00132 
00134         double m_lowerBound;
00135 
00137         double m_upperBound;
00138 
00139     };
00140 
00142 
00144 
00146 
00147 } // namespace Module
00148 } // namespace Noise
00149 } // namespace Math
00150 } // namespace CS
00151 
00152 #endif

Generated for Crystal Space 2.0 by doxygen 1.7.6.1