Spinning Topp Logo BlackTopp Studios
inc
ellipsemodifier.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 _graphicsproceduralellipsemodifier_cpp
68 #define _graphicsproceduralellipsemodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/ellipsemodifier.h"
71 
72 namespace Mezzanine
73 {
74  namespace Graphics
75  {
76  namespace Procedural
77  {
79  FillColour(1.0,1.0,1.0,1.0),
80  PositionXRel(0.5),
81  PositionYRel(0.5),
82  RadiusXRel(0.5),
83  RadiusYRel(0.5),
84  PositionXAdj(0),
85  PositionYAdj(0),
86  RadiusXAdj(0),
87  RadiusYAdj(0)
88  { }
89 
91  { }
92 
93  void EllipseModifier::PutPixel(const Integer XPos, const Integer YPos, TextureBuffer& Buffer)
94  {
95  if( XPos < 0 || XPos >= static_cast<Integer>( Buffer.GetWidth() ) ) {
96  return;
97  }
98  if( YPos < 0 || YPos >= static_cast<Integer>( Buffer.GetHeight() ) ) {
99  return;
100  }
101  Buffer.SetPixel(XPos,YPos,this->FillColour);
102  }
103 
104  ///////////////////////////////////////////////////////////////////////////////
105  // Utility
106 
108  {
109  const Integer TargetWidth = static_cast<Integer>( Buffer.GetWidth() );
110  const Integer TargetHeight = static_cast<Integer>( Buffer.GetHeight() );
111  const Integer XPos = ( ( this->PositionXRel * TargetWidth ) + this->PositionXAdj );
112  const Integer YPos = ( ( this->PositionYRel * TargetHeight ) + this->PositionYAdj );
113  const Integer XRadius = std::max( static_cast<Integer>( this->RadiusXRel * TargetWidth ) + this->RadiusXAdj, 0 );
114  const Integer YRadius = std::max( static_cast<Integer>( this->RadiusYRel * TargetHeight ) + this->RadiusYAdj, 0 );
115  const Integer SquaredXRadius = XRadius * XRadius;
116  const Integer SquaredYRadius = YRadius * YRadius;
117 
118  // StackOverflow Logic
119  {
120  const Integer SquaredDimensions = SquaredXRadius * SquaredYRadius;
121  Integer OuterMostX = XRadius;
122  Integer PrevDelta = 0;
123  // do the horizontal diameter
124  for( Integer CurrX = -XRadius ; CurrX <= XRadius ; ++CurrX )
125  {
126  this->PutPixel(XPos + CurrX,XPos,Buffer);
127  }
128 
129  // now do both halves at the same time, away from the diameter
130  for( Integer CurrY = 1 ; CurrY <= YRadius ; ++CurrY )
131  {
132  Integer OuterMostXCheck = OuterMostX - ( PrevDelta - 1 ); // try slopes of dx - 1 or more
133  for( ; OuterMostXCheck > 0 ; --OuterMostXCheck )
134  {
135  if( OuterMostXCheck * OuterMostXCheck * SquaredYRadius + CurrY * CurrY * SquaredXRadius <= SquaredDimensions ) {
136  break;
137  }
138  }
139  PrevDelta = OuterMostX - OuterMostXCheck; // current approximation of the slope
140  OuterMostX = OuterMostXCheck;
141 
142  for( Integer CurrX = -OuterMostX ; CurrX <= OuterMostX ; ++CurrX )
143  {
144  this->PutPixel(XPos + CurrX,YPos - CurrY,Buffer);
145  this->PutPixel(XPos + CurrX,YPos + CurrY,Buffer);
146  }
147  }
148  }
149 
150  // Ogre Procedural Logic
151  /*{
152  Integer DeltaX = 0;
153  Integer DeltaY = YRadius;
154  Integer err = SquaredYRadius - ( 2 * YRadius - 1 ) * SquaredXRadius;
155  Integer e2 = 0;
156 
157  do
158  {
159  for( Integer CurrY = -DeltaY ; CurrY <= DeltaY ; ++CurrY )
160  {
161  this->PutPixel( XPos + (+DeltaX), YPos + CurrY, Buffer );
162  this->PutPixel( XPos + (-DeltaX), YPos + CurrY, Buffer );
163  }
164 
165  e2 = 2 * err;
166  if( e2 < ( 2 * DeltaX + 1 ) * SquaredYRadius ) {
167  DeltaX++;
168  err += ( 2 * DeltaX + 1 ) * SquaredYRadius;
169  }
170  if( e2 > -( 2 * DeltaY - 1 ) * SquaredXRadius ) {
171  DeltaY--;
172  err -= ( 2 * DeltaY - 1 ) * SquaredXRadius;
173  }
174  }
175  while( DeltaY >= 0 );
176 
177  while( DeltaX++ < XRadius )
178  {
179  this->PutPixel( XPos + (+DeltaX), YPos, Buffer );
180  this->PutPixel( XPos + (-DeltaX), YPos, Buffer );
181  }
182  }// */
183  }
184 
186  { return "EllipseModifier"; }
187 
188  ///////////////////////////////////////////////////////////////////////////////
189  // Configuration
190 
192  { this->FillColour = Colour; return *this; }
193 
194  EllipseModifier& EllipseModifier::SetColour(const Real Red, const Real Green, const Real Blue, const Real Alpha)
195  { this->FillColour.SetValues(Red,Green,Blue,Alpha); return *this; }
196 
197  EllipseModifier& EllipseModifier::SetColour(const UInt8 Red, const UInt8 Green, const UInt8 Blue, const UInt8 Alpha)
198  { 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; }
199 
200  EllipseModifier& EllipseModifier::SetEllipse(const Real XPosition, const Real YPosition, const Real XRadius, const Real YRadius)
201  {
202  this->PositionXRel = XPosition;
203  this->PositionYRel = YPosition;
204  this->RadiusXRel = XRadius;
205  this->RadiusYRel = YRadius;
206  return *this;
207  }
208 
209  EllipseModifier& EllipseModifier::SetEllipse(const Integer XPosition, const Integer YPosition, const Integer XRadius, const Integer YRadius)
210  {
211  this->PositionXAdj = XPosition;
212  this->PositionYAdj = YPosition;
213  this->RadiusXAdj = XRadius;
214  this->RadiusYAdj = YRadius;
215  return *this;
216  }
217 
218  EllipseModifier& EllipseModifier::SetEllipse(const Real XPositionRel, const Real YPositionRel, const Real XRadiusRel, const Real YRadiusRel, const Integer XPositionAdj, const Integer YPositionAdj, const Integer XRadiusAdj, const Integer YRadiusAdj)
219  {
220  this->PositionXRel = XPositionRel;
221  this->PositionYRel = YPositionRel;
222  this->RadiusXRel = XRadiusRel;
223  this->RadiusYRel = YRadiusRel;
224  this->PositionXAdj = XPositionAdj;
225  this->PositionYAdj = YPositionAdj;
226  this->RadiusXAdj = XRadiusAdj;
227  this->RadiusYAdj = YRadiusAdj;
228  return *this;
229  }
230 
231  EllipseModifier& EllipseModifier::SetPosition(const Real XPositionRel, const Real YPositionRel, const Integer XPositionAdj, const Integer YPositionAdj)
232  {
233  this->PositionXRel = XPositionRel;
234  this->PositionYRel = YPositionRel;
235  this->PositionXAdj = XPositionAdj;
236  this->PositionYAdj = YPositionAdj;
237  return *this;
238  }
239 
240  EllipseModifier& EllipseModifier::SetRadius(const Real XRadiusRel, const Real YRadiusRel, const Integer XRadiusAdj, const Integer YRadiusAdj)
241  {
242  this->RadiusXRel = XRadiusRel;
243  this->RadiusYRel = YRadiusRel;
244  this->RadiusXAdj = XRadiusAdj;
245  this->RadiusYAdj = YRadiusAdj;
246  return *this;
247  }
248 
250  { this->PositionXRel = X; return *this; }
251 
253  { this->PositionYRel = Y; return *this; }
254 
256  { this->RadiusXRel = X; return *this; }
257 
259  { this->RadiusYRel = Y; return *this; }
260 
262  { this->PositionXAdj = X; return *this; }
263 
265  { this->PositionYAdj = Y; return *this; }
266 
268  { this->RadiusXAdj = X; return *this; }
269 
271  { this->RadiusYAdj = Y; return *this; }
272  }//Procedural
273  }//Graphics
274 }//Mezzanine
275 
276 #endif
void PutPixel(const Integer XPos, const Integer YPos, TextureBuffer &Buffer)
Convenience method for placing a pixel for the ellipse.
EllipseModifier & SetYPositionAdj(const Integer Y)
Sets the absolute component of the top edge.
EllipseModifier & SetYPositionRel(const Real Y)
Sets the relative component of the top edge.
EllipseModifier & SetXRadiusAdj(const Integer X)
Sets the absolute component for the horizontal radius.
EllipseModifier & SetPosition(const Real XPositionRel, const Real YPositionRel, const Integer XPositionAdj, const Integer YPositionAdj)
Sets the relative and offset values for the ellipse position.
EllipseModifier & SetYRadiusRel(const Real Y)
Sets the relative component of the vertical radius.
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
EllipseModifier & SetXPositionRel(const Real X)
Sets the relative component of the left edge.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
Integer RadiusXAdj
The horizontal radius adjustment of the ellipse after relative coordinates are calculated.
Real RadiusXRel
The horizontal radius of the ellipse in relative coordinates.
Integer RadiusYAdj
The vertical radius adjustment of the ellipse after relative coordinates are calculated.
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
EllipseModifier & SetXPositionAdj(const Integer X)
Sets the absolute component of the left edge.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
ColourValue FillColour
The colour of the ellipse to apply to the texture.
Integer PositionXAdj
The left edge adjustment of the ellipse after relative coordinates are calculated.
Real PositionYRel
The top edge of the ellipse in relative coordinates.
EllipseModifier & SetEllipse(const Real XPosition, const Real YPosition, const Real XRadius, const Real YRadius)
Sets the relative position and radius of this ellipse..
void SetValues(const Real Red, const Real Green, const Real Blue, const Real Alpha)
Sets each of the colour channels.
A modifier that draws a simple coloured ellipse onto the texture.
Real PositionXRel
The left edge of the ellipse in relative coordinates.
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.
EllipseModifier & SetRadius(const Real XRadiusRel, const Real YRadiusRel, const Integer XRadiusAdj, const Integer YRadiusAdj)
Sets the relative and offset values for the ellipse radius.
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...
EllipseModifier & SetXRadiusRel(const Real X)
Sets the relative component of the horizontal radius.
Real RadiusYRel
The vertical radius of the ellipse in relative coordinates.
EllipseModifier & SetColour(const ColourValue &Colour)
Sets the colour of the ellipse to be generated.
virtual String GetName() const
Gets the name of this modifier.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
Integer PositionYAdj
The top edge adjustment of the ellipse after relative coordinates are calculated. ...
EllipseModifier & SetYRadiusAdj(const Integer Y)
Sets the absolute component for the vertical radius.