CrystalSpace

Public API Reference

cstool/noise/module/scalebias.h
00001 // scalebias.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_SCALEBIAS_H
00024 #define NOISE_MODULE_SCALEBIAS_H
00025 
00026 #include "modulebase.h"
00027 
00028 namespace CS {
00029 namespace Math {
00030 namespace Noise {
00031 namespace Module {
00032 
00035 
00038 
00041 
00043     const double DEFAULT_BIAS = 0.0;
00044 
00046     const double DEFAULT_SCALE = 1.0;
00047 
00058     class CS_CRYSTALSPACE_EXPORT ScaleBias: public Module
00059     {
00060 
00061       public:
00062 
00068         ScaleBias ();
00069 
00078         double GetBias () const
00079         {
00080           return m_bias;
00081         }
00082 
00091         double GetScale () const
00092         {
00093           return m_scale;
00094         }
00095 
00096         virtual int GetSourceModuleCount () const
00097         {
00098           return 1;
00099         }
00100 
00101         virtual double GetValue (double x, double y, double z) const;
00102 
00111         void SetBias (double bias)
00112         {
00113           m_bias = bias;
00114         }
00115 
00124         void SetScale (double scale)
00125         {
00126           m_scale = scale;
00127         }
00128 
00129       protected:
00130 
00132         double m_bias;
00133 
00136         double m_scale;
00137 
00138     };
00139 
00141 
00143 
00145 
00146 } // namespace Module
00147 } // namespace Noise
00148 } // namespace Math
00149 } // namespace CS
00150 
00151 #endif

Generated for Crystal Space 2.0 by doxygen 1.7.6.1