Spinning Topp Logo BlackTopp Studios
inc
weighedlerpmodifier.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 _graphicsproceduralweighedlerpmodifier_h
68 #define _graphicsproceduralweighedlerpmodifier_h
69 
70 #include "Graphics/Procedural/Texture/texturemodifier.h"
71 
72 namespace Mezzanine
73 {
74  namespace Graphics
75  {
76  namespace Procedural
77  {
78  ///////////////////////////////////////////////////////////////////////////////
79  /// @brief A modifier that will use the colours of the texture to be modified to perform a linear interpolation between two other textures.
80  /// @details This modifier will perform a Lerp operation between the two specified textures. This differs from the LerpGenerator in that the
81  /// texture to be modified is used to determine the amount of interpolation there is to be performed. This operation is done on each colour
82  /// channel of each pixel. The result of the Lerp is then written back to the texture.
83  ///////////////////////////////////////
85  {
86  protected:
87  /// @internal
88  /// @brief The first texture to interpolate.
90  /// @internal
91  /// @brief The second texture to interpolate.
93  public:
94  /// @brief Blank constructor.
96  /// @brief Class destructor.
97  virtual ~WeighedLerpModifier();
98 
99  ///////////////////////////////////////////////////////////////////////////////
100  // Utility
101 
102  /// @copydoc TextureModifier::Modify(TextureBuffer&)
103  /// @remarks This image provides the weights that determine how much interpolation between the two parameters image there is to
104  /// perfrom, and then writes the result to this buffer.
105  virtual void Modify(TextureBuffer& Buffer);
106  /// @copydoc TextureModifier::GetName() const
107  virtual String GetName() const;
108 
109  ///////////////////////////////////////////////////////////////////////////////
110  // Configuration
111 
112  /// @brief The first texture to interpolate.
113  /// @exception If the texture provided here isn't at least the same size as the texture to be modified a PARAMETERS_EXCEPTION will be thrown.
114  /// @param First A pointer to the first texture to interpolate between. Initial Value: NULL.
115  /// @return Returns a reference to this.
116  WeighedLerpModifier& SetFirstTexture(TextureBuffer* First);
117  /// @brief The second texture to interpolate.
118  /// @exception If the texture provided here isn't at least the same size as the texture to be modified a PARAMETERS_EXCEPTION will be thrown.
119  /// @param Second A pointer to the second texture to interpolate between. Initial Value: NULL.
120  /// @return Returns a reference to this.
121  WeighedLerpModifier& SetSecondTexture(TextureBuffer* Second);
122  };//WeighedLerpModifier
123  }//Procedural
124  }//Graphics
125 }//Mezzanine
126 
127 #endif
A modifier that will use the colours of the texture to be modified to perform a linear interpolation ...
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
A base class for modifying the contents of an already populated texture buffer.
TextureBuffer * FirstTexture
The first texture to interpolate.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
TextureBuffer * SecondTexture
The second texture to interpolate.