Spinning Topp Logo BlackTopp Studios
inc
noisegenerator.cpp
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 /*
41  -----------------------------------------------------------------------------
42  This source file is part of ogre-procedural
43 
44  For the latest info, see http://code.google.com/p/ogre-procedural/
45 
46  Copyright (c) 2010-2013 Michael Broutin
47 
48  Permission is hereby granted, free of charge, to any person obtaining a copy
49  of this software and associated documentation files (the "Software"), to deal
50  in the Software without restriction, including without limitation the rights
51  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
52  copies of the Software, and to permit persons to whom the Software is
53  furnished to do so, subject to the following conditions:
54 
55  The above copyright notice and this permission notice shall be included in
56  all copies or substantial portions of the Software.
57 
58  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
59  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
60  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
61  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
62  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
63  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
64  THE SOFTWARE.
65  -----------------------------------------------------------------------------
66  */
67 #ifndef _graphicsproceduralnoisegenerator_cpp
68 #define _graphicsproceduralnoisegenerator_cpp
69 
70 #include "Graphics/Procedural/Texture/noisegenerator.h"
71 
72 #include "MathTools/randomnumber.h"
73 #include "Noise/Module/perlin.h"
74 
75 #include <cstdlib>
76 
77 namespace Mezzanine
78 {
79  namespace Graphics
80  {
81  namespace Procedural
82  {
84  GenColour(1.0,1.0,1.0,1.0),
85  GenSeed(5120),
86  NType(Procedural::NT_White)
87  { }
88 
90  { }
91 
92  void NoiseGenerator::FitToRange(NoiseField& ToNormalize, const Real MinVal, const Real MaxVal) const
93  {
94  Real RangeSize = MaxVal - MinVal;
95  if( RangeSize > 0.0 ) {
96  for( Whole Index = 0 ; Index < ToNormalize.size() ; ++Index )
97  {
98  ToNormalize[Index] = ( ToNormalize[Index] - MinVal ) / RangeSize;
99  }
100  }
101  }
102 
104  {
105  NoiseField RetField( X * Y );
106  Real MinNoise = 9999999999.9;
107  Real MaxNoise = -999999999.9;
108  Noise::Module::Perlin PerlinMod;
109  for( Whole CurrX = 0 ; CurrX < X ; ++CurrX )
110  {
111  for( Whole CurrY = 0 ; CurrY < Y ; ++CurrY )
112  {
113  Real NoiseVal = PerlinMod.GetValue(CurrX,CurrY,0);
114  if( NoiseVal < MinNoise )
115  MinNoise = NoiseVal;
116  if( NoiseVal > MaxNoise )
117  MaxNoise = NoiseVal;
118  RetField[CurrY * X + CurrX] = NoiseVal;
119  }
120  }
121  this->FitToRange(RetField,MinNoise,MaxNoise);
122  return RetField;
123  }
124 
126  {
127  NoiseField RetField( X * Y );
128  Real MinNoise = 9999999999.9;
129  Real MaxNoise = -999999999.9;
130  MathTools::MersenneTwisterGenerator32 NumGen(this->GenSeed);
131  for( Whole Index = 0 ; Index < RetField.size() ; ++Index )
132  {
133  Real NoiseVal = NumGen.GenerateScaledReal();
134  if( NoiseVal < MinNoise )
135  MinNoise = NoiseVal;
136  if( NoiseVal > MaxNoise )
137  MaxNoise = NoiseVal;
138  RetField[Index] = NoiseVal;
139  }
140  this->FitToRange(RetField,MinNoise,MaxNoise);
141  return RetField;
142  }
143 
144  ///////////////////////////////////////////////////////////////////////////////
145  // Utility
146 
148  {
149  NoiseField Field;
150  Whole TargetWidth = Buffer.GetWidth();
151  Whole TargetHeight = Buffer.GetHeight();
152  switch( this->NType )
153  {
155  {
156  Field = this->GeneratePerlinNoiseField( TargetWidth, TargetHeight );
157  break;
158  }
160  default:
161  {
162  Field = this->GenerateWhiteNoiseField( Buffer.GetWidth(), TargetHeight );
163  break;
164  }
165  }
166 
167  for( Whole Y = 0 ; Y < TargetHeight ; ++Y )
168  {
169  for( Whole X = 0 ; X < TargetWidth ; ++X )
170  {
171  Real NoiseVal = (Real)Field[Y * TargetWidth + X];
172  Buffer.SetRedByte( X, Y, (UInt8)( NoiseVal * this->GenColour.RedChannel * 255.0 ) );
173  Buffer.SetGreenByte( X, Y, (UInt8)( NoiseVal * this->GenColour.GreenChannel * 255.0 ) );
174  Buffer.SetBlueByte( X, Y, (UInt8)( NoiseVal * this->GenColour.BlueChannel * 255.0 ) );
175  Buffer.SetAlphaByte( X, Y, (UInt8)( this->GenColour.AlphaChannel * 255.0 ) );
176  }
177  }
178  }
179 
181  { return "NoiseGenerator"; }
182 
183  ///////////////////////////////////////////////////////////////////////////////
184  // Configuration
185 
187  {
188  this->GenColour = Colour;
189  return *this;
190  }
191 
192  NoiseGenerator& NoiseGenerator::SetColour(const Real Red, const Real Green, const Real Blue, const Real Alpha)
193  {
194  this->GenColour.SetValues(Red,Green,Blue,Alpha);
195  return *this;
196  }
197 
199  {
200  this->GenSeed = Seed;
201  return *this;
202  }
203 
205  {
206  this->NType = Type;
207  return *this;
208  }
209  }//Procedural
210  }//Graphics
211 }//Mezzanine
212 
213 #endif
void SetRedByte(const Whole X, const Whole Y, const ColourChannelType Red)
Sets the red colour value of a specified pixel. the X or Y location go beyond the set size of this te...
void FitToRange(NoiseField &ToNormalize, const Real MinVal, const Real MaxVal) const
Converts all of the values in a NoiseField to a 0-1 range.
Procedural::NoiseType NType
The type of noise generator to use when generating the image.
Whole GetWidth() const
Get the pixel width of this texture.
NoiseField GenerateWhiteNoiseField(const Whole X, const Whole Y) const
Generates a grid of white noise.
uint8_t UInt8
An 8-bit unsigned integer.
Definition: datatypes.h:118
This is a simple class for holding 4 reals representing the colour any give object or lightsource can...
Definition: colourvalue.h:64
virtual String GetName() const
Gets the name of this generator.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
Fills full image with noise in a given colour.
NoiseField GeneratePerlinNoiseField(const Whole X, const Whole Y) const
Generates a grid of perlin noise.
void SetGreenByte(const Whole X, const Whole Y, const ColourChannelType Green)
Sets the green colour value of a specified pixel. the X or Y location go beyond the set size of this ...
Real GreenChannel
Value from 0.0 to 1.0 representing the amount of green present in the colour. 1.0 if very green...
Definition: colourvalue.h:73
std::vector< Real > NoiseField
Convenience typedef for a container of generated noise.
NoiseType
An enum used to describe the different types of noise generators.
NoiseGenerator & SetColour(const ColourValue &Colour)
Sets the colour of the background.
NoiseGenerator & SetSeed(const Whole Seed)
Sets the seed for the "random" number generator.
Real AlphaChannel
Value from 0.0 to 1.0 representing the transparency of the colours. 1.0 is opaque and 0...
Definition: colourvalue.h:79
void SetValues(const Real Red, const Real Green, const Real Blue, const Real Alpha)
Sets each of the colour channels.
NoiseGenerator & SetType(const Procedural::NoiseType Type)
Set the type of noise generation.
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
unsigned long Whole
Whole is an unsigned integer, it will be at least 32bits in size.
Definition: datatypes.h:151
Whole GetHeight() const
Get the pixel height of this texture.
Real BlueChannel
Value from 0.0 to 1.0 representing the amount of blue present in the colour. 1.0 if very blue...
Definition: colourvalue.h:76
Real RedChannel
Value from 0.0 to 1.0 representing the amount of red present in the colour. 1.0 if very red...
Definition: colourvalue.h:70
ColourValue GenColour
The colour of the noise to be generated.
virtual void AddToTextureBuffer(TextureBuffer &Buffer) const
Replaces and populates the pixels as configured in this generator to a TextureBuffer.
void SetAlphaByte(const Whole X, const Whole Y, const ColourChannelType Alpha)
Sets the alpha colour value of a specified pixel. the X or Y location go beyond the set size of this ...
void SetBlueByte(const Whole X, const Whole Y, const ColourChannelType Blue)
Sets the blue colour value of a specified pixel. the X or Y location go beyond the set size of this t...
Whole GenSeed
The seed to be used for the random number generator.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159