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

A modifier that will generate UV coordinates as they would need to be on a cylinder model. More...

#include <cylinderuvmodifier.h>

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

Public Member Functions

 CylinderUVModifier ()
 Blank constructor.
 
virtual ~CylinderUVModifier ()
 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...
 
CylinderUVModifierSetHeight (const Real Height)
 Sets the Height of the cylinder to generate UV's for. More...
 
CylinderUVModifierSetRadius (const Real Radius)
 Sets the Radius of the cylinder to generate UV's for. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::Procedural::MeshModifier
 MeshModifier ()
 Blank constructor.
 
virtual ~MeshModifier ()
 Class destructor.
 

Protected Attributes

Real CylinderHeight
 The total height of the cylinder to project the UV's onto. More...
 
Real CylinderRadius
 The radius of the cylinder to project the UV's onto. More...
 

Detailed Description

A modifier that will generate UV coordinates as they would need to be on a cylinder model.

Definition at line 82 of file cylinderuvmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::CylinderUVModifier::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 116 of file cylinderuvmodifier.cpp.

void Mezzanine::Graphics::Procedural::CylinderUVModifier::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 93 of file cylinderuvmodifier.cpp.

CylinderUVModifier & Mezzanine::Graphics::Procedural::CylinderUVModifier::SetHeight ( const Real  Height)

Sets the Height of the cylinder to generate UV's for.

Parameters
HeightThe total height of the cylinder to project the UV's onto.
Returns
Returns a reference to this.

Definition at line 122 of file cylinderuvmodifier.cpp.

CylinderUVModifier & Mezzanine::Graphics::Procedural::CylinderUVModifier::SetRadius ( const Real  Radius)

Sets the Radius of the cylinder to generate UV's for.

Parameters
RadiusThe radius of the cylinder to project the UV's onto.
Returns
Returns a reference to this.

Definition at line 128 of file cylinderuvmodifier.cpp.

Member Data Documentation

Real Mezzanine::Graphics::Procedural::CylinderUVModifier::CylinderHeight
protected

The total height of the cylinder to project the UV's onto.

Definition at line 87 of file cylinderuvmodifier.h.

Real Mezzanine::Graphics::Procedural::CylinderUVModifier::CylinderRadius
protected

The radius of the cylinder to project the UV's onto.

Definition at line 90 of file cylinderuvmodifier.h.


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