Main Page | Modules | Class Hierarchy | Class List | File List | Class Members
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 noise
00029 {
00030 
00031   namespace module
00032   {
00033 
00036 
00039 
00042 
00045     const double DEFAULT_CLAMP_LOWER_BOUND = -1.0;
00046 
00049     const double DEFAULT_CLAMP_UPPER_BOUND = 1.0;
00050 
00069     class Clamp: public Module
00070     {
00071 
00072       public:
00073 
00081         Clamp ();
00082 
00090         double GetLowerBound () const
00091         {
00092           return m_lowerBound;
00093         }
00094 
00095         virtual int GetSourceModuleCount () const
00096         {
00097           return 1;
00098         }
00099 
00107         double GetUpperBound () const
00108         {
00109           return m_upperBound;
00110         }
00111 
00112         virtual double GetValue (double x, double y, double z) const;
00113 
00130         void SetBounds (double lowerBound, double upperBound);
00131 
00132       protected:
00133 
00135         double m_lowerBound;
00136 
00138         double m_upperBound;
00139 
00140     };
00141 
00143 
00145 
00147 
00148   }
00149 
00150 }
00151 
00152 #endif