Spinning Topp Logo BlackTopp Studios
inc
alphamaskmodifier.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 _graphicsproceduralalphamaskmodifier_cpp
68 #define _graphicsproceduralalphamaskmodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/alphamaskmodifier.h"
71 
72 #include "vector3.h"
73 #include "exception.h"
74 
75 namespace Mezzanine
76 {
77  namespace Graphics
78  {
79  namespace Procedural
80  {
82  MaskTexture(NULL),
83  ColourMask(false)
84  { }
85 
87  { }
88 
89  ///////////////////////////////////////////////////////////////////////////////
90  // Utility
91 
93  {
94  Whole MaskWidth = this->MaskTexture->GetWidth();
95  Whole MaskHeight = this->MaskTexture->GetHeight();
96  Whole TargetWidth = Buffer.GetWidth();
97  Whole TargetHeight = Buffer.GetHeight();
98 
99  if( MaskWidth != TargetWidth && MaskHeight != TargetHeight ) {
100  MEZZ_EXCEPTION(ExceptionBase::INVALID_STATE_EXCEPTION,"The MaskTexture size and the target texture size must be the same.");
101  }
102 
103  for( Whole Y = 0 ; Y < TargetHeight ; ++Y )
104  {
105  for( Whole X = 0 ; X < TargetWidth ; ++X )
106  {
107  if( this->MaskTexture != NULL ) {
108  if( this->ColourMask ) {
109  ColourValue PixelA = Buffer.GetPixel(X,Y);
110  ColourValue PixelB = this->MaskTexture->GetPixel(X,Y);
111  Vector3 Colour1( PixelA.RedChannel * 255.0, PixelA.GreenChannel * 255.0, PixelA.BlueChannel * 255.0 );
112  Vector3 Colour2( PixelB.RedChannel * 255.0, PixelB.GreenChannel * 255.0, PixelB.BlueChannel * 255.0 );
113 
114  Colour1.Normalize();
115  Colour2.Normalize();
116 
117  Real Correctness = 0;
118 
119  if( !Colour1.IsZeroLength() && !Colour2.IsZeroLength() ) {
120  Correctness = Colour1.X * Colour2.X + Colour1.Y * Colour2.Y + Colour1.Z * Colour2.Z;
121  }
122 
123  Buffer.SetAlphaByte(X,Y,static_cast<UInt8>(PixelA.AlphaChannel * Correctness));
124  }else{
125  ColourValue Pixel = this->MaskTexture->GetPixel(X,Y);
126  Real Alpha = ( Pixel.RedChannel + Pixel.GreenChannel + Pixel.BlueChannel ) / 3.0;
127  Buffer.SetAlphaReal(X,Y,Buffer.GetAlphaReal(X,Y) * Alpha);
128  }
129  }else{
130  UInt8 Alpha = Buffer.GetAlphaByte(X,Y);
131  Buffer.SetPixelByte(X,Y,Alpha,Alpha,Alpha,255);
132  }
133  }
134  }
135  }
136 
138  { return "AlphaMaskModifier"; }
139 
140  ///////////////////////////////////////////////////////////////////////////////
141  // Configuration
142 
144  { this->MaskTexture = Mask; return *this; }
145 
147  { this->ColourMask = UseColour; return *this; }
148  }//Procedural
149  }//Graphics
150 }//Mezzanine
151 
152 #endif
virtual String GetName() const
Gets the name of this modifier.
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 ...
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
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...
Real X
Coordinate on the X vector.
Definition: vector3.h:85
Real Z
Coordinate on the Z vector.
Definition: vector3.h:89
Whole GetWidth() const
Get the pixel width of this texture.
Real GetAlphaReal(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 ...
#define MEZZ_EXCEPTION(num, desc)
An easy way to throw exceptions with rich information.
Definition: exception.h:3048
AlphaMaskModifier & SetMaskTexture(TextureBuffer *Mask)
Sets the texture that will be used as the mask.
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
This implements the exception hiearchy for Mezzanine.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
Boole ColourMask
Whether or not to use normalized colours from the mask for calculating the alpha channel, instead of the intensity.
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 use a mask image to set the alpha channels of a source image.
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 AlphaChannel
Value from 0.0 to 1.0 representing the transparency of the colours. 1.0 is opaque and 0...
Definition: colourvalue.h:79
Vector3 & Normalize()
This will change this point into it's own normal relative to the origin.
Definition: vector3.cpp:352
Real Y
Coordinate on the Y vector.
Definition: vector3.h:87
void SetAlphaReal(const Whole X, const Whole Y, const Real Alpha)
Sets the alpha colour value of a specified pixel. the X or Y location go beyond the set size of this ...
AlphaMaskModifier & SetColourMask(const Boole UseColour)
Sets whether or not the colour of the mask will be used instead of the intensity. ...
Thrown when the available information should have worked but failed for unknown reasons.
Definition: exception.h:113
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
This is used to represent a point in space, or a vector through space.
Definition: vector3.h:77
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
Boole IsZeroLength() const
Checks to see if the length of this vector is zero.
Definition: vector3.cpp:469
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
void SetAlphaByte(const Whole X, const Whole Y, const ColourChannelType Alpha)
Sets the alpha colour value of a specified pixel. the X or Y location go beyond the set size of this ...
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
TextureBuffer * MaskTexture
A pointer to the texture to use as the Alpha Mask.