Spinning Topp Logo BlackTopp Studios
inc
imagegenerator.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 _graphicsproceduralimagegenerator_cpp
68 #define _graphicsproceduralimagegenerator_cpp
69 
70 #include "Graphics/Procedural/Texture/imagegenerator.h"
71 
72 #include "Graphics/image.h"
73 
74 #include "exception.h"
75 
76 namespace Mezzanine
77 {
78  namespace Graphics
79  {
80  namespace Procedural
81  {
83  GenImage(NULL)
84  { }
85 
87  { }
88 
89  ///////////////////////////////////////////////////////////////////////////////
90  // Utility
91 
93  {
94  if( GenImage == NULL ) {
95  MEZZ_EXCEPTION(ExceptionBase::INVALID_STATE_EXCEPTION,"An input image has not been set.");
96  }
97 
98  if( GenImage->GetHeight() < Buffer.GetHeight() || GenImage->GetWidth() < Buffer.GetWidth() ) {
99  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"The provided buffer is too small to place the provided image.");
100  }
101 
102  for( Whole Y = 0 ; Y < Buffer.GetHeight() ; ++Y )
103  {
104  for( Whole X = 0 ; X < Buffer.GetWidth() ; ++X )
105  {
106  Buffer.SetPixel(X,Y,GenImage->GetColourAt(X,Y,0));
107  }
108  }
109  }
110 
112  { return "ImageGenerator"; }
113 
114  ///////////////////////////////////////////////////////////////////////////////
115  // Configuration
116 
118  {
119  this->GenImage = ToGenerate;
120  return *this;
121  }
122  }//Procedural
123  }//Graphics
124 }//Mezzanine
125 
126 #endif
Image * GenImage
A pointer to the image to copy into a TextureBuffer.
Creates an image to be modified from a pre-existing image on disk.
Whole GetWidth() const
Get the pixel width of this texture.
ColourValue GetColourAt(const Whole X, const Whole Y, const Whole Z) const
Gets the colour of an individual pixel in this image.
Definition: image.cpp:149
#define MEZZ_EXCEPTION(num, desc)
An easy way to throw exceptions with rich information.
Definition: exception.h:3048
UInt32 GetHeight() const
Gets the height of this image in pixels.
Definition: image.cpp:104
UInt32 GetWidth() const
Gets the width of this image in pixels.
Definition: image.cpp:101
This implements the exception hiearchy for Mezzanine.
virtual void AddToTextureBuffer(TextureBuffer &Buffer) const
Replaces and populates the pixels as configured in this generator to a TextureBuffer.
This class represents an image loaded into system memory.
Definition: image.h:63
Thrown when the available information should have worked but failed for unknown reasons.
Definition: exception.h:113
Thrown when parameters are checked at runtime and found invalid.
Definition: exception.h:108
virtual String GetName() const
Gets the name of this generator.
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.
ImageGenerator & SetImage(Image *ToGenerate)
Sets the image to copy into the TextureBuffer.
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...
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159