Spinning Topp Logo BlackTopp Studios
inc
rectanglemodifier.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 _graphicsproceduralrectanglemodifier_cpp
68 #define _graphicsproceduralrectanglemodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/rectanglemodifier.h"
71 
72 #include "MathTools/mathtools.h"
73 
74 namespace Mezzanine
75 {
76  namespace Graphics
77  {
78  namespace Procedural
79  {
81  FillColour(1.0,1.0,1.0,1.0),
82  PositionXRel(0.0),
83  PositionYRel(0.0),
84  SizeXRel(1.0),
85  SizeYRel(1.0),
86  PositionXAdj(0),
87  PositionYAdj(0),
88  SizeXAdj(0),
89  SizeYAdj(0)
90  { }
91 
93  { }
94 
95  ///////////////////////////////////////////////////////////////////////////////
96  // Utility
97 
99  {
100  const Real Width = static_cast<Real>( Buffer.GetWidth() );
101  const Real Height = static_cast<Real>( Buffer.GetHeight() );
102  const Integer LeftMost = MathTools::Clamp( static_cast<Integer>( Width * this->PositionXRel ) + this->PositionXAdj, 0, static_cast<Integer>( Buffer.GetWidth() ) );
103  const Integer RightMost = MathTools::Clamp( LeftMost + ( static_cast<Integer>( Width * this->SizeXRel ) + this->PositionYAdj ), 0, static_cast<Integer>( Buffer.GetWidth() ) );
104  const Integer TopMost = MathTools::Clamp( static_cast<Integer>( Height * this->PositionYRel ) + this->SizeXAdj, 0, static_cast<Integer>( Buffer.GetHeight() ) );
105  const Integer BottomMost = MathTools::Clamp( TopMost + ( static_cast<Integer>( Height * this->SizeYRel ) + this->SizeYAdj ), 0, static_cast<Integer>( Buffer.GetHeight() ) );
106 
107  for( Integer Y = TopMost ; Y <= BottomMost ; ++Y )
108  {
109  for( Integer X = LeftMost ; X <= RightMost ; ++X )
110  {
111  Buffer.SetPixel(X,Y,this->FillColour);
112  }
113  }
114  }
115 
117  { return "RectangleModifier"; }
118 
119  ///////////////////////////////////////////////////////////////////////////////
120  // Configuration
121 
123  { this->FillColour = Colour; return *this; }
124 
125  RectangleModifier& RectangleModifier::SetColour(const Real Red, const Real Green, const Real Blue, const Real Alpha)
126  { this->FillColour.SetValues(Red,Green,Blue,Alpha); return *this; }
127 
128  RectangleModifier& RectangleModifier::SetColour(const UInt8 Red, const UInt8 Green, const UInt8 Blue, const UInt8 Alpha)
129  { this->FillColour.SetValues(static_cast<Real>(Red) / 255.0,static_cast<Real>(Green) / 255.0,static_cast<Real>(Blue) / 255.0,static_cast<Real>(Alpha) / 255.0); return *this; }
130 
131  RectangleModifier& RectangleModifier::SetRectangle(const Real XPosition, const Real YPosition, const Real XSize, const Real YSize)
132  {
133  this->PositionXRel = XPosition;
134  this->PositionYRel = YPosition;
135  this->SizeXRel = XSize;
136  this->SizeYRel = YSize;
137  return *this;
138  }
139 
140  RectangleModifier& RectangleModifier::SetRectangle(const Integer XPosition, const Integer YPosition, const Integer XSize, const Integer YSize)
141  {
142  this->PositionXAdj = XPosition;
143  this->PositionYAdj = YPosition;
144  this->SizeXAdj = XSize;
145  this->SizeYAdj = YSize;
146  return *this;
147  }
148 
149  RectangleModifier& RectangleModifier::SetRectangle(const Real XPositionRel, const Real YPositionRel, const Real XSizeRel, const Real YSizeRel, const Integer XPositionAdj, const Integer YPositionAdj, const Integer XSizeAdj, const Integer YSizeAdj)
150  {
151  this->PositionXRel = XPositionRel;
152  this->PositionYRel = YPositionRel;
153  this->SizeXRel = XSizeRel;
154  this->SizeYRel = YSizeRel;
155  this->PositionXAdj = XPositionAdj;
156  this->PositionYAdj = YPositionAdj;
157  this->SizeXAdj = XSizeAdj;
158  this->SizeYAdj = YSizeAdj;
159  return *this;
160  }
161 
162  RectangleModifier& RectangleModifier::SetPosition(const Real XPositionRel, const Real YPositionRel, const Integer XPositionAdj, const Integer YPositionAdj)
163  {
164  this->PositionXRel = XPositionRel;
165  this->PositionYRel = YPositionRel;
166  this->PositionXAdj = XPositionAdj;
167  this->PositionYAdj = YPositionAdj;
168  return *this;
169  }
170 
171  RectangleModifier& RectangleModifier::SetSize(const Real XSizeRel, const Real YSizeRel, const Integer XSizeAdj, const Integer YSizeAdj)
172  {
173  this->SizeXRel = XSizeRel;
174  this->SizeYRel = YSizeRel;
175  this->SizeXAdj = XSizeAdj;
176  this->SizeYAdj = YSizeAdj;
177  return *this;
178  }
179 
181  { this->PositionXRel = X; return *this; }
182 
184  { this->PositionYRel = Y; return *this; }
185 
187  { this->SizeXRel = X; return *this; }
188 
190  { this->SizeYRel = Y; return *this; }
191 
193  { this->PositionXAdj = X; return *this; }
194 
196  { this->PositionYAdj = Y; return *this; }
197 
199  { this->SizeXAdj = X; return *this; }
200 
202  { this->SizeYAdj = Y; return *this; }
203  }//Procedural
204  }//Graphics
205 }//Mezzanine
206 
207 #endif
RectangleModifier & SetYSizeAdj(const Integer Y)
Sets the absolute component for the vertical size.
RectangleModifier & SetPosition(const Real XPositionRel, const Real YPositionRel, const Integer XPositionAdj, const Integer YPositionAdj)
Sets the relative and offset values for the rectangle position.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
RectangleModifier & SetColour(const ColourValue &Colour)
Sets the colour of the rectangle to be generated.
RectangleModifier & SetSize(const Real XSizeRel, const Real YSizeRel, const Integer XSizeAdj, const Integer YSizeAdj)
Sets the relative and offset values for the rectangle size.
Whole GetWidth() const
Get the pixel width of this texture.
RectangleModifier & SetYPositionAdj(const Integer Y)
Sets the absolute component of the top edge.
Integer PositionYAdj
The top edge adjustment of the rectangle after relative coordinates are calculated.
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
uint8_t UInt8
An 8-bit unsigned integer.
Definition: datatypes.h:118
This is a simple class for holding 4 reals representing the colour any give object or lightsource can...
Definition: colourvalue.h:64
ColourValue FillColour
The colour of the rectangle to apply to the texture.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
RectangleModifier & SetXSizeRel(const Real X)
Sets the relative component of the horizontal size.
Real SizeXRel
The horizontal size of the rectangle in relative coordinates.
Real SizeYRel
The vertical size of the rectangle in relative coordinates.
Real PositionXRel
The left edge of the rectangle in relative coordinates.
Real PositionYRel
The top edge of the rectangle in relative coordinates.
RectangleModifier & SetYPositionRel(const Real Y)
Sets the relative component of the top edge.
RectangleModifier & SetXPositionRel(const Real X)
Sets the relative component of the left edge.
Integer SizeXAdj
The horizontal size adjustment of the rectangle after relative coordinates are calculated.
RectangleModifier & SetRectangle(const Real XPosition, const Real YPosition, const Real XSize, const Real YSize)
Sets the relative position and size of this rectangle..
void SetValues(const Real Red, const Real Green, const Real Blue, const Real Alpha)
Sets each of the colour channels.
virtual String GetName() const
Gets the name of this modifier.
RectangleModifier & SetYSizeRel(const Real Y)
Sets the relative component of the vertical size.
RectangleModifier & SetXPositionAdj(const Integer X)
Sets the absolute component of the left edge.
A modifier that draws a simple coloured rectangle onto the texture.
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
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...
RectangleModifier & SetXSizeAdj(const Integer X)
Sets the absolute component for the horizontal size.
Integer PositionXAdj
The left edge adjustment of the rectangle after relative coordinates are calculated.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
Integer SizeYAdj
The vertical size adjustment of the rectangle after relative coordinates are calculated.