Spinning Topp Logo BlackTopp Studios
inc
jittermodifier.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 _graphicsproceduraljittermodifier_cpp
68 #define _graphicsproceduraljittermodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/jittermodifier.h"
71 
72 #include "MathTools/randomnumber.h"
73 
74 namespace Mezzanine
75 {
76  namespace Graphics
77  {
78  namespace Procedural
79  {
81  GeneratorSeed(5120),
82  JitterRadius(32)
83  { }
84 
86  { }
87 
88  ///////////////////////////////////////////////////////////////////////////////
89  // Utility
90 
92  {
93  TextureBuffer TempBuffer(Buffer);
94  MathTools::MersenneTwisterGenerator32 NumGen(this->GeneratorSeed);
95  Integer TargetWidth = static_cast<Integer>( Buffer.GetWidth() );
96  Integer TargetHeight = static_cast<Integer>( Buffer.GetHeight() );
97  Integer Radius = static_cast<Integer>( 1.0 + ( 9.0 / 255.0 ) * ( static_cast<Real>(this->JitterRadius) - 1.0 ) );
98  //Integer MaxDist = Radius * 2 + 1;
99  for( Integer Y = 0; Y < TargetHeight ; ++Y )
100  {
101  for( Integer X = 0; X < TargetWidth ; ++X )
102  {
103  Integer NewX = X + ( NumGen.GenerateUInt() % ( Radius * 2 + 1 ) ) - Radius;
104  Integer NewY = Y + ( NumGen.GenerateUInt() % ( Radius * 2 + 1 ) ) - Radius;
105 
106  if( NewX >= 0 && NewX < TargetWidth && NewY >= 0 && NewY < TargetHeight ) {
107  TempBuffer.SetPixel(static_cast<Whole>(NewX),static_cast<Whole>(NewY), Buffer.GetPixel(static_cast<Whole>(X),static_cast<Whole>(Y)) );
108  }
109  }
110  }
111  Buffer.SetData(TempBuffer);
112  }
113 
115  { return "JitterModifier"; }
116 
117  ///////////////////////////////////////////////////////////////////////////////
118  // Configuration
119 
121  {
122  this->GeneratorSeed = Seed;
123  return *this;
124  }
125 
127  {
128  this->JitterRadius = Radius;
129  return *this;
130  }
131  }//Procedural
132  }//Graphics
133 }//Mezzanine
134 
135 #endif
ColourChannelType & GetPixel(const Whole X, const Whole Y, const UInt16 Component)
Gets access to the pixel at the specified position in this buffer. the X or Y location go beyond the ...
Whole GetWidth() const
Get the pixel width of this texture.
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
JitterModifier & SetJitterRadius(const UInt16 Radius)
Sets the range in which pixels can be swapped.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
uint16_t UInt16
An 16-bit unsigned integer.
Definition: datatypes.h:122
Whole GeneratorSeed
The seed to be used for the random number generator.
JitterModifier & SetGeneratorSeed(const Whole Seed)
Sets the seed for the "random" number generator.
A modifier that will randomly shuffle the pixel being processed to a nearby position.
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
virtual String GetName() const
Gets the name of this modifier.
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.
void SetPixel(const Whole X, const Whole Y, const ColourValue &Colour)
Set colour of a specified pixel using a ColourValue. the X or Y location go beyond the set size of th...
UInt16 JitterRadius
The radius around the pixel being processed in which the pixel can be displaced.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
void SetData(const TextureBuffer &Other)
Copies image data from another buffer into this buffer.