Spinning Topp Logo BlackTopp Studios
inc
torusgenerator.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 _graphicsproceduraltorusgenerator_cpp
68 #define _graphicsproceduraltorusgenerator_cpp
69 
70 #include "Graphics/Procedural/Mesh/torusgenerator.h"
71 
72 #include "MathTools/mathtools.h"
73 #include "exception.h"
74 
75 namespace Mezzanine
76 {
77  namespace Graphics
78  {
79  namespace Procedural
80  {
81  TorusGenerator::TorusGenerator(const Real PoloidalRadius, const Real ToroidalRadius, const Whole PoloidalSeg, const Whole ToroidalSeg) :
82  TorusPoloidalRadius(PoloidalRadius),
83  TorusToroidalRadius(ToroidalRadius),
84  NumPoloidalSeg(PoloidalSeg),
85  NumToroidalSeg(ToroidalSeg)
86  { }
87 
89  { }
90 
91  ///////////////////////////////////////////////////////////////////////////////
92  // Utility
93 
95  {
96  Buffer.RebaseOffset();
97  Buffer.EstimateVertexCount( ( this->NumPoloidalSeg + 1 ) * ( this->NumToroidalSeg + 1 ) );
98  Buffer.EstimateIndexCount( ( this->NumPoloidalSeg ) * ( this->NumToroidalSeg + 1 ) * 6 );
99 
100  Real deltaSection = ( MathTools::GetTwoPi() / this->NumToroidalSeg );
101  Real deltaCircle = ( MathTools::GetTwoPi() / this->NumPoloidalSeg );
102  Integer Offset = 0;
103 
104  for( Whole i = 0 ; i <= this->NumPoloidalSeg ; i++ )
105  {
106  for( Whole j = 0 ; j<= this->NumToroidalSeg ; j++ )
107  {
108  Vector3 c0( this->TorusPoloidalRadius, 0.0, 0.0 );
109  Vector3 v0( this->TorusPoloidalRadius + this->TorusToroidalRadius * cosf( j * deltaSection ), this->TorusToroidalRadius * sinf( j * deltaSection ), 0.0 );
110  Quaternion q( i * deltaCircle, Vector3::Unit_Y() );
111  Vector3 v = q * v0;
112  Vector3 c = q * c0;
113  this->AddPoint( Buffer, v,
114  ( v - c ).GetNormal(),
115  Vector2( i / (Real)this->NumPoloidalSeg, j / (Real)this->NumToroidalSeg ) );
116 
117  if( i != this->NumPoloidalSeg ) {
118  Buffer.AddIndex( Offset + this->NumToroidalSeg + 1 );
119  Buffer.AddIndex( Offset );
120  Buffer.AddIndex( Offset + this->NumToroidalSeg );
121  Buffer.AddIndex( Offset + this->NumToroidalSeg + 1 );
122  Buffer.AddIndex( Offset + 1 );
123  Buffer.AddIndex( Offset );
124  }
125  Offset++;
126  }
127  }
128  }
129 
130  ///////////////////////////////////////////////////////////////////////////////
131  // Configuration
132 
134  {
135  if( PoloidalRadius <= 0.0 )
136  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Radius for Poloidal ring of a generated torus mesh must be greater than zero.");
137 
138  this->TorusPoloidalRadius = PoloidalRadius;
139  return *this;
140  }
141 
143  {
144  if( ToroidalRadius <= 0.0 )
145  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Radius for Toroidal ring of a generated torus mesh must be greater than zero.");
146 
147  this->TorusToroidalRadius = ToroidalRadius;
148  return *this;
149  }
150 
152  {
153  if( PoloidalSeg < 3 )
154  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Number of segments for Poloidal ring of generated torus mesh must be greater than two.");
155 
156  this->NumPoloidalSeg = PoloidalSeg;
157  return *this;
158  }
159 
161  {
162  if( ToroidalSeg < 3 )
163  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Number of segments for Toroidal ring of generated torus mesh must be greater than two.");
164 
165  this->NumToroidalSeg = ToroidalSeg;
166  return *this;
167  }
168  }//Procedural
169  }//Graphics
170 }//Mezzanine
171 
172 #endif
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
TorusGenerator(const Real PoloidalRadius, const Real ToroidalRadius, const Whole PoloidalSeg=16, const Whole ToroidalSeg=16)
Class constructor.
void EstimateIndexCount(const Whole IndexCount)
Gives an estimation of the number of indices needed for this triangle buffer.
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
This implements the exception hiearchy for Mezzanine.
Real TorusPoloidalRadius
The radius of the primary ring of the torus.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
TorusGenerator & SetNumToroidalSeg(const Whole ToroidalSeg)
Sets the number of segments along the guiding circle. the number of segments is less than three...
void EstimateVertexCount(const Whole VertexCount)
Gives an estimation of the number of vertices need for this triangle buffer.
This is used to represent a point on a 2 dimentional area, such as a screen.
Definition: vector2.h:63
static Vector3 Unit_Y()
Gets a vector representing the Y unit of a Vector3.
Definition: vector3.cpp:134
TorusGenerator & SetToroidalRadius(const Real ToroidalRadius)
Sets the radius of the torus ring. AKA it's thickness. the radius is set to 0 or less, a PARAMETERS_EXCEPTION will be thrown.
void AddPoint(TriangleBuffer &Buffer, const Vector3 &Loc, const Vector3 &Norm, const Vector2 &UV) const
Adds a new point to a triangle buffer, using the format defined for that MeshGenerator.
Thrown when parameters are checked at runtime and found invalid.
Definition: exception.h:108
Real TorusToroidalRadius
The radius of the secondary ring of the torus.
TorusGenerator & SetNumPoloidalSeg(const Whole PoloidalSeg)
Sets the number of segments on the Poloidal ring. the number of segments is less than three...
Whole NumPoloidalSeg
The resolution of the Poloidal ring.
TriangleBuffer & AddIndex(const Integer Index)
Adds an index to the index buffer.
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
virtual void AddToTriangleBuffer(TriangleBuffer &Buffer) const
Adds the vertices and indices as configured in this generator to a triangle buffer.
A generator class for a torus mesh.
TorusGenerator & SetPoloidalRadius(const Real PoloidalRadius)
Sets the radius of the torus. the radius is set to 0 or less, a PARAMETERS_EXCEPTION will be thrown...
This is used to store information about rotation in 3d space.
Definition: quaternion.h:68
Whole NumToroidalSeg
The resolution of the Toroidal ring.