Spinning Topp Logo BlackTopp Studios
inc
vertex.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 #ifndef _uivertex_h
41 #define _uivertex_h
42 
43 #include "vector3.h"
44 #include "vector2.h"
45 #include "colourvalue.h"
46 
47 namespace Mezzanine
48 {
49  namespace UI
50  {
51  /// @brief Basic class describing a vertex in the UI to be rendered.
52  /// @details This is a very low level class used internally by most UI classes. The values here should never need to be tempered with.
54  {
55  /// @brief The 3D position of this vertex for placement in front of the frustrum.
57  /// @brief The colour of the vertex.
59  /// @brief The UV position (or texture coordinates) of this vertex if a texture is being applied to it.
61  };//Vertex
62 
63  /// @brief Basic class describing a vertex in the UI to be rendered.
64  /// @details This class is necessary to exist since vertex declarations can't contain Atlas names.
66  {
67  /// @brief The actual vertex data relevant to rendering.
69  /// @brief Name of the Atlas the texture belongs to if a texture is being applied to it.
71 
72  /// @brief Assignment operator.
73  void operator=(const VertexData& Other)
74  {
75  this->Vert.Position = Other.Vert.Position;
76  this->Vert.Colour = Other.Vert.Colour;
77  this->Vert.UV = Other.Vert.UV;
78  this->Atlas = Other.Atlas;
79  }
80  };//Vertex
81  }//UI
82 }//Mezzanine
83 
84 #endif
Basic class describing a vertex in the UI to be rendered.
Definition: vertex.h:53
Vector2 UV
The UV position (or texture coordinates) of this vertex if a texture is being applied to it...
Definition: vertex.h:60
ColourValue Colour
The colour of the vertex.
Definition: vertex.h:58
Vertex Vert
The actual vertex data relevant to rendering.
Definition: vertex.h:68
This is a simple class for holding 4 reals representing the colour any give object or lightsource can...
Definition: colourvalue.h:64
Vector3 Position
The 3D position of this vertex for placement in front of the frustrum.
Definition: vertex.h:56
String Atlas
Name of the Atlas the texture belongs to if a texture is being applied to it.
Definition: vertex.h:70
This is used to represent a point on a 2 dimentional area, such as a screen.
Definition: vector2.h:63
Basic class describing a vertex in the UI to be rendered.
Definition: vertex.h:65
This is used to represent a point in space, or a vector through space.
Definition: vector3.h:77
#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
void operator=(const VertexData &Other)
Assignment operator.
Definition: vertex.h:73
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159