Spinning Topp Logo BlackTopp Studios
inc
woodgenerator.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 _graphicsproceduralwoodgenerator_cpp
68 #define _graphicsproceduralwoodgenerator_cpp
69 
70 #include "Graphics/Procedural/Texture/woodgenerator.h"
71 
72 #include "Noise/Module/perlin.h"
73 
74 #include "MathTools/mathtools.h"
75 
76 namespace Mezzanine
77 {
78  namespace Graphics
79  {
80  namespace Procedural
81  {
83  GenColour(1.0,1.0,1.0,1.0),
84  GenTurbulence(0.01),
85  GenSeed(5120),
86  GenRings(8)
87  { }
88 
89  WoodGenerator::WoodGenerator(const Whole Rings, const ColourValue& Colour) :
90  GenColour(Colour),
91  GenTurbulence(0.01),
92  GenSeed(5120),
93  GenRings(Rings)
94  { }
95 
96  WoodGenerator::WoodGenerator(const Whole Seed, const Whole Rings, const ColourValue& Colour) :
97  GenColour(Colour),
98  GenTurbulence(0.01),
99  GenSeed(Seed),
100  GenRings(Rings)
101  { }
102 
104  { }
105 
106  ///////////////////////////////////////////////////////////////////////////////
107  // Utility
108 
110  {
111  MathTools::MersenneTwisterGenerator32 NumGen(this->GenSeed);
112  Whole RandNum = NumGen.GenerateUInt();
113 
114  Noise::Module::Perlin Noise;
115  Noise.SetFrequency(1 / 48.0);
116  Noise.SetLacunarity(2.20703125);
117  Noise.SetOctaveCount(3);
118  Noise.SetPersistence(0.5);
119  Whole TargetWidth = Buffer.GetWidth();
120  Whole TargetHeight = Buffer.GetHeight();
121  Real HalfWidth = static_cast<Real>( TargetWidth ) * 0.5;
122  Real HalfHeight = static_cast<Real>( TargetHeight ) * 0.5;
123 
124  for( Whole Y = 0 ; Y < TargetHeight ; ++Y )
125  {
126  for( Whole X = 0 ; X < TargetWidth ; ++X )
127  {
128  Real xv = ( static_cast<Real>(X) - HalfWidth ) / static_cast<Real>( TargetWidth );
129  Real yv = ( static_cast<Real>(Y) - HalfHeight ) / static_cast<Real>( TargetHeight );
130  Real NoiseVal = std::min<Real>( Real(1.0), MathTools::Abs( MathTools::Sin( ( MathTools::Sqrt(xv * xv + yv * yv) + this->GenTurbulence * Noise.GetValue( X + RandNum, Y + RandNum, 0 ) ) * MathTools::GetPi() * 2 * this->GenRings ) ) );
131  Buffer.SetRedByte( X, Y, (UInt8)std::min<Real>( this->GenColour.RedChannel * 255.0 * NoiseVal, Real(255.0) ) );
132  Buffer.SetGreenByte( X, Y, (UInt8)std::min<Real>( this->GenColour.GreenChannel * 255.0 * NoiseVal, Real(255.0) ) );
133  Buffer.SetBlueByte( X, Y, (UInt8)std::min<Real>( this->GenColour.BlueChannel * 255.0 * NoiseVal, Real(255.0) ) );
134  Buffer.SetAlphaReal( X, Y, this->GenColour.AlphaChannel );
135  }
136  }
137  }
138 
140  { return "WoodGenerator"; }
141 
142  ///////////////////////////////////////////////////////////////////////////////
143  // Configuration
144 
146  {
147  this->GenColour = Colour;
148  return *this;
149  }
150 
151  WoodGenerator& WoodGenerator::SetColour(const Real Red, const Real Green, const Real Blue, const Real Alpha)
152  {
153  this->GenColour.SetValues(Red,Green,Blue,Alpha);
154  return *this;
155  }
156 
158  {
159  this->GenTurbulence = Turb;
160  return *this;
161  }
162 
164  {
165  this->GenSeed = Seed;
166  return *this;
167  }
168 
170  {
171  this->GenRings = Rings;
172  return *this;
173  }
174  }//Procedural
175  }//Graphics
176 }//Mezzanine
177 
178 #endif
WoodGenerator & SetRings(const Whole Rings)
Sets the number of annual rings.
Whole GenSeed
The seed to be used for the random number generator.
Definition: woodgenerator.h:93
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...
virtual String GetName() const
Gets the name of this generator.
Whole GetWidth() const
Get the pixel width of this texture.
WoodGenerator & SetTurbulence(const Real Turb)
Sets the turbulence that will modify the generated pattern.
ColourValue GenColour
The background colour of the texture to be generated.
Definition: woodgenerator.h:87
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
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
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
WoodGenerator & 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
virtual void AddToTextureBuffer(TextureBuffer &Buffer) const
Replaces and populates the pixels as configured in this generator to a TextureBuffer.
Real GenTurbulence
The amount of disruption to apply to the pattern.
Definition: woodgenerator.h:90
void SetAlphaReal(const Whole X, const Whole Y, const Real Alpha)
Sets the alpha colour value of a specified pixel. the X or Y location go beyond the set size of this ...
Whole GenRings
The number of annual rings to be rendered.
Definition: woodgenerator.h:96
void SetValues(const Real Red, const Real Green, const Real Blue, const Real Alpha)
Sets each of the colour channels.
WoodGenerator & SetColour(const ColourValue &Colour)
Sets the colour of the background.
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
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...
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159