Spinning Topp Logo BlackTopp Studios
inc
blitmodifier.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 _graphicsproceduralblitmodifier_cpp
68 #define _graphicsproceduralblitmodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/blitmodifier.h"
71 
72 namespace Mezzanine
73 {
74  namespace Graphics
75  {
76  namespace Procedural
77  {
79  BlitSrcTexture(NULL)
80  { }
81 
83  { }
84 
85  ///////////////////////////////////////////////////////////////////////////////
86  // Utility
87 
89  {
90  /// @todo This algorithm is pretty basic pixel fetch and makes no attempt at sampling pixels for the proper colour. This should up updated to do some actual sampling.
91  if( this->BlitSrcTexture != NULL ) {
92  WholeRect SrcRect = this->BlitSrcRect;
93  WholeRect DestRect = this->BlitDestRect;
94  SrcRect.ClampToSize(this->BlitSrcTexture->GetWidth(),this->BlitSrcTexture->GetHeight());
95  DestRect.ClampToSize(Buffer.GetWidth(),Buffer.GetHeight());
96 
97  for( Whole Y = DestRect.Top ; Y < DestRect.Bottom ; ++Y )
98  {
99  for( Whole X = DestRect.Left ; X < DestRect.Right ; ++X )
100  {
101  Whole ResX = static_cast<Whole>( static_cast<Real>( X - DestRect.Left ) / static_cast<Real>( DestRect.GetWidth() ) * static_cast<Real>( SrcRect.GetWidth() ) + static_cast<Real>( SrcRect.Left ) );
102  Whole ResY = static_cast<Whole>( static_cast<Real>( Y - DestRect.Top ) / static_cast<Real>( DestRect.GetHeight() ) * static_cast<Real>( SrcRect.GetHeight() ) + static_cast<Real>( SrcRect.Top ) );
103  Buffer.SetPixel(X,Y,this->BlitSrcTexture->GetPixel(ResX,ResY));
104  }
105  }
106  }
107  }
108 
110  { return "BlitModifier"; }
111 
112  ///////////////////////////////////////////////////////////////////////////////
113  // Configuration
114 
116  {
117  this->BlitSrcTexture = SrcTexture;
118  return *this;
119  }
120 
122  {
123  this->BlitSrcRect = Rect;
124  return *this;
125  }
126 
127  BlitModifier& BlitModifier::SetSrcRect(const Whole RectLeft, const Whole RectTop, const Whole RectRight, const Whole RectBottom)
128  {
129  this->BlitSrcRect.SetValues(RectLeft,RectTop,RectRight,RectBottom);
130  return *this;
131  }
132 
134  {
135  this->BlitDestRect = Rect;
136  return *this;
137  }
138 
139  BlitModifier& BlitModifier::SetDestRect(const Whole RectLeft, const Whole RectTop, const Whole RectRight, const Whole RectBottom)
140  {
141  this->BlitDestRect.SetValues(RectLeft,RectTop,RectRight,RectBottom);
142  return *this;
143  }
144  }//Procedural
145  }//Graphics
146 }//Mezzanine
147 
148 #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 ...
virtual String GetName() const
Gets the name of this modifier.
BlitModifier & SetSrcTexture(TextureBuffer *SrcTexture)
Sets the source texture to be copied from.
void SetValues(const NumType RectLeft, const NumType RectTop, const NumType RectRight, const NumType RectBottom)
Sets the value of each member of this Rect.
Definition: rect.h:112
BlitModifier & SetDestRect(const WholeRect &Rect)
Sets the Rect on the destination texture to copy pixels to.
virtual ~BlitModifier()
Class destructor.
Whole GetWidth() const
Get the pixel width of this texture.
TextureBuffer * BlitSrcTexture
A pointer to the source texture from which to copy pixels.
Definition: blitmodifier.h:89
BlitModifier & SetSrcRect(const WholeRect &Rect)
Sets the Rect on the source texture to copy pixels from.
NumType GetWidth() const
Gets the width of this Rect.
Definition: rect.h:133
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
NumType Bottom
The Bottom edge of the rect.
Definition: rect.h:69
A modifier that will copy a portion of one texture and place it into another.
Definition: blitmodifier.h:84
NumType Right
The Right edge of the rect.
Definition: rect.h:67
NumType Left
The Left edge of the rect.
Definition: rect.h:63
WholeRect BlitDestRect
The bounds of the pixels to be copied over in the destination texture.
Definition: blitmodifier.h:95
void ClampToSize(const NumType Width, const NumType Height)
Clamps the position and size of this Rect to the provided size.
Definition: rect.h:123
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.
NumType Top
The Top edge of the rect.
Definition: rect.h:65
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...
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
NumType GetHeight() const
Gets the height of this Rect.
Definition: rect.h:137
WholeRect BlitSrcRect
The bounds of the pixels to copy from the source texture.
Definition: blitmodifier.h:92
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.