Spinning Topp Logo BlackTopp Studios
inc
vortexmodifier.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 _graphicsproceduralvortexmodifier_cpp
68 #define _graphicsproceduralvortexmodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/vortexmodifier.h"
71 
72 #include "MathTools/mathtools.h"
73 
74 namespace Mezzanine
75 {
76  namespace Graphics
77  {
78  namespace Procedural
79  {
81  TwistAngle(0.0)
82  { }
83 
85  { }
86 
87  ///////////////////////////////////////////////////////////////////////////////
88  // Utility
89 
91  {
92  Integer TargetWidth = Buffer.GetWidth();
93  Integer TargetHeight = Buffer.GetHeight();
94  Integer dwCenterX = static_cast<Integer>( this->VortexCenter.X * static_cast<Real>(TargetWidth) );
95  Integer dwCenterY = static_cast<Integer>( this->VortexCenter.Y * static_cast<Real>(TargetHeight) );
96  Integer dwRadiusX = static_cast<Integer>( this->VortexRadius.X * static_cast<Real>(TargetWidth) );
97  Integer dwRadiusY = static_cast<Integer>( this->VortexRadius.Y * static_cast<Real>(TargetHeight) );
98  Real f1_RadiusX = 1.0 / static_cast<Real>(dwRadiusX);
99  Real f1_RadiusY = 1.0 / static_cast<Real>(dwRadiusY);
100  TextureBuffer TempBuffer( Buffer );
101 
102  for( Integer Y = 0 ; Y < TargetHeight ; ++Y )
103  {
104  Real dY = static_cast<Real>( Y - dwCenterY ) * f1_RadiusY;
105 
106  for( Integer X = 0 ; X < TargetWidth ; ++X )
107  {
108  Real dX = static_cast<Real>( X - dwCenterX ) * f1_RadiusX;
109  Real d = MathTools::Sqrt( dX * dX + dY * dY );
110 
111  if( d > 1.0 ) {
112  TempBuffer.SetPixel( X, Y, Buffer.GetPixel(X,Y) );
113  }else{
114  d = MathTools::Cos( d * MathTools::GetHalfPi() - MathTools::GetHalfPi() );
115  d = 1.0 - d;
116  Real nX = static_cast<Real>( X - dwCenterX );
117  Real nY = static_cast<Real>( Y - dwCenterY );
118  Real rad = this->TwistAngle * d;
119 
120  Real bX = nX;
121  nX = bX * MathTools::Cos(rad) - nY * MathTools::Sin(rad) + dwCenterX;
122  nY = bX * MathTools::Sin(rad) + nY * MathTools::Cos(rad) + dwCenterY;
123 
124  if( nX >= TargetWidth ) nX = nX - TargetWidth;
125  if( nY >= TargetHeight ) nY = nY - TargetHeight;
126  if( nX < 0 ) nX = TargetWidth + nX;
127  if( nY < 0 ) nY = TargetHeight + nY;
128 
129  Integer iX = static_cast<Integer>(nX);
130  Integer iY = static_cast<Integer>(nY);
131 
132  Real fracX = nX - iX;
133  Real fracY = nY - iY;
134 
135  Real ul = ( 1.0 - fracX ) * ( 1.0 - fracY );
136  Real ll = ( 1.0 - fracX ) * fracY;
137  Real ur = fracX * ( 1.0 - fracY );
138  Real lr = fracX * fracY;
139 
140  Integer WrapX = ( iX + 1 ) % TargetWidth;
141  Integer WrapY = ( iY + 1 ) % TargetHeight;
142  ColourValue PixelUL = Buffer.GetPixel( iX, iY );
143  ColourValue PixelUR = Buffer.GetPixel( WrapX, iY );
144  ColourValue PixelLL = Buffer.GetPixel( iX, WrapY );
145  ColourValue PixelLR = Buffer.GetPixel( WrapX, WrapY );
146 
147  TempBuffer.SetPixelByte( X, Y,
148  ( ul * PixelUL.RedChannel * 255.0 + ll * PixelLL.RedChannel * 255.0 + ur * PixelUR.RedChannel * 255.0 + lr * PixelLR.RedChannel * 255.0 ),
149  ( ul * PixelUL.GreenChannel * 255.0 + ll * PixelLL.GreenChannel * 255.0 + ur * PixelUR.GreenChannel * 255.0 + lr * PixelLR.GreenChannel * 255.0 ),
150  ( ul * PixelUL.BlueChannel * 255.0 + ll * PixelLL.BlueChannel * 255.0 + ur * PixelUR.BlueChannel * 255.0 + lr * PixelLR.BlueChannel * 255.0 ),
151  ( ul * PixelUL.AlphaChannel * 255.0 + ll * PixelLL.AlphaChannel * 255.0 + ur * PixelUR.AlphaChannel * 255.0 + lr * PixelLR.AlphaChannel * 255.0 ) );
152  }
153  }
154  }
155 
156  Buffer.SetData(TempBuffer);
157  }
158 
160  { return "VortexModifier"; }
161 
162  ///////////////////////////////////////////////////////////////////////////////
163  // Configuration
164 
166  { this->VortexCenter = Center; return *this; }
167 
169  { this->VortexCenter.X = X; this->VortexCenter.Y = Y; return *this; }
170 
172  { this->VortexCenter.X = X; return *this; }
173 
175  { this->VortexCenter.Y = Y; return *this; }
176 
178  { this->VortexRadius = Radius; return *this; }
179 
181  { this->VortexRadius.X = X; this->VortexRadius.Y = Y; return *this; }
182 
184  { this->VortexRadius.X = X; return *this; }
185 
187  { this->VortexRadius.Y = Y; return *this; }
188 
190  { this->TwistAngle = Twist; return *this; }
191  }//Procedural
192  }//Graphics
193 }//Mezzanine
194 
195 #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 ...
VortexModifier & SetVortexRadius(const Vector2 &Radius)
Sets the radius of the twisting circle.
void SetPixelByte(const Whole X, const Whole Y, const ColourChannelType Red, const ColourChannelType Green, const ColourChannelType Blue, const ColourChannelType Alpha=255)
Set colour of a specified pixel using a 0-255 range. the X or Y location go beyond the set size of th...
Vector2 VortexRadius
The size of the twisting circle on the texture.
Whole GetWidth() const
Get the pixel width of this texture.
VortexModifier & SetVortexRadiusY(const Real Y)
Sets the radius on the Y axis of the twisting circle.
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
This is a simple class for holding 4 reals representing the colour any give object or lightsource can...
Definition: colourvalue.h:64
VortexModifier & SetVortexRadiusX(const Real X)
Sets the radius on the X axis of the twisting circle.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
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 Y
Coordinate on the Y vector.
Definition: vector2.h:69
virtual String GetName() const
Gets the name of this modifier.
Real X
Coordinate on the X vector.
Definition: vector2.h:67
Vector2 VortexCenter
The center of the twisting circle on the texture.
Twists the pixel positions in a circle on the Texture.
This is used to represent a point on a 2 dimentional area, such as a screen.
Definition: vector2.h:63
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
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
VortexModifier & SetVortexCenter(const Vector2 &Center)
Sets the center point where the texture will be twisted.
VortexModifier & SetVortexTwist(const Real Twist)
Sets the angle by which to rotate pixels within the vortex.
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
Real TwistAngle
The amount of twist to be applied in radians.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
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
VortexModifier & SetVortexCenterY(const Real Y)
Sets the center point on the Y axis where the texture will be twisted.
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...
VortexModifier & SetVortexCenterX(const Real X)
Sets the center point on the X axis where the texture will be twisted.
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
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.