Spinning Topp Logo BlackTopp Studios
inc
flaremodifier.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 _graphicsproceduralflaremodifier_cpp
68 #define _graphicsproceduralflaremodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/flaremodifier.h"
71 
72 #include "MathTools/mathtools.h"
73 
74 namespace Mezzanine
75 {
76  namespace Graphics
77  {
78  namespace Procedural
79  {
81  FlareColour(1.0,1.0,1.0,1.0),
82  FlareCenter(0.5,0.5),
83  FlareRadius(0.5,0.5),
84  FlareBrightness(1.0)
85  { }
86 
88  { }
89 
90  ///////////////////////////////////////////////////////////////////////////////
91  // Utility
92 
94  {
95  Integer TargetWidth = static_cast<Integer>( Buffer.GetWidth() );
96  Integer TargetHeight = static_cast<Integer>( Buffer.GetHeight() );
97  Integer CenterX = static_cast<Integer>( this->FlareCenter.X * static_cast<Real>( TargetWidth ) );
98  Integer CenterY = static_cast<Integer>( this->FlareCenter.Y * static_cast<Real>( TargetHeight ) );
99  Integer RadiusX = static_cast<Integer>( this->FlareRadius.X * static_cast<Real>( TargetWidth ) );
100  Integer RadiusY = static_cast<Integer>( this->FlareRadius.Y * static_cast<Real>( TargetHeight ) );
101  Real FlareRed = this->FlareColour.RedChannel * 255.0;
102  Real FlareGreen = this->FlareColour.GreenChannel * 255.0;
103  Real FlareBlue = this->FlareColour.BlueChannel * 255.0;
104  Real InverseRadiusX = 1.0 / static_cast<Real>( RadiusX );
105  Real InverseRadiusY = 1.0 / static_cast<Real>( RadiusY );
106 
107  for( Integer Y = 0 ; Y < TargetHeight ; ++Y )
108  {
109  Real DeltaY = static_cast<Real>( Y - CenterY ) * InverseRadiusY;
110 
111  for( Integer X = 0 ; X < TargetWidth ; ++X )
112  {
113  Real DeltaX = static_cast<Real>( X - CenterX ) * InverseRadiusX;
114  Real Distance = MathTools::Sqrt(DeltaX * DeltaX + DeltaY * DeltaY);
115  if( Distance >= 1.0 ) {
116  Distance = 0.0;
117  }else{
118  Distance = 1.0 - Distance;
119  }
120 
121  Whole Red = static_cast<Whole>( static_cast<Real>( Buffer.GetRedByte(X,Y) ) + ( ( Distance * FlareRed ) * this->FlareBrightness ) );
122  Whole Green = static_cast<Whole>( static_cast<Real>( Buffer.GetGreenByte(X,Y) ) + ( ( Distance * FlareGreen ) * this->FlareBrightness ) );
123  Whole Blue = static_cast<Whole>( static_cast<Real>( Buffer.GetBlueByte(X,Y) ) + ( ( Distance * FlareBlue ) * this->FlareBrightness ) );
124  UInt8 Alpha = Buffer.GetAlphaByte(X,Y);
125 
126  Buffer.SetPixelByte(X,Y, static_cast<UInt8>( (Red < 255) ? Red : 255 ),static_cast<UInt8>( (Green < 255) ? Green : 255 ),static_cast<UInt8>( (Blue < 255) ? Blue : 255 ),Alpha);
127  }
128  }
129  }
130 
132  { return "FlareModifier"; }
133 
134  ///////////////////////////////////////////////////////////////////////////////
135  // Configuration
136 
138  {
139  this->FlareColour = Colour;
140  return *this;
141  }
142 
143  FlareModifier& FlareModifier::SetColour(const Real Red, const Real Green, const Real Blue, const Real Alpha)
144  {
145  this->FlareColour.SetValues(Red,Green,Blue,Alpha);
146  return *this;
147  }
148 
150  {
151  this->FlareCenter = Center;
152  return *this;
153  }
154 
156  {
157  this->FlareCenter.X = X;
158  this->FlareCenter.Y = Y;
159  return *this;
160  }
161 
163  {
164  this->FlareCenter.X = X;
165  return *this;
166  }
167 
169  {
170  this->FlareCenter.Y = Y;
171  return *this;
172  }
173 
175  {
176  this->FlareRadius = Radius;
177  return *this;
178  }
179 
181  {
182  this->FlareRadius.X = X;
183  this->FlareRadius.Y = Y;
184  return *this;
185  }
186 
188  {
189  this->FlareRadius.X = X;
190  return *this;
191  }
192 
194  {
195  this->FlareRadius.Y = Y;
196  return *this;
197  }
198 
200  {
201  this->FlareBrightness = Brightness;
202  return *this;
203  }
204  }//Procedural
205  }//Graphics
206 }//Mezzanine
207 
208 #endif
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...
FlareModifier & SetFlareCenterX(const Real X)
Sets the center position of the flare on the X axis.
Whole GetWidth() const
Get the pixel width of this texture.
ColourChannelType GetBlueByte(const Whole X, const Whole Y) const
Gets the blue colour value of a specified pixel. the X or Y location go beyond the set size of this t...
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
FlareModifier & SetColour(const ColourValue &Colour)
Sets the colour of the flare to be rendered.
uint8_t UInt8
An 8-bit unsigned integer.
Definition: datatypes.h:118
FlareModifier & SetFlareCenter(const Vector2 &Center)
Sets the center position of the flare.
This is a simple class for holding 4 reals representing the colour any give object or lightsource can...
Definition: colourvalue.h:64
ColourChannelType GetAlphaByte(const Whole X, const Whole Y) const
Gets the alpha colour value of a specified pixel. the X or Y location go beyond the set size of this ...
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
A modifier that will draw an illuminated circle that fades over a distance to a previous texture...
Definition: flaremodifier.h:84
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
FlareModifier & SetFlareBrightness(const Real Brightness)
Sets the brightness of the flare.
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
FlareModifier & SetFlareRadiusX(const Real X)
Sets the radius size of the flare on the X axis.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
FlareModifier & SetFlareCenterY(const Real Y)
Sets the center position of the flare on the Y axis.
void SetValues(const Real Red, const Real Green, const Real Blue, const Real Alpha)
Sets each of the colour channels.
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.
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
FlareModifier & SetFlareRadiusY(const Real Y)
Sets the radius size of the flare on the Y axis.
FlareModifier & SetFlareRadius(const Vector2 &Radius)
Sets the radius size of the flare.
Vector2 FlareCenter
The central position of the flare on the texture in relative coordinates.
Definition: flaremodifier.h:92
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
ColourChannelType GetGreenByte(const Whole X, const Whole Y) const
Gets the green colour value of a specified pixel. the X or Y location go beyond the set size of this ...
Real FlareBrightness
A modifier for the intensity of the flare colour.
Definition: flaremodifier.h:98
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
Vector2 FlareRadius
The radius of the flare to draw in relative coordinates.
Definition: flaremodifier.h:95
virtual String GetName() const
Gets the name of this modifier.
ColourChannelType GetRedByte(const Whole X, const Whole Y) const
Gets the red colour value of a specified pixel. the X or Y location go beyond the set size of this te...
ColourValue FlareColour
The colour of the flare to draw.
Definition: flaremodifier.h:89