Spinning Topp Logo BlackTopp Studios
inc
spheregenerator.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 _graphicsproceduralspheregenerator_cpp
68 #define _graphicsproceduralspheregenerator_cpp
69 
70 #include "Graphics/Procedural/Mesh/spheregenerator.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  SphereGenerator::SphereGenerator(const Real Radius, const Whole Rings, const Whole SegCircle) :
82  SphereRadius(Radius),
83  NumRings(Rings),
84  NumSegCircle(SegCircle)
85  { }
86 
88  { }
89 
90  ///////////////////////////////////////////////////////////////////////////////
91  // Utility
92 
94  {
95  Buffer.RebaseOffset();
96  Buffer.EstimateVertexCount( ( this->NumRings + 1 ) * ( this->NumSegCircle + 1 ) );
97  Buffer.EstimateIndexCount( this->NumRings * ( this->NumSegCircle + 1 ) * 6 );
98 
99  Real fDeltaRingAngle = ( MathTools::GetPi() / this->NumRings );
100  Real fDeltaSegAngle = ( MathTools::GetTwoPi() / this->NumSegCircle );
101  Integer Offset = 0;
102 
103  // Generate the group of rings for the sphere
104  for( Whole Ring = 0 ; Ring <= this->NumRings ; ++Ring )
105  {
106  Real r0 = this->SphereRadius * sinf( Ring * fDeltaRingAngle );
107  Real y0 = this->SphereRadius * cosf( Ring * fDeltaRingAngle );
108 
109  // Generate the group of segments for the current ring
110  for( Whole Segment = 0 ; Segment <= this->NumSegCircle ; ++Segment )
111  {
112  Real x0 = r0 * sinf( Segment * fDeltaSegAngle );
113  Real z0 = r0 * cosf( Segment * fDeltaSegAngle );
114 
115  // Add one vertex to the strip which makes up the sphere
116  this->AddPoint(Buffer, Vector3(x0, y0, z0),
117  Vector3(x0, y0, z0).GetNormal(),
118  Vector2( (Real)Segment / (Real)this->NumSegCircle, (Real)Ring / (Real)this->NumRings ) );
119 
120  if( Ring != this->NumRings ) {
121  if( Segment != this->NumSegCircle ) {
122  // each vertex (except the last) has six indices pointing to it
123  if( Ring != this->NumRings - 1 ) {
124  Buffer.AddTriangle(Offset + this->NumSegCircle + 2, Offset, Offset + this->NumSegCircle + 1);
125  }
126  if( Ring != 0 ) {
127  Buffer.AddTriangle(Offset + this->NumSegCircle + 2, Offset + 1, Offset);
128  }
129  }
130  Offset++;
131  }
132  }// for each segment
133  }// for each ring
134  }
135 
136  ///////////////////////////////////////////////////////////////////////////////
137  // Configuration
138 
140  {
141  if( Radius <= 0.0 )
142  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Radius for a generated sphere mesh must be greater than zero.");
143 
144  this->SphereRadius = Radius;
145  return *this;
146  }
147 
149  {
150  if( Rings == 0 )
151  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Number of rings for generated sphere mesh must be greater than zero.");
152 
153  this->NumRings = Rings;
154  return *this;
155  }
156 
158  {
159  if( SegCircle < 3 )
160  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Number of segments for circular component of generated cylinder mesh must be greater than two.");
161 
162  this->NumSegCircle = SegCircle;
163  return *this;
164  }
165  }//Procedural
166  }//Graphics
167 }//Mezzanine
168 
169 #endif
Real SphereRadius
The radius of the sphere.
A convenience buffer that stores vertices and indices of a mesh to be generated.
A generator class for a sphere mesh.
#define MEZZ_EXCEPTION(num, desc)
An easy way to throw exceptions with rich information.
Definition: exception.h:3048
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
Whole NumSegCircle
The number of segments along the circumference of the rings.
This implements the exception hiearchy for Mezzanine.
SphereGenerator & SetRadius(const Real Radius)
Sets the radius of the sphere. the radius is set to 0 or less, a PARAMETERS_EXCEPTION will be thrown...
Whole NumRings
The number of rings controlling the resolution along the vertical axis.
SphereGenerator & SetNumSegCircle(const Whole SegCircle)
Sets the number of segments along the circumference of the rings. the number of segments is set to 0...
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
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
virtual void AddToTriangleBuffer(TriangleBuffer &Buffer) const
Adds the vertices and indices as configured in this generator to a triangle buffer.
TriangleBuffer & AddTriangle(const Integer Index1, const Integer Index2, const Integer Index3)
Adds a triangle to the index buffer.
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
SphereGenerator & SetNumRings(const Whole Rings)
Sets the number of rings, the number of rings is set to 0, a PARAMETERS_EXCEPTION will be thrown...
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
SphereGenerator(const Real Radius, const Whole Rings=16, const Whole SegCircle=16)
Class constuctor.