Spinning Topp Logo BlackTopp Studios
inc
segmentmodifier.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 _graphicsproceduralsegmentmodifier_cpp
68 #define _graphicsproceduralsegmentmodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/segmentmodifier.h"
71 
72 #include <cstring>
73 
74 namespace Mezzanine
75 {
76  namespace Graphics
77  {
78  namespace Procedural
79  {
81  ColourSource(NULL),
82  Threshold(128)
83  { }
84 
86  { }
87 
88  ///////////////////////////////////////////////////////////////////////////////
89  // Utility
90 
92  {
93  Whole Width = Buffer.GetWidth();
94  Whole Height = Buffer.GetHeight();
95 
96  if( this->ColourSource == NULL || ( this->ColourSource->GetWidth() < Width || this->ColourSource->GetHeight() < Height ) ) {
97  return;
98  }
99 
100  UInt8* Coverage = new UInt8[Width * Height];
101  memset(Coverage, 0, Width * Height);
102  IntVector2* Stack = new IntVector2[Width * Height * 4];
103  TextureBuffer TempBuffer( Buffer );
104 
105  size_t StackPtr = 0;
106  for( Whole Y = 0 ; Y < Height ; ++Y )
107  {
108  for( Whole X = 0 ; X < Width ; ++X )
109  {
110  ColourValue PixelA = Buffer.GetPixel(X,Y);
111  ColourValue PixelB = this->ColourSource->GetPixel(X,Y);
112 
113  if( ( PixelA.RedChannel + PixelA.GreenChannel + PixelA.BlueChannel ) * 255.0 > static_cast<Real>(this->Threshold) * 3.0 ) {
114  Stack[StackPtr].X = X;
115  Stack[StackPtr].Y = Y;
116  StackPtr++;
117  }
118 
119  while( StackPtr > 0 )
120  {
121  IntVector2 Current = Stack[--StackPtr];
122  if( Coverage[Current.X + Current.Y * Width] != 0 ) {
123  continue;
124  }
125 
126  PixelA = Buffer.GetPixel(Current.X, Current.Y);
127  if( ( PixelA.RedChannel + PixelA.GreenChannel + PixelA.BlueChannel ) * 255.0 > static_cast<Real>(this->Threshold) * 3.0 ) {
128  Stack[StackPtr].X = Current.X;
129  Stack[StackPtr].Y = (Current.Y + Height - 1) % Height;
130  StackPtr++;
131  Stack[StackPtr].X = Current.X;
132  Stack[StackPtr].Y = (Current.Y + 1) % Height;
133  StackPtr++;
134  Stack[StackPtr].X = (Current.X + 1) % Width;
135  Stack[StackPtr].Y = Current.Y ;
136  StackPtr++;
137  Stack[StackPtr].X = (Current.X + Width - 1) % Width;
138  Stack[StackPtr].Y = Current.Y ;
139  StackPtr++;
140 
141  Coverage[Current.X + Current.Y * Width] = 1;
142  TempBuffer.SetPixel(Current.X, Current.Y, PixelB);
143  }
144  }
145 
146  if( Coverage[X + Y * Width] == 0 ) {
147  TempBuffer.SetPixel(X,Y,ColourValue::Black());
148  }
149  }
150  }
151 
152  Buffer.SetData(TempBuffer);
153  delete[] Coverage;
154  delete[] Stack;
155  }
156 
158  { return "SegmentModifier"; }
159 
160  ///////////////////////////////////////////////////////////////////////////////
161  // Configuration
162 
164  { this->ColourSource = Source; return *this; }
165 
167  { this->Threshold = Thresh; return *this; }
168  }//Procedural
169  }//Graphics
170 }//Mezzanine
171 
172 #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.
A modifier that will alter the colour of pixels above a certain luminous value.
SegmentModifier & SetColourSource(TextureBuffer *Source)
Sets the buffer to use to determine the colour to be placed.
static ColourValue Black()
Creates a ColourValue representing the colour Black.
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
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
Convenience class for pixel processing.
SegmentModifier & SetThreshold(const UInt8 Thresh)
Sets the threshold above which the colour from the set buffer will be copied.
virtual String GetName() const
Gets the name of this modifier.
TextureBuffer * ColourSource
The source image (buffer) to use for the replacing colour.
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
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...
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
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
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.
UInt8 Threshold
The luminous threshold above which will have it's colour replaced.