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

Twists the pixel positions in a circle on the Texture. More...

#include <vortexmodifier.h>

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

Public Member Functions

 VortexModifier ()
 Blank constructor.
 
virtual ~VortexModifier ()
 Class destructor.
 
virtual String GetName () const
 Gets the name of this modifier. More...
 
virtual void Modify (TextureBuffer &Buffer)
 Alters the generated pixels in a TextureBuffer. More...
 
VortexModifierSetVortexCenter (const Vector2 &Center)
 Sets the center point where the texture will be twisted. More...
 
VortexModifierSetVortexCenter (const Real X, const Real Y)
 Sets the center point where the texture will be twisted. More...
 
VortexModifierSetVortexCenterX (const Real X)
 Sets the center point on the X axis where the texture will be twisted. More...
 
VortexModifierSetVortexCenterY (const Real Y)
 Sets the center point on the Y axis where the texture will be twisted. More...
 
VortexModifierSetVortexRadius (const Vector2 &Radius)
 Sets the radius of the twisting circle. More...
 
VortexModifierSetVortexRadius (const Real X, const Real Y)
 Sets the radius of the twisting circle. More...
 
VortexModifierSetVortexRadiusX (const Real X)
 Sets the radius on the X axis of the twisting circle. More...
 
VortexModifierSetVortexRadiusY (const Real Y)
 Sets the radius on the Y axis of the twisting circle. More...
 
VortexModifierSetVortexTwist (const Real Twist)
 Sets the angle by which to rotate pixels within the vortex. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
 TextureModifier ()
 Blank constructor.
 
virtual ~TextureModifier ()
 Class destructor.
 

Protected Attributes

Real TwistAngle
 The amount of twist to be applied in radians. More...
 
Vector2 VortexCenter
 The center of the twisting circle on the texture. More...
 
Vector2 VortexRadius
 The size of the twisting circle on the texture. More...
 

Detailed Description

Twists the pixel positions in a circle on the Texture.

Definition at line 84 of file vortexmodifier.h.

Member Function Documentation

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

Gets the name of this modifier.

Returns
Returns a string containing the name of this modifier.

Implements Mezzanine::Graphics::Procedural::TextureModifier.

Definition at line 159 of file vortexmodifier.cpp.

void Mezzanine::Graphics::Procedural::VortexModifier::Modify ( TextureBuffer Buffer)
virtual

Alters the generated pixels in a TextureBuffer.

Parameters
BufferThe buffer to be modified.

Implements Mezzanine::Graphics::Procedural::TextureModifier.

Definition at line 90 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexCenter ( const Vector2 Center)

Sets the center point where the texture will be twisted.

Parameters
CenterThe center of the twisting circle on the texture. Initial Value: (0.0,0.0).
Returns
Returns a reference to this.

Definition at line 165 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexCenter ( const Real  X,
const Real  Y 
)

Sets the center point where the texture will be twisted.

Parameters
XThe center of the twisting circle on the X axis. Initial Value: 0.0.
YThe center of the twisting circle on the Y axis. Initial Value: 0.0.
Returns
Returns a reference to this.

Definition at line 168 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexCenterX ( const Real  X)

Sets the center point on the X axis where the texture will be twisted.

Parameters
XThe center of the twisting circle on the X axis. Initial Value: 0.0.
Returns
Returns a reference to this.

Definition at line 171 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexCenterY ( const Real  Y)

Sets the center point on the Y axis where the texture will be twisted.

Parameters
YThe center of the twisting circle on the Y axis. Initial Value: 0.0.
Returns
Returns a reference to this.

Definition at line 174 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexRadius ( const Vector2 Radius)

Sets the radius of the twisting circle.

Parameters
RadiusThe size of the twisting circle on the texture. Initial Value: (0.0,0.0).
Returns
Returns a reference to this.

Definition at line 177 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexRadius ( const Real  X,
const Real  Y 
)

Sets the radius of the twisting circle.

Parameters
XThe radius of the twisting circle on the X axis. Initial Value: 0.0.
YThe radius of the twisting circle on the Y axis. Initial Value: 0.0.
Returns
Returns a reference to this.

Definition at line 180 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexRadiusX ( const Real  X)

Sets the radius on the X axis of the twisting circle.

Parameters
XThe radius of the twisting circle on the X axis. Initial Value: 0.0.
Returns
Returns a reference to this.

Definition at line 183 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexRadiusY ( const Real  Y)

Sets the radius on the Y axis of the twisting circle.

Parameters
YThe radius of the twisting circle on the Y axis. Initial Value: 0.0.
Returns
Returns a reference to this.

Definition at line 186 of file vortexmodifier.cpp.

VortexModifier & Mezzanine::Graphics::Procedural::VortexModifier::SetVortexTwist ( const Real  Twist)

Sets the angle by which to rotate pixels within the vortex.

Parameters
TwistThe amount of rotation in radians to be applied to pixels within the vortex. Initial Value: 0.0.
Returns
Returns a reference to this.

Definition at line 189 of file vortexmodifier.cpp.

Member Data Documentation

Real Mezzanine::Graphics::Procedural::VortexModifier::TwistAngle
protected

The amount of twist to be applied in radians.

Definition at line 95 of file vortexmodifier.h.

Vector2 Mezzanine::Graphics::Procedural::VortexModifier::VortexCenter
protected

The center of the twisting circle on the texture.

Definition at line 89 of file vortexmodifier.h.

Vector2 Mezzanine::Graphics::Procedural::VortexModifier::VortexRadius
protected

The size of the twisting circle on the texture.

Definition at line 92 of file vortexmodifier.h.


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