Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Protected Attributes | List of all members
Mezzanine::Graphics::Procedural::VertexUVModifier Class Reference

A modifier that will transform the UV coordinates of a mesh. More...

#include <vertexuvmodifier.h>

+ Inheritance diagram for Mezzanine::Graphics::Procedural::VertexUVModifier:
+ Collaboration diagram for Mezzanine::Graphics::Procedural::VertexUVModifier:

Public Member Functions

 VertexUVModifier ()
 Blank constructor.
 
virtual ~VertexUVModifier ()
 Class destructor.
 
virtual String GetName () const
 Gets the name of this modifier. More...
 
virtual void Modify (TriangleBuffer &Buffer)
 Alters the generated pixels in a TriangleBuffer. More...
 
VertexUVModifierSetSwitchUV (const Boole Switch)
 Sets if UV's will swap components. More...
 
VertexUVModifierSetUVTile (const Vector2 &Tile)
 Sets the scaling to apply to each vertex UV. More...
 
VertexUVModifierSetUVTile (const Real X, const Real Y)
 Sets the scaling to apply to each vertex UV. More...
 
VertexUVModifierSetUVTranslate (const Vector2 &Trans)
 Sets the translation to apply to each vertex UV. More...
 
VertexUVModifierSetUVTranslate (const Real X, const Real Y)
 Sets the translation to apply to each vertex UV. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::Procedural::MeshModifier
 MeshModifier ()
 Blank constructor.
 
virtual ~MeshModifier ()
 Class destructor.
 

Protected Attributes

Boole SwitchUV
 Whether or not the X and Y components of every UV should be swapped after the operation. More...
 
Vector2 UVTile
 The amount of scaling to apply to the UV coordinates. More...
 
Vector2 UVTranslate
 The amount of actual translation to apply to the UV coordinates. More...
 

Detailed Description

A modifier that will transform the UV coordinates of a mesh.

Definition at line 82 of file vertexuvmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::VertexUVModifier::GetName ( ) const
virtual

Gets the name of this modifier.

Returns
Returns a string containing the name of this modifier.

Implements Mezzanine::Graphics::Procedural::MeshModifier.

Definition at line 105 of file vertexuvmodifier.cpp.

void Mezzanine::Graphics::Procedural::VertexUVModifier::Modify ( TriangleBuffer Buffer)
virtual

Alters the generated pixels in a TriangleBuffer.

Parameters
BufferThe buffer to be modified.

Implements Mezzanine::Graphics::Procedural::MeshModifier.

Definition at line 90 of file vertexuvmodifier.cpp.

VertexUVModifier & Mezzanine::Graphics::Procedural::VertexUVModifier::SetSwitchUV ( const Boole  Switch)

Sets if UV's will swap components.

Parameters
SwitchWhether or not the X and Y components of every UV should be swapped after the operation.
Returns
Returns a reference to this.

Definition at line 135 of file vertexuvmodifier.cpp.

VertexUVModifier & Mezzanine::Graphics::Procedural::VertexUVModifier::SetUVTile ( const Vector2 Tile)

Sets the scaling to apply to each vertex UV.

Parameters
TileThe amount of scaling to apply to the UV coordinates.
Returns
Returns a reference to this.

Definition at line 111 of file vertexuvmodifier.cpp.

VertexUVModifier & Mezzanine::Graphics::Procedural::VertexUVModifier::SetUVTile ( const Real  X,
const Real  Y 
)

Sets the scaling to apply to each vertex UV.

Parameters
XThe amount of scaling to apply on the X axis to the UV coordinates.
YThe amount of scaling to apply on the Y axis to the UV coordinates.
Returns
Returns a reference to this.

Definition at line 117 of file vertexuvmodifier.cpp.

VertexUVModifier & Mezzanine::Graphics::Procedural::VertexUVModifier::SetUVTranslate ( const Vector2 Trans)

Sets the translation to apply to each vertex UV.

Parameters
TransThe amount of actual translation to apply to the UV coordinates.
Returns
Returns a reference to this.

Definition at line 123 of file vertexuvmodifier.cpp.

VertexUVModifier & Mezzanine::Graphics::Procedural::VertexUVModifier::SetUVTranslate ( const Real  X,
const Real  Y 
)

Sets the translation to apply to each vertex UV.

Parameters
XThe amount of translation on the X axis to apply to the UV coordinates.
YThe amount of translation on the Y axis to apply to the UV coordinates.
Returns
Returns a reference to this.

Definition at line 129 of file vertexuvmodifier.cpp.

Member Data Documentation

Boole Mezzanine::Graphics::Procedural::VertexUVModifier::SwitchUV
protected

Whether or not the X and Y components of every UV should be swapped after the operation.

Definition at line 93 of file vertexuvmodifier.h.

Vector2 Mezzanine::Graphics::Procedural::VertexUVModifier::UVTile
protected

The amount of scaling to apply to the UV coordinates.

Definition at line 87 of file vertexuvmodifier.h.

Vector2 Mezzanine::Graphics::Procedural::VertexUVModifier::UVTranslate
protected

The amount of actual translation to apply to the UV coordinates.

Definition at line 90 of file vertexuvmodifier.h.


The documentation for this class was generated from the following files: