Spinning Topp Logo BlackTopp Studios
inc
rotationzoommodifier.h
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 _graphicsproceduralrotationzoommodifier_h
68 #define _graphicsproceduralrotationzoommodifier_h
69 
70 #include "Graphics/Procedural/Texture/texturemodifier.h"
71 
72 #include "vector2.h"
73 
74 namespace Mezzanine
75 {
76  namespace Graphics
77  {
78  namespace Procedural
79  {
80  ///////////////////////////////////////////////////////////////////////////////
81  /// @brief A modifier that will apply a rotation to the image and optionally zoom in on it.
82  /// @details Edges that are clipped as a result of rotation will be rendered to the otherwise blank corners that are also formed from the rotation.
83  ///////////////////////////////////////
85  {
86  protected:
87  /// @internal
88  /// @brief The center position for the rotation to be applied.
90  /// @internal
91  /// @brief The amount of zoom to apply on both axes.
93  /// @internal
94  /// @brief The amount of rotation to apply in radians.
96  public:
97  /// @brief Blank constructor.
99  /// @brief Class destructor.
100  virtual ~RotationZoomModifier();
101 
102  ///////////////////////////////////////////////////////////////////////////////
103  // Utility
104 
105  /// @copydoc TextureModifier::Modify(TextureBuffer&)
106  virtual void Modify(TextureBuffer& Buffer);
107  /// @copydoc TextureModifier::GetName() const
108  virtual String GetName() const;
109 
110  ///////////////////////////////////////////////////////////////////////////////
111  // Configuration
112 
113  /// @brief Sets the relative position on the texture the rotation is to occur around.
114  /// @param Center The center position for the rotation to be applied in relative coordinates[0.0-1.0]. Initial Value: 0.5,0.5.
115  /// @return Returns a reference to this.
116  RotationZoomModifier& SetRotationCenter(const Vector2& Center);
117  /// @brief Sets the relative X position on the texture the rotation is to occur around.
118  /// @param X The center position for the rotation to be applied on the X axis in relative coordinates[0.0-1.0]. Initial Value: 0.5.
119  /// @return Returns a reference to this.
120  RotationZoomModifier& SetRotationCenterX(const Real X);
121  /// @brief Sets the relative Y position on the texture the rotation is to occur around.
122  /// @param Y The center position for the rotation to be applied on the Y axis in relative coordinates[0.0-1.0]. Initial Value: 0.5.
123  /// @return Returns a reference to this.
124  RotationZoomModifier& SetRotationCenterY(const Real Y);
125  /// @brief Sets the zoom to be applied to the texture after rotation.
126  /// @param Zoom The amount of zoom to apply on both axes. Initial Value: 1.0,1.0.
127  /// @return Returns a reference to this.
128  RotationZoomModifier& SetZoomFactor(const Vector2& Zoom);
129  /// @brief Sets the zoom to be applied to the texture on the X axis after rotation.
130  /// @param X The amount of zoom to apply on the X axis. Initial Value: 1.0.
131  /// @return Returns a reference to this.
132  RotationZoomModifier& SetZoomFactorX(const Real X);
133  /// @brief Sets the zoom to be applied to the texture on the Y axis after rotation.
134  /// @param Y The amount of zoom to apply on the Y axis. Initial Value: 1.0.
135  /// @return Returns a reference to this.
136  RotationZoomModifier& SetZoomFactorY(const Real Y);
137  /// @brief Sets the rotation to be applied.
138  /// @param Rot The amount of rotation to apply in radians. Initial Value: 0.0.
139  /// @return Returns a reference to this.
140  RotationZoomModifier& SetRotation(const Real Rot);
141  };//RotationZoomModifier
142  }//Procedural
143  }//Graphics
144 }//Mezzanine
145 
146 #endif
A modifier that will apply a rotation to the image and optionally zoom in on it.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
This is used to represent a point on a 2 dimentional area, such as a screen.
Definition: vector2.h:63
Real Rotation
The amount of rotation to apply in radians.
Vector2 ZoomFactor
The amount of zoom to apply on both axes.
Vector2 RotationCenter
The center position for the rotation to be applied.
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
A base class for modifying the contents of an already populated texture buffer.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159