BlackTopp Studios inc
A generator class for a plane mesh. More...
#include <planegenerator.h>
Inheritance diagram for Mezzanine::Graphics::Procedural::PlaneGenerator: Collaboration diagram for Mezzanine::Graphics::Procedural::PlaneGenerator:Public Member Functions | |||
| PlaneGenerator () | |||
| Blank constructor. | |||
| PlaneGenerator (const Vector3 &Norm, const Vector2 &Size) | |||
| Descriptive constructor. More... | |||
| virtual | ~PlaneGenerator () | ||
| Class destructor. | |||
| virtual void | AddToTriangleBuffer (TriangleBuffer &Buffer) const | ||
| Adds the vertices and indices as configured in this generator to a triangle buffer. More... | |||
| PlaneGenerator & | SetNormal (const Vector3 &Norm) | ||
Sets the normal of the plane.
| |||
| PlaneGenerator & | SetNumSegX (const Whole SegX) | ||
| Sets the number of segements along local X axis. More... | |||
| PlaneGenerator & | SetNumSegY (const Whole SegY) | ||
| Sets the number of segments along local Y axis. More... | |||
| PlaneGenerator & | SetSize (const Vector2 Size) | ||
Sets the size of the plane.
| |||
| PlaneGenerator & | SetSizeX (const Real SizeX) | ||
Sets the size of this plane on the X axis.
| |||
| PlaneGenerator & | SetSizeY (const Real SizeY) | ||
Sets the size of this plane on the Y axis.
| |||
| Public Member Functions inherited from Mezzanine::Graphics::Procedural::MeshGenerator< PlaneGenerator > | |||
| MeshGenerator () | |||
| Class constructor. | |||
| virtual | ~MeshGenerator () | ||
| Class destructor. | |||
| TriangleBuffer | BuildTriangleBuffer () const | ||
| Creates a TriangleBuffer with the the vertices and indices as configured in this generator. More... | |||
| Mesh * | GenerateMesh (const String &MeshName, const String &MeshGroup, const String &MatName, const String &MatGroup) const | ||
| Generates the mesh. More... | |||
| PlaneGenerator & | ResetTransforms () | ||
| Resets all transforms (orientation, position and scale) that would have been applied to the mesh to their default values. More... | |||
| PlaneGenerator & | SetEnableNormals (Boole EnableNormals) | ||
| Sets whether normals are enabled or not. More... | |||
| PlaneGenerator & | SetNumTexCoordSet (const UInt8 NumSets) | ||
| Sets the number of texture coordintate sets. More... | |||
| PlaneGenerator & | SetOrientation (const Quaternion &Ori) | ||
| Sets an orientation baked into the resulting mesh. More... | |||
| PlaneGenerator & | SetOrientation (const Real X, const Real Y, const Real Z, const Real W) | ||
| Sets an orientation baked into the resulting mesh. More... | |||
| PlaneGenerator & | SetPosition (const Vector3 &Loc) | ||
| Sets a translation baked into the resulting mesh. More... | |||
| PlaneGenerator & | SetPosition (const Real X, const Real Y, const Real Z) | ||
| Sets a translation baked into the resulting mesh. More... | |||
| PlaneGenerator & | SetScale (const Vector3 &Scaling) | ||
| Sets a scale baked into the resulting mesh. More... | |||
| PlaneGenerator & | SetScale (const Real Scaling) | ||
| Sets a uniform scale baked into the resulting mesh. More... | |||
| PlaneGenerator & | SetScale (const Real X, const Real Y, const Real Z) | ||
| Sets a scale baked into the resulting mesh. More... | |||
| PlaneGenerator & | SetSwitchUV (Boole SwitchUV) | ||
| Sets whether to switch U and V texture coordinates. More... | |||
| PlaneGenerator & | SetTextureRectangle (const Real RectLeft, const Real RectRight, const Real RectTop, const Real RectBottom) | ||
| Sets the texture rectangle. More... | |||
| PlaneGenerator & | SetUTile (const Real uTile) | ||
| Sets the U Tile. More... | |||
| PlaneGenerator & | SetVTile (const Real vTile) | ||
| Sets the V Tile. More... | |||
Protected Attributes | |
| Whole | NumSegX |
| The number of segments to generate on the X axis. More... | |
| Whole | NumSegY |
| The number of segments to generate on the Y axis. More... | |
| Vector3 | PlaneNormal |
| The facing direction of the plane. More... | |
| Vector2 | PlaneSize |
| The size of the plane. More... | |
| Protected Attributes inherited from Mezzanine::Graphics::Procedural::MeshGenerator< PlaneGenerator > | |
| UInt8 | GeneratorOpts |
| Storage for the boolean options to be used by this generator. More... | |
| UInt8 | NumTexCoordSet |
| The number of texture coordinate sets to include. More... | |
| Quaternion | Orientation |
| Orientation to apply the mesh. More... | |
| Vector3 | Position |
| Position to apply to the mesh. More... | |
| Vector3 | Scale |
| Scale to apply to the mesh. More... | |
| Real | UTile |
| U tile for texture coords generation. More... | |
| Vector2 | UVOrigin |
| Rectangle in which the texture coordinates will be placed. More... | |
| Real | VTile |
| V tile for texture coords generation. More... | |
Additional Inherited Members | |
| Public Types inherited from Mezzanine::Graphics::Procedural::MeshGenerator< PlaneGenerator > | |
| enum | GeneratorOptions |
| A convenience enum used to describe boolean options for a generator. | |
| Protected Member Functions inherited from Mezzanine::Graphics::Procedural::MeshGenerator< PlaneGenerator > | |
| 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. More... | |
A generator class for a plane mesh.
Definition at line 82 of file planegenerator.h.
| Mezzanine::Graphics::Procedural::PlaneGenerator::PlaneGenerator | ( | const Vector3 & | Norm, |
| const Vector2 & | Size | ||
| ) |
Descriptive constructor.
| Norm | The facing direction of the plane. |
| Size | The size of the plane. |
Definition at line 87 of file planegenerator.cpp.
|
virtual |
Adds the vertices and indices as configured in this generator to a triangle buffer.
| Buffer | The buffer to append this generators vertices and indices to. |
Implements Mezzanine::Graphics::Procedural::MeshGenerator< PlaneGenerator >.
Definition at line 100 of file planegenerator.cpp.
| PlaneGenerator & Mezzanine::Graphics::Procedural::PlaneGenerator::SetNormal | ( | const Vector3 & | Norm | ) |
Sets the normal of the plane.
| If | the normal is zero length a PARAMETERS_EXCEPTION will be thrown. |
| Norm | The facing direction to apply to the plane. |
Definition at line 156 of file planegenerator.cpp.
| PlaneGenerator & Mezzanine::Graphics::Procedural::PlaneGenerator::SetNumSegX | ( | const Whole | SegX | ) |
Sets the number of segements along local X axis.
| If | the number of segments is set to 0, a PARAMETERS_EXCEPTION will be thrown. |
| SegX | The number of segments to set along the X axis. |
Definition at line 190 of file planegenerator.cpp.
| PlaneGenerator & Mezzanine::Graphics::Procedural::PlaneGenerator::SetNumSegY | ( | const Whole | SegY | ) |
Sets the number of segments along local Y axis.
| If | the number of segments is set to 0, a PARAMETERS_EXCEPTION will be thrown. |
| SegY | The number of segments to set along the Y axis. |
Definition at line 199 of file planegenerator.cpp.
| PlaneGenerator & Mezzanine::Graphics::Procedural::PlaneGenerator::SetSize | ( | const Vector2 | Size | ) |
Sets the size of the plane.
| If | the size passed in on either axis is zero or less a PARAMETERS_EXCEPTION will be thrown. |
| Size | The size to set for the generated plane. |
Definition at line 183 of file planegenerator.cpp.
| PlaneGenerator & Mezzanine::Graphics::Procedural::PlaneGenerator::SetSizeX | ( | const Real | SizeX | ) |
Sets the size of this plane on the X axis.
| If | the size passed in is zero or less a PARAMETERS_EXCEPTION will be thrown. |
| SizeX | The size to set for the generated plane on the X axis. |
Definition at line 165 of file planegenerator.cpp.
| PlaneGenerator & Mezzanine::Graphics::Procedural::PlaneGenerator::SetSizeY | ( | const Real | SizeY | ) |
Sets the size of this plane on the Y axis.
| If | the size passed in is zero or less a PARAMETERS_EXCEPTION will be thrown. |
| SizeX | The size to set for the generated plane on the Y axis. |
Definition at line 174 of file planegenerator.cpp.
|
protected |
The number of segments to generate on the X axis.
Definition at line 93 of file planegenerator.h.
|
protected |
The number of segments to generate on the Y axis.
Definition at line 96 of file planegenerator.h.
|
protected |
The facing direction of the plane.
Definition at line 87 of file planegenerator.h.
|
protected |
The size of the plane.
Definition at line 90 of file planegenerator.h.
1.8.9.1. Thanks to the
Open Icon Library
for help with some of the icons.
