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

A modifier that will apply a rotation to the image and optionally zoom in on it. More...

#include <rotationzoommodifier.h>

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

Public Member Functions

 RotationZoomModifier ()
 Blank constructor.
 
virtual ~RotationZoomModifier ()
 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...
 
RotationZoomModifierSetRotation (const Real Rot)
 Sets the rotation to be applied. More...
 
RotationZoomModifierSetRotationCenter (const Vector2 &Center)
 Sets the relative position on the texture the rotation is to occur around. More...
 
RotationZoomModifierSetRotationCenterX (const Real X)
 Sets the relative X position on the texture the rotation is to occur around. More...
 
RotationZoomModifierSetRotationCenterY (const Real Y)
 Sets the relative Y position on the texture the rotation is to occur around. More...
 
RotationZoomModifierSetZoomFactor (const Vector2 &Zoom)
 Sets the zoom to be applied to the texture after rotation. More...
 
RotationZoomModifierSetZoomFactorX (const Real X)
 Sets the zoom to be applied to the texture on the X axis after rotation. More...
 
RotationZoomModifierSetZoomFactorY (const Real Y)
 Sets the zoom to be applied to the texture on the Y axis after rotation. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
 TextureModifier ()
 Blank constructor.
 
virtual ~TextureModifier ()
 Class destructor.
 

Protected Attributes

Real Rotation
 The amount of rotation to apply in radians. More...
 
Vector2 RotationCenter
 The center position for the rotation to be applied. More...
 
Vector2 ZoomFactor
 The amount of zoom to apply on both axes. More...
 

Detailed Description

A modifier that will apply a rotation to the image and optionally zoom in on it.

Edges that are clipped as a result of rotation will be rendered to the otherwise blank corners that are also formed from the rotation.

Definition at line 84 of file rotationzoommodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::RotationZoomModifier::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 141 of file rotationzoommodifier.cpp.

void Mezzanine::Graphics::Procedural::RotationZoomModifier::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 92 of file rotationzoommodifier.cpp.

RotationZoomModifier & Mezzanine::Graphics::Procedural::RotationZoomModifier::SetRotation ( const Real  Rot)

Sets the rotation to be applied.

Parameters
RotThe amount of rotation to apply in radians. Initial Value: 0.0.
Returns
Returns a reference to this.

Definition at line 165 of file rotationzoommodifier.cpp.

RotationZoomModifier & Mezzanine::Graphics::Procedural::RotationZoomModifier::SetRotationCenter ( const Vector2 Center)

Sets the relative position on the texture the rotation is to occur around.

Parameters
CenterThe center position for the rotation to be applied in relative coordinates[0.0-1.0]. Initial Value: 0.5,0.5.
Returns
Returns a reference to this.

Definition at line 147 of file rotationzoommodifier.cpp.

RotationZoomModifier & Mezzanine::Graphics::Procedural::RotationZoomModifier::SetRotationCenterX ( const Real  X)

Sets the relative X position on the texture the rotation is to occur around.

Parameters
XThe center position for the rotation to be applied on the X axis in relative coordinates[0.0-1.0]. Initial Value: 0.5.
Returns
Returns a reference to this.

Definition at line 150 of file rotationzoommodifier.cpp.

RotationZoomModifier & Mezzanine::Graphics::Procedural::RotationZoomModifier::SetRotationCenterY ( const Real  Y)

Sets the relative Y position on the texture the rotation is to occur around.

Parameters
YThe center position for the rotation to be applied on the Y axis in relative coordinates[0.0-1.0]. Initial Value: 0.5.
Returns
Returns a reference to this.

Definition at line 153 of file rotationzoommodifier.cpp.

RotationZoomModifier & Mezzanine::Graphics::Procedural::RotationZoomModifier::SetZoomFactor ( const Vector2 Zoom)

Sets the zoom to be applied to the texture after rotation.

Parameters
ZoomThe amount of zoom to apply on both axes. Initial Value: 1.0,1.0.
Returns
Returns a reference to this.

Definition at line 156 of file rotationzoommodifier.cpp.

RotationZoomModifier & Mezzanine::Graphics::Procedural::RotationZoomModifier::SetZoomFactorX ( const Real  X)

Sets the zoom to be applied to the texture on the X axis after rotation.

Parameters
XThe amount of zoom to apply on the X axis. Initial Value: 1.0.
Returns
Returns a reference to this.

Definition at line 159 of file rotationzoommodifier.cpp.

RotationZoomModifier & Mezzanine::Graphics::Procedural::RotationZoomModifier::SetZoomFactorY ( const Real  Y)

Sets the zoom to be applied to the texture on the Y axis after rotation.

Parameters
YThe amount of zoom to apply on the Y axis. Initial Value: 1.0.
Returns
Returns a reference to this.

Definition at line 162 of file rotationzoommodifier.cpp.

Member Data Documentation

Real Mezzanine::Graphics::Procedural::RotationZoomModifier::Rotation
protected

The amount of rotation to apply in radians.

Definition at line 95 of file rotationzoommodifier.h.

Vector2 Mezzanine::Graphics::Procedural::RotationZoomModifier::RotationCenter
protected

The center position for the rotation to be applied.

Definition at line 89 of file rotationzoommodifier.h.

Vector2 Mezzanine::Graphics::Procedural::RotationZoomModifier::ZoomFactor
protected

The amount of zoom to apply on both axes.

Definition at line 92 of file rotationzoommodifier.h.


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