Spinning Topp Logo BlackTopp Studios
inc
planegenerator.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 _graphicsproceduralplanegenerator_cpp
68 #define _graphicsproceduralplanegenerator_cpp
69 
70 #include "Graphics/Procedural/Mesh/planegenerator.h"
71 
72 #include "exception.h"
73 
74 namespace Mezzanine
75 {
76  namespace Graphics
77  {
78  namespace Procedural
79  {
81  PlaneNormal( Vector3::Unit_Y() ),
82  PlaneSize(1,1),
83  NumSegX(1),
84  NumSegY(1)
85  { }
86 
87  PlaneGenerator::PlaneGenerator(const Vector3& Norm, const Vector2& Size) :
88  PlaneNormal(Norm),
89  PlaneSize(Size),
90  NumSegX(1),
91  NumSegY(1)
92  { }
93 
95  { }
96 
97  ///////////////////////////////////////////////////////////////////////////////
98  // Utility
99 
101  {
102  Buffer.RebaseOffset();
103  Buffer.EstimateVertexCount( ( this->NumSegX + 1 ) * ( this->NumSegY + 1 ) );
104  Buffer.EstimateIndexCount( this->NumSegX * this->NumSegY * 6 );
105  Integer Offset = 0;
106 
107  Vector3 vX = this->PlaneNormal.Perpendicular();
108  Vector3 vY = this->PlaneNormal.CrossProduct(vX);
109  Vector3 delta1 = vX * ( this->PlaneSize.X / (Real)this->NumSegX );
110  Vector3 delta2 = vY * ( this->PlaneSize.Y / (Real)this->NumSegY );
111  // build one corner of the square
112  Vector3 orig = ( vX * ( -0.5f * this->PlaneSize.X ) ) - ( vY * ( 0.5f * this->PlaneSize.Y ) );
113 
114  for( Whole i1 = 0 ; i1 <= this->NumSegX ; i1++ )
115  {
116  for( Whole i2 = 0 ; i2 <= this->NumSegY ; i2++ )
117  {
118  this->AddPoint(Buffer, orig + ( delta1 * Real(i1) ) + ( delta2 * Real(i2) ),
119  this->PlaneNormal,
120  Vector2( i1 / (Real)this->NumSegX, i2 / (Real)this->NumSegY ) );
121  }
122  }
123 
124  Boole Reverse = false;
125  if( delta1.CrossProduct(delta2).DotProduct(this->PlaneNormal) > 0 )
126  Reverse = true;
127 
128  for( Whole n1 = 0 ; n1 < this->NumSegX ; n1++ )
129  {
130  for( Whole n2 = 0 ; n2 < this->NumSegY ; n2++ )
131  {
132  if(Reverse) {
133  Buffer.AddIndex( Offset + 0 );
134  Buffer.AddIndex( Offset + ( this->NumSegY + 1 ) );
135  Buffer.AddIndex( Offset + 1 );
136  Buffer.AddIndex( Offset + 1 );
137  Buffer.AddIndex( Offset + ( this->NumSegY + 1 ) );
138  Buffer.AddIndex( Offset + ( this->NumSegY + 1 ) + 1 );
139  }else{
140  Buffer.AddIndex( Offset + 0 );
141  Buffer.AddIndex( Offset + 1 );
142  Buffer.AddIndex( Offset + ( this->NumSegY + 1 ) );
143  Buffer.AddIndex( Offset + 1 );
144  Buffer.AddIndex( Offset + ( this->NumSegY + 1 ) + 1 );
145  Buffer.AddIndex( Offset + ( this->NumSegY + 1 ) );
146  }
147  Offset++;
148  }
149  Offset++;
150  }
151  }
152 
153  ///////////////////////////////////////////////////////////////////////////////
154  // Configuration
155 
157  {
158  if( this->PlaneNormal.IsZeroLength() )
159  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Facing direction of a plane cannot be zero length.");
160 
161  this->PlaneNormal = Norm;
162  return *this;
163  }
164 
166  {
167  if( SizeX <= 0.0 )
168  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Size on an axis for a generated plane mesh must be greater than zero.");
169 
170  this->PlaneSize.X = SizeX;
171  return *this;
172  }
173 
175  {
176  if( SizeY <= 0.0 )
177  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Size on an axis for a generated plane mesh must be greater than zero.");
178 
179  this->PlaneSize.Y = SizeY;
180  return *this;
181  }
182 
184  {
185  this->SetSizeX(Size.X);
186  this->SetSizeY(Size.Y);
187  return *this;
188  }
189 
191  {
192  if( SegX == 0 )
193  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Number of segments for generated plane mesh must be greater than zero.");
194 
195  this->NumSegX = SegX;
196  return *this;
197  }
198 
200  {
201  if( SegY == 0 )
202  MEZZ_EXCEPTION(ExceptionBase::PARAMETERS_EXCEPTION,"Number of segments for generated plane mesh must be greater than zero.");
203 
204  this->NumSegY = SegY;
205  return *this;
206  }
207  }//Procedural
208  }//Graphics
209 }//Mezzanine
210 
211 #endif
PlaneGenerator & SetNumSegY(const Whole SegY)
Sets the number of segments along local Y axis.
Vector3 Perpendicular() const
Gets a vector that is perpendicular to this one.
Definition: vector3.cpp:414
Vector3 CrossProduct(const Vector3 &Vec) const
This is used to calculate the crossproduct of this and another vector.
Definition: vector3.cpp:338
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
Vector3 PlaneNormal
The facing direction of the plane.
A convenience buffer that stores vertices and indices of a mesh to be generated.
virtual void AddToTriangleBuffer(TriangleBuffer &Buffer) const
Adds the vertices and indices as configured in this generator to a triangle buffer.
#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 NumSegX
The number of segments to generate on the X axis.
This implements the exception hiearchy for Mezzanine.
Whole NumSegY
The number of segments to generate on the Y axis.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
Real Y
Coordinate on the Y vector.
Definition: vector2.h:69
A generator class for a plane mesh.
Real X
Coordinate on the X vector.
Definition: vector2.h:67
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
PlaneGenerator & SetNormal(const Vector3 &Norm)
Sets the normal of the plane. the normal is zero length a PARAMETERS_EXCEPTION will be thrown...
Vector2 PlaneSize
The size of the plane.
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 DotProduct(const Vector3 &Vec) const
This is used to calculate the dotproduct of this and another vector.
Definition: vector3.cpp:347
PlaneGenerator & SetSizeX(const Real SizeX)
Sets the size of this plane on the X axis. the size passed in is zero or less a PARAMETERS_EXCEPTION ...
PlaneGenerator & SetNumSegX(const Whole SegX)
Sets the number of segements along local X axis.
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
PlaneGenerator & SetSizeY(const Real SizeY)
Sets the size of this plane on the Y axis. the size passed in is zero or less a PARAMETERS_EXCEPTION ...
PlaneGenerator & SetSize(const Vector2 Size)
Sets the size of the plane. the size passed in on either axis is zero or less a PARAMETERS_EXCEPTION ...
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
Boole IsZeroLength() const
Checks to see if the length of this vector is zero.
Definition: vector3.cpp:469