Spinning Topp Logo BlackTopp Studios
inc
rotationzoommodifier.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 _graphicsproceduralrotationzoommodifier_cpp
68 #define _graphicsproceduralrotationzoommodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/rotationzoommodifier.h"
71 
72 #include "MathTools/mathtools.h"
73 
74 namespace Mezzanine
75 {
76  namespace Graphics
77  {
78  namespace Procedural
79  {
81  RotationCenter(0.5,0.5),
82  ZoomFactor(1.0,1.0),
83  Rotation(0.0)
84  { }
85 
87  { }
88 
89  ///////////////////////////////////////////////////////////////////////////////
90  // Utility
91 
93  {
94  Whole Width = Buffer.GetWidth();
95  Whole Height = Buffer.GetHeight();
96  TextureBuffer TempBuffer( Buffer );
97 
98  Real fZoomX = MathTools::Pow( 0.5, this->ZoomFactor.X - 1 );
99  Real fZoomY = MathTools::Pow( 0.5, this->ZoomFactor.Y - 1 );
100  Real RotSin = MathTools::Sin( this->Rotation );
101  Real RotCos = MathTools::Cos( this->Rotation );
102  Real HalfWidth = static_cast<Real>(Width) * 0.5;
103  Real HalfHeight = static_cast<Real>(Height) * 0.5;
104  Real XSin = RotSin * -HalfWidth;
105  Real XCos = RotCos * -HalfWidth;
106  Real YSin = RotSin * -HalfHeight;
107  Real YCos = RotCos * -HalfHeight;
108 
109  for( Whole Y = 0 ; Y < Buffer.GetHeight() ; ++Y )
110  {
111  Real TexU = ( ( XCos - YSin ) * fZoomX ) + ( this->RotationCenter.X * static_cast<Real>(Width) );
112  Real TexV = ( ( XSin + YCos ) * fZoomY ) + ( this->RotationCenter.Y * static_cast<Real>(Height) );
113  for( Whole X = 0 ; X < Buffer.GetWidth() ; ++X )
114  {
115  Real uf = (TexU >= 0) ? (TexU - (Integer)TexU) : 1 + (TexU - (Integer)TexU);
116  Real vf = (TexV >= 0) ? (TexV - (Integer)TexV) : 1 + (TexV - (Integer)TexV);
117  Whole ut = (TexU >= 0) ? (Whole)TexU : (Whole)TexU - 1;
118  Whole vt = (TexV >= 0) ? (Whole)TexV : (Whole)TexV - 1;
119 
120  ColourValue Texel = Buffer.GetPixel( vt % Height, ut % Width ) * ( 1.0 - uf ) * ( 1.0 - vf );
121  Texel += Buffer.GetPixel( vt % Height, ( ut + 1 ) % Width ) * uf * ( 1.0 - vf );
122  Texel += Buffer.GetPixel( ( vt + 1 ) % Height, ut % Width ) * ( 1.0 - uf ) * vf;
123  Texel += Buffer.GetPixel( ( vt + 1 ) % Height, ( ut + 1 ) % Width ) * uf * vf;
124 
125  Texel.RedChannel = std::min(Real(1.0),Texel.RedChannel);
126  Texel.GreenChannel = std::min(Real(1.0),Texel.GreenChannel);
127  Texel.BlueChannel = std::min(Real(1.0),Texel.BlueChannel);
128  Texel.AlphaChannel = std::min(Real(1.0),Texel.AlphaChannel);
129  TempBuffer.SetPixel(X,Y,Texel);
130 
131  TexU += RotCos * fZoomX;
132  TexV += RotSin * fZoomY;
133  }
134  YSin += RotSin;
135  YCos += RotCos;
136  }
137 
138  Buffer.SetData(TempBuffer);
139  }
140 
142  { return "RotationZoomModifier"; }
143 
144  ///////////////////////////////////////////////////////////////////////////////
145  // Configuration
146 
148  { this->RotationCenter = Center; return *this; }
149 
151  { this->RotationCenter.X = X; return *this; }
152 
154  { this->RotationCenter.Y = Y; return *this; }
155 
157  { this->ZoomFactor = Zoom; return *this; }
158 
160  { this->ZoomFactor.X = X; return *this; }
161 
163  { this->ZoomFactor.Y = Y; return *this; }
164 
166  { this->Rotation = Rot; return *this; }
167  }//Procedural
168  }//Graphics
169 }//Mezzanine
170 
171 #endif
virtual String GetName() const
Gets the name of this modifier.
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 ...
RotationZoomModifier & SetRotationCenterX(const Real X)
Sets the relative X position on the texture the rotation is to occur around.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
Whole GetWidth() const
Get the pixel width of this texture.
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
A modifier that will apply a rotation to the image and optionally zoom in on it.
This is a simple class for holding 4 reals representing the colour any give object or lightsource can...
Definition: colourvalue.h:64
RotationZoomModifier & SetRotationCenter(const Vector2 &Center)
Sets the relative position on the texture the rotation is to occur around.
RotationZoomModifier & SetRotationCenterY(const Real Y)
Sets the relative Y position on the texture the rotation is to occur around.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
RotationZoomModifier & SetZoomFactorX(const Real X)
Sets the zoom to be applied to the texture on the X axis after rotation.
Real Y
Coordinate on the Y vector.
Definition: vector2.h:69
Real X
Coordinate on the X vector.
Definition: vector2.h:67
This is used to represent a point on a 2 dimentional area, such as a screen.
Definition: vector2.h:63
Real Rotation
The amount of rotation to apply in radians.
Vector2 ZoomFactor
The amount of zoom to apply on both axes.
Vector2 RotationCenter
The center position for the rotation to be applied.
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.
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...
RotationZoomModifier & SetZoomFactor(const Vector2 &Zoom)
Sets the zoom to be applied to the texture after rotation.
RotationZoomModifier & SetRotation(const Real Rot)
Sets the rotation to be applied.
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.
RotationZoomModifier & SetZoomFactorY(const Real Y)
Sets the zoom to be applied to the texture on the Y axis after rotation.