Spinning Topp Logo BlackTopp Studios
inc
cylinderuvmodifier.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 _graphicsproceduralcylinderuvmodifier_cpp
68 #define _graphicsproceduralcylinderuvmodifier_cpp
69 
70 #include "Graphics/Procedural/Mesh/cylinderuvmodifier.h"
71 
72 #include "MathTools/mathtools.h"
73 
74 #include "exception.h"
75 
76 namespace Mezzanine
77 {
78  namespace Graphics
79  {
80  namespace Procedural
81  {
83  CylinderHeight(1.0),
84  CylinderRadius(1.0)
85  { }
86 
88  { }
89 
90  ///////////////////////////////////////////////////////////////////////////////
91  // Utility
92 
94  {
95  if( this->CylinderHeight <= 0 )
96  MEZZ_EXCEPTION(ExceptionBase::INVALID_STATE_EXCEPTION,"Cylinder height must be positive.");
97  if( this->CylinderRadius <= 0 )
98  MEZZ_EXCEPTION(ExceptionBase::INVALID_STATE_EXCEPTION,"Cylinder radius must be positive.");
99 
100  Real AngleThreshold = MathTools::ATan( this->CylinderHeight / this->CylinderRadius );
101  for( VertexIterator VertIt = Buffer.GetVertices().begin() ; VertIt != Buffer.GetVertices().end() ; ++VertIt )
102  {
103  Vector2 XZNorm( VertIt->Normal.X, VertIt->Normal.Z );
104  Real Alpha = ( MathTools::ATan( VertIt->Normal.Y / XZNorm.Length() ) + MathTools::GetHalfPi() );
105  if( MathTools::Abs(Alpha) > AngleThreshold ) {
106  Vector2 XZVec( VertIt->Position.X, VertIt->Position.Z );
107  VertIt->UV = XZVec / this->CylinderRadius;
108  }else{
109  Vector2 XZVec( VertIt->Position.X, VertIt->Position.Z );
110  VertIt->UV.X = Vector2::Unit_X().AngleTo(XZVec) / MathTools::GetTwoPi();
111  VertIt->UV.Y = VertIt->Position.Y / this->CylinderHeight - 0.5;
112  }
113  }
114  }
115 
117  { return "CylinderUVModifier"; }
118 
119  ///////////////////////////////////////////////////////////////////////////////
120  // Configuration
121 
123  {
124  this->CylinderHeight = Height;
125  return *this;
126  }
127 
129  {
130  this->CylinderRadius = Radius;
131  return *this;
132  }
133  }//Procedural
134  }//Graphics
135 }//Mezzanine
136 
137 #endif
CylinderUVModifier & SetHeight(const Real Height)
Sets the Height of the cylinder to generate UV's for.
Real CylinderHeight
The total height of the cylinder to project the UV's onto.
VertexContainer::iterator VertexIterator
Iterator type for Vertex instances in a VertexContainer.
A convenience buffer that stores vertices and indices of a mesh to be generated.
#define MEZZ_EXCEPTION(num, desc)
An easy way to throw exceptions with rich information.
Definition: exception.h:3048
virtual void Modify(TriangleBuffer &Buffer)
Alters the generated pixels in a TriangleBuffer.
Real AngleTo(const Vector2 &Other) const
Gets an oriented angle between this Vector2 and another Vector2.
Definition: vector2.cpp:288
This implements the exception hiearchy for Mezzanine.
VertexContainer & GetVertices()
Gets a modifiable reference to Vertices.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
CylinderUVModifier & SetRadius(const Real Radius)
Sets the Radius of the cylinder to generate UV's for.
This is used to represent a point on a 2 dimentional area, such as a screen.
Definition: vector2.h:63
static Vector2 Unit_X()
Gets a vector representing the X unit of a Vector2.
Definition: vector2.cpp:84
Thrown when the available information should have worked but failed for unknown reasons.
Definition: exception.h:113
Real Length() const
Gets the length of this vector.
Definition: vector2.cpp:257
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
Real CylinderRadius
The radius of the cylinder to project the UV's onto.
virtual String GetName() const
Gets the name of this modifier.
A modifier that will generate UV coordinates as they would need to be on a cylinder model...
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159