Spinning Topp Logo BlackTopp Studios
inc
noisegenerator.h
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_h
68 #define _graphicsproceduralnoisegenerator_h
69 
70 #include "Graphics/Procedural/Texture/texturegenerator.h"
71 
72 namespace Mezzanine
73 {
74  namespace Graphics
75  {
76  namespace Procedural
77  {
78  ///////////////////////////////////////////////////////////////////////////////
79  /// @brief Fills full image with noise in a given colour.
80  /// @details High quality noise with various noise algorithms.
81  ///////////////////////////////////////
83  {
84  public:
85  /// @brief Convenience typedef for a container of generated noise.
86  typedef std::vector<Real> NoiseField;
87  protected:
88  /// @internal
89  /// @brief The colour of the noise to be generated.
91  /// @internal
92  /// @brief The seed to be used for the random number generator.
94  /// @internal
95  /// @brief The type of noise generator to use when generating the image.
97 
98  /// @internal
99  /// @brief Converts all of the values in a NoiseField to a 0-1 range.
100  /// @param ToNormalize The NoiseField to be converted.
101  /// @param MinVal The minimum value generated in the provided field.
102  /// @param MaxVal The maximum value generated in the provided field.
103  void FitToRange(NoiseField& ToNormalize, const Real MinVal, const Real MaxVal) const;
104  /// @internal
105  /// @brief Generates a grid of perlin noise.
106  /// @param X The width of the field to generate.
107  /// @param Y The height of the field to generate.
108  /// @return Returns a container of generated perlin noise.
109  NoiseField GeneratePerlinNoiseField(const Whole X, const Whole Y) const;
110  /// @internal
111  /// @brief Generates a grid of white noise.
112  /// @param X The width of the field to generate.
113  /// @param Y The height of the field to generate.
114  /// @return Returns a container of generated white noise.
115  NoiseField GenerateWhiteNoiseField(const Whole X, const Whole Y) const;
116  public:
117  /// @brief Class constructor.
118  NoiseGenerator();
119  /// @brief Class destructor.
120  virtual ~NoiseGenerator();
121 
122  ///////////////////////////////////////////////////////////////////////////////
123  // Utility
124 
125  /// @copydoc TextureGenerator::AddToTextureBuffer(TextureBuffer&) const
126  virtual void AddToTextureBuffer(TextureBuffer& Buffer) const;
127  /// @copydoc TextureGenerator::GetName() const
128  virtual String GetName() const;
129 
130  ///////////////////////////////////////////////////////////////////////////////
131  // Configuration
132 
133  /// @brief Sets the colour of the background.
134  /// @param Colour The colour to be applied to the noise to be generated.
135  /// @return Returns a reference to this.
136  NoiseGenerator& SetColour(const ColourValue& Colour);
137  /// @brief Set the colour of the background.
138  /// @param Red The Red component for the background colour. Range: [0.0, 1.0].
139  /// @param Green The Green component for the background colour. Range: [0.0, 1.0].
140  /// @param Blue The Blue component for the background colour. Range: [0.0, 1.0].
141  /// @param Alpha The Alpha component for the background colour. Range: [0.0, 1.0].
142  /// @return Returns a reference to this.
143  NoiseGenerator& SetColour(const Real Red, const Real Green, const Real Blue, const Real Alpha = 1.0);
144  /// @brief Sets the seed for the "random" number generator.
145  /// @param Seed The seed value for the random number generator. Initial Value: 5120.
146  /// @return Returns a reference to this.
147  NoiseGenerator& SetSeed(const Whole Seed);
148  /// @brief Set the type of noise generation.
149  /// @param Type Type of noise generator. Initial Value: NT_White.
150  /// @return Returns a reference to this.
151  NoiseGenerator& SetType(const Procedural::NoiseType Type);
152  };//NoiseGenerator
153  }//Procedural
154  }//Graphics
155 }//Mezzanine
156 
157 #endif
Procedural::NoiseType NType
The type of noise generator to use when generating the image.
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
Fills full image with noise in a given colour.
std::vector< Real > NoiseField
Convenience typedef for a container of generated noise.
NoiseType
An enum used to describe the different types of noise generators.
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
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
ColourValue GenColour
The colour of the noise to be generated.
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
A base class for texture generators that use the TextureBuffer class.