Spinning Topp Logo BlackTopp Studios
inc
thresholdmodifier.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 _graphicsproceduralthresholdmodifier_cpp
68 #define _graphicsproceduralthresholdmodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/thresholdmodifier.h"
71 
72 namespace Mezzanine
73 {
74  namespace Graphics
75  {
76  namespace Procedural
77  {
79  ThresholdColour(0.0,0.0,0.0,1.0),
80  LowerLimit(0.0),
81  UpperLimit(1.0),
82  Threshold(ThresholdModifier::TM_Below),
83  Replace(ThresholdModifier::RM_PixelIntensity)
84  { }
85 
87  { }
88 
89  ///////////////////////////////////////////////////////////////////////////////
90  // Utility
91 
93  {
94  Whole TargetWidth = Buffer.GetWidth();
95  Whole TargetHeight = Buffer.GetHeight();
96 
97  for( Whole Y = 0 ; Y < TargetHeight ; ++Y )
98  {
99  for( Whole X = 0 ; X < TargetWidth ; ++X )
100  {
101  const ColourValue Pixel = Buffer.GetPixel(X,Y);
102 
104  Real Intensity = ( Pixel.RedChannel + Pixel.GreenChannel + Pixel.BlueChannel ) / 3;
105 
106  if( this->Threshold & ThresholdModifier::TM_Below && Intensity < this->LowerLimit ) {
107  Buffer.SetPixel(X,Y,this->ThresholdColour);
108  }else if( this->Threshold & ThresholdModifier::TM_Above && Intensity > this->UpperLimit ) {
109  Buffer.SetPixel(X,Y,this->ThresholdColour);
110  }
111  }else if( this->Replace == ThresholdModifier::RM_ColourChannels ) {
112  if( this->Threshold & ThresholdModifier::TM_Below && Pixel.RedChannel < this->LowerLimit ) {
113  Buffer.SetRedReal(X,Y,this->ThresholdColour.RedChannel);
114  }else if( this->Threshold & ThresholdModifier::TM_Above && Pixel.RedChannel > this->UpperLimit ) {
115  Buffer.SetRedReal(X,Y,this->ThresholdColour.RedChannel);
116  }
117 
118  if( this->Threshold & ThresholdModifier::TM_Below && Pixel.GreenChannel < this->LowerLimit ) {
119  Buffer.SetGreenReal(X,Y,this->ThresholdColour.GreenChannel);
120  }else if( this->Threshold & ThresholdModifier::TM_Above && Pixel.GreenChannel > this->UpperLimit ) {
121  Buffer.SetGreenReal(X,Y,this->ThresholdColour.GreenChannel);
122  }
123 
124  if( this->Threshold & ThresholdModifier::TM_Below && Pixel.BlueChannel < this->LowerLimit ) {
125  Buffer.SetBlueReal(X,Y,this->ThresholdColour.BlueChannel);
126  }else if( this->Threshold & ThresholdModifier::TM_Above && Pixel.BlueChannel > this->UpperLimit ) {
127  Buffer.SetBlueReal(X,Y,this->ThresholdColour.BlueChannel);
128  }
129  }
130  }
131  }
132  }
133 
135  { return "ThresholdModifier"; }
136 
137  ///////////////////////////////////////////////////////////////////////////////
138  // Configuration
139 
141  { this->ThresholdColour = Colour; return *this; }
142 
143  ThresholdModifier& ThresholdModifier::SetColour(const Real Red, const Real Green, const Real Blue, const Real Alpha)
144  { this->ThresholdColour.SetValues(Red,Green,Blue,Alpha); return *this; }
145 
147  { this->LowerLimit = Lower; return *this; }
148 
150  { this->UpperLimit = Upper; return *this; }
151 
153  { this->LowerLimit = Lower; this->UpperLimit = Upper; return *this; }
154 
156  { this->Threshold = Mode; return *this; }
157 
159  { this->Replace = Mode; return *this; }
160  }//Procedural
161  }//Graphics
162 }//Mezzanine
163 
164 #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 ...
ThresholdModifier & SetLimitRange(const Real Lower, const Real Upper)
Sets the lower and upper limit of the threshold.
Uses only the upper limit. Any pixel with an intensity above the set upper limit will be replaced...
Whole GetWidth() const
Get the pixel width of this texture.
ThresholdMode
An enum to describe when to replace the colour of a pixel.
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
Uses only the lower limit. Any pixel with an intensity below the set lower limit will be replaced...
ThresholdModifier & SetLowerLimit(const Real Lower)
Sets the lower limit of the threshold.
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
void SetGreenReal(const Whole X, const Whole Y, const Real Green)
Sets the green colour value of a specified pixel. the X or Y location go beyond the set size of this ...
ThresholdModifier & SetUpperLimit(const Real Upper)
Sets the upper limit of the threshold.
Real UpperLimit
The upper limit of the threshold to check for.
Checks against the total intensity of the pixel and will replace the entire pixel if it is outside th...
void SetValues(const Real Red, const Real Green, const Real Blue, const Real Alpha)
Sets each of the colour channels.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
void SetBlueReal(const Whole X, const Whole Y, const Real Blue)
Sets the blue colour value of a specified pixel. the X or Y location go beyond the set size of this t...
UInt16 Threshold
The mode that determines which limits are used for the allowed threshold.
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
void SetRedReal(const Whole X, const Whole Y, const Real Red)
Sets the red colour value of a specified pixel. the X or Y location go beyond the set size of this te...
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
Checks each colour channel, and will replace just the colour channels that are outside the set thresh...
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...
ColourValue ThresholdColour
The colour to apply if the pixel is outside the allowed threshold.
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
ReplaceMode
An enum to describe with what granularity pixels will be checked and replaced.
A modifier that will set a pixels colour if it's intensity is outside a set threshold.
virtual String GetName() const
Gets the name of this modifier.
ThresholdModifier & SetReplaceMode(const ReplaceMode Mode)
Sets the components of the pixel to be replaced.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
ThresholdModifier & SetThresholdMode(const ThresholdMode Mode)
Sets which limits are to be considered for the threshold.
ThresholdModifier & SetColour(const ColourValue &Colour)
Sets the colour to use if a pixel is outside the set threshold.
UInt16 Replace
The mode that determines the granularity of checks to be performed.
Real LowerLimit
The lower limit of the threshold to check for.