Spinning Topp Logo BlackTopp Studios
inc
labyrinthgenerator.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 _graphicsprocedurallabyrinthgenerator_cpp
68 #define _graphicsprocedurallabyrinthgenerator_cpp
69 
70 #include "Graphics/Procedural/Texture/labyrinthgenerator.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  GenSeed(5120)
85  { }
86 
88  { }
89 
90  ///////////////////////////////////////////////////////////////////////////////
91  // Utility
92 
94  {
95  MathTools::MersenneTwisterGenerator32 NumGen(this->GenSeed);
96  Whole RandNum = NumGen.GenerateUInt();
97  Noise::Module::Perlin Noise;
98  Noise.SetFrequency(1.0 / 16.0);
99  Noise.SetLacunarity(2.0);
100  Noise.SetOctaveCount(1);
101  Noise.SetPersistence(0.65);
102  Real FilterLevel = 0.7;
103  Real PreserveLevel = 0.3;
104 
105  for( Whole Y = 0 ; Y < Buffer.GetHeight() ; ++Y )
106  {
107  for( Whole X = 0 ; X < Buffer.GetWidth() ; ++X )
108  {
109  Real NoiseVal = std::min( Real(1.0), MathTools::Abs( Noise.GetValue( X + RandNum, Y + RandNum, 0 ) ) );
110  Buffer.SetRedByte( X, Y, (UInt8)std::min<Real>( PreserveLevel * this->GenColour.RedChannel * 255.0 + FilterLevel * this->GenColour.RedChannel * 255.0 * NoiseVal, 255.0 ) );
111  Buffer.SetGreenByte( X, Y, (UInt8)std::min<Real>( PreserveLevel * this->GenColour.GreenChannel * 255.0 + FilterLevel * this->GenColour.GreenChannel * 255.0 * NoiseVal, 255.0 ) );
112  Buffer.SetBlueByte( X, Y, (UInt8)std::min<Real>( PreserveLevel * this->GenColour.BlueChannel * 255.0 + FilterLevel * this->GenColour.BlueChannel * 255.0 * NoiseVal, 255.0 ) );
113  Buffer.SetAlphaReal( X, Y, this->GenColour.AlphaChannel );
114  }
115  }
116  }
117 
119  { return "LabyrinthGenerator"; }
120 
121  ///////////////////////////////////////////////////////////////////////////////
122  // Configuration
123 
125  {
126  this->GenColour = Colour;
127  return *this;
128  }
129 
130  LabyrinthGenerator& LabyrinthGenerator::SetColour(const Real Red, const Real Green, const Real Blue, const Real Alpha)
131  {
132  this->GenColour.SetValues(Red,Green,Blue,Alpha);
133  return *this;
134  }
135 
137  {
138  this->GenSeed = Seed;
139  return *this;
140  }
141  }//Procedural
142  }//Graphics
143 }//Mezzanine
144 
145 #endif
Creates a labyrinth structured image.
Whole GenSeed
The seed to be used for the random number generator.
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.
ColourValue GenColour
The colour to be applied to the labyrinth.
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
virtual void AddToTextureBuffer(TextureBuffer &Buffer) const
Replaces and populates the pixels as configured in this generator to a TextureBuffer.
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
LabyrinthGenerator & 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 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 ...
void SetValues(const Real Red, const Real Green, const Real Blue, const Real Alpha)
Sets each of the colour channels.
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...
LabyrinthGenerator & SetColour(const ColourValue &Colour)
Sets the colour of the background.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159