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

A modifier that will update the transform of every vertex in a mesh. More...

#include <vertextransformmodifier.h>

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

Public Member Functions

 VertexTransformModifier ()
 Blank constructor.
 
virtual ~VertexTransformModifier ()
 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...
 
VertexTransformModifierSetRotation (const Quaternion &Rot)
 Sets how to rotate the mesh. More...
 
VertexTransformModifierSetRotation (const Real X, const Real Y, const Real Z, const Real W)
 Sets how to rotate the mesh. More...
 
VertexTransformModifierSetScaling (const Vector3 &Scale)
 Sets the scaling to apply. More...
 
VertexTransformModifierSetScaling (const Real X, const Real Y, const Real Z)
 Sets the scaling to apply. More...
 
VertexTransformModifierSetTranslation (const Vector3 &Trans)
 Sets the linear movement to apply. More...
 
VertexTransformModifierSetTranslation (const Real X, const Real Y, const Real Z)
 Sets the linear movement to apply. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::Procedural::MeshModifier
 MeshModifier ()
 Blank constructor.
 
virtual ~MeshModifier ()
 Class destructor.
 

Protected Attributes

Quaternion Rotation
 The amount of rotation to apply to each vertex. More...
 
Vector3 Scaling
 The amount to scale each vertex by. More...
 
Vector3 Translation
 The amount of linear movement to apply to each vertex. More...
 

Detailed Description

A modifier that will update the transform of every vertex in a mesh.

Definition at line 82 of file vertextransformmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::VertexTransformModifier::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 99 of file vertextransformmodifier.cpp.

void Mezzanine::Graphics::Procedural::VertexTransformModifier::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 vertextransformmodifier.cpp.

VertexTransformModifier & Mezzanine::Graphics::Procedural::VertexTransformModifier::SetRotation ( const Quaternion Rot)

Sets how to rotate the mesh.

Parameters
RotThe amount of rotation to apply.
Returns
Returns a reference to this.

Definition at line 105 of file vertextransformmodifier.cpp.

VertexTransformModifier & Mezzanine::Graphics::Procedural::VertexTransformModifier::SetRotation ( const Real  X,
const Real  Y,
const Real  Z,
const Real  W 
)

Sets how to rotate the mesh.

Parameters
XThe X component of the rotation(Quaternion) to apply.
YThe Y component of the rotation(Quaternion) to apply.
ZThe Z component of the rotation(Quaternion) to apply.
WThe W component of the rotation(Quaternion) to apply.
Returns
Returns a reference to this.

Definition at line 111 of file vertextransformmodifier.cpp.

VertexTransformModifier & Mezzanine::Graphics::Procedural::VertexTransformModifier::SetScaling ( const Vector3 Scale)

Sets the scaling to apply.

Parameters
ScaleThe amount to scale each vertex by.
Returns
Returns a reference to this.

Definition at line 129 of file vertextransformmodifier.cpp.

VertexTransformModifier & Mezzanine::Graphics::Procedural::VertexTransformModifier::SetScaling ( const Real  X,
const Real  Y,
const Real  Z 
)

Sets the scaling to apply.

Parameters
XThe amount of scale to apply to each vertex on the X axis.
YThe amount of scale to apply to each vertex on the Y axis.
ZThe amount of scale to apply to each vertex on the Z axis.
Returns
Returns a reference to this.

Definition at line 135 of file vertextransformmodifier.cpp.

VertexTransformModifier & Mezzanine::Graphics::Procedural::VertexTransformModifier::SetTranslation ( const Vector3 Trans)

Sets the linear movement to apply.

Parameters
TransThe amount of linear movement to apply to each vertex.
Returns
Returns a reference to this.

Definition at line 117 of file vertextransformmodifier.cpp.

VertexTransformModifier & Mezzanine::Graphics::Procedural::VertexTransformModifier::SetTranslation ( const Real  X,
const Real  Y,
const Real  Z 
)

Sets the linear movement to apply.

Parameters
XThe amount of linear movement to apply to each vertex on the X axis.
YThe amount of linear movement to apply to each vertex on the Y axis.
ZThe amount of linear movement to apply to each vertex on the Z axis.
Returns
Returns a reference to this.

Definition at line 123 of file vertextransformmodifier.cpp.

Member Data Documentation

Quaternion Mezzanine::Graphics::Procedural::VertexTransformModifier::Rotation
protected

The amount of rotation to apply to each vertex.

Definition at line 87 of file vertextransformmodifier.h.

Vector3 Mezzanine::Graphics::Procedural::VertexTransformModifier::Scaling
protected

The amount to scale each vertex by.

Definition at line 93 of file vertextransformmodifier.h.

Vector3 Mezzanine::Graphics::Procedural::VertexTransformModifier::Translation
protected

The amount of linear movement to apply to each vertex.

Definition at line 90 of file vertextransformmodifier.h.


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