Spinning Topp Logo BlackTopp Studios
inc
weighedlerpmodifier.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 _graphicsproceduralweighedlerpmodifier_cpp
68 #define _graphicsproceduralweighedlerpmodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/weighedlerpmodifier.h"
71 
72 #include "exception.h"
73 #include "interpolator.h"
74 
75 namespace Mezzanine
76 {
77  namespace Graphics
78  {
79  namespace Procedural
80  {
82  FirstTexture(NULL),
83  SecondTexture(NULL)
84  { }
85 
87  { }
88 
89  ///////////////////////////////////////////////////////////////////////////////
90  // Utility
91 
93  {
94  const Whole TargetWidth = Buffer.GetWidth();
95  const Whole TargetHeight = Buffer.GetHeight();
96  if( TargetWidth > this->FirstTexture->GetWidth() || TargetHeight > this->FirstTexture->GetHeight() ) {
97  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"The FirstTexture provided for LERP is not large enough to lerp onto the target texture.");
98  }
99  if( TargetWidth > this->SecondTexture->GetWidth() || TargetHeight > this->SecondTexture->GetHeight() ) {
100  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"The SecondTexture provided for LERP is not large enough to lerp onto the target texture.");
101  }
102 
103  for( Whole Y = 0 ; Y < TargetHeight ; ++Y )
104  {
105  for( Whole X = 0 ; X < TargetWidth ; ++X )
106  {
107  ColourValue FirstColour = this->FirstTexture->GetPixel(X,Y);
108  ColourValue SecondColour = this->SecondTexture->GetPixel(X,Y);
109  ColourValue ModifyTexColour = Buffer.GetPixel(X,Y);
110 
111  /*ColourValue TargetColour( FirstColour.RedChannel * ( 1.0 - ModifyTexColour.RedChannel ) + SecondColour.RedChannel * ModifyTexColour.RedChannel,
112  FirstColour.GreenChannel * ( 1.0 - ModifyTexColour.GreenChannel ) + SecondColour.GreenChannel * ModifyTexColour.GreenChannel,
113  FirstColour.BlueChannel * ( 1.0 - ModifyTexColour.BlueChannel ) + SecondColour.BlueChannel * ModifyTexColour.BlueChannel,
114  FirstColour.AlphaChannel * ( 1.0 - ModifyTexColour.AlphaChannel ) + SecondColour.AlphaChannel * ModifyTexColour.AlphaChannel);// */
115  LinearInterpolator<Real> Interpolator;
116  ColourValue TargetColour( Interpolator.InterpolateMath(FirstColour.RedChannel,SecondColour.RedChannel,ModifyTexColour.RedChannel),
117  Interpolator.InterpolateMath(FirstColour.GreenChannel,SecondColour.GreenChannel,ModifyTexColour.GreenChannel),
118  Interpolator.InterpolateMath(FirstColour.BlueChannel,SecondColour.BlueChannel,ModifyTexColour.BlueChannel),
119  Interpolator.InterpolateMath(FirstColour.AlphaChannel,SecondColour.AlphaChannel,ModifyTexColour.AlphaChannel) );
120  Buffer.SetPixel(X,Y,TargetColour);
121  }
122  }
123  }
124 
126  { return "WeighedLerpModifier"; }
127 
128  ///////////////////////////////////////////////////////////////////////////////
129  // Configuration
130 
132  {
133  this->FirstTexture = First;
134  return *this;
135  }
136 
138  {
139  this->SecondTexture = Second;
140  return *this;
141  }
142  }//Procedural
143  }//Graphics
144 }//Mezzanine
145 
146 #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 ...
A simple functor for interpolating data points in a simple way.
Definition: interpolator.h:78
Whole GetWidth() const
Get the pixel width of this texture.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
#define MEZZ_EXCEPTION(num, desc)
An easy way to throw exceptions with rich information.
Definition: exception.h:3048
WeighedLerpModifier & SetSecondTexture(TextureBuffer *Second)
The second texture to interpolate. the texture provided here isn't at least the same size as the text...
This is a simple class for holding 4 reals representing the colour any give object or lightsource can...
Definition: colourvalue.h:64
This implements the exception hiearchy for Mezzanine.
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
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
A modifier that will use the colours of the texture to be modified to perform a linear interpolation ...
virtual String GetName() const
Gets the name of this modifier.
Thrown when parameters are checked at runtime and found invalid.
Definition: exception.h:108
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
static T InterpolateMath(T Begin, T End, Real Location)
Get a value at a given location between exactly two others.
Definition: interpolator.h:92
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
WeighedLerpModifier & SetFirstTexture(TextureBuffer *First)
The first texture to interpolate. the texture provided here isn't at least the same size as the textu...
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
TextureBuffer * FirstTexture
The first texture to interpolate.
Helper classes to assist in generating data points between two other data points. ...
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
TextureBuffer * SecondTexture
The second texture to interpolate.