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

A modifier that will draw an illuminated circle that fades over a distance to a previous texture. More...

#include <flaremodifier.h>

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

Public Member Functions

 FlareModifier ()
 Blank constructor.
 
virtual ~FlareModifier ()
 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...
 
FlareModifierSetColour (const ColourValue &Colour)
 Sets the colour of the flare to be rendered. More...
 
FlareModifierSetColour (const Real Red, const Real Green, const Real Blue, const Real Alpha=1.0)
 Sets the colour of the flare to be rendered. More...
 
FlareModifierSetFlareBrightness (const Real Brightness)
 Sets the brightness of the flare. More...
 
FlareModifierSetFlareCenter (const Vector2 &Center)
 Sets the center position of the flare. More...
 
FlareModifierSetFlareCenter (const Real X, const Real Y)
 Sets the center position of the flare. More...
 
FlareModifierSetFlareCenterX (const Real X)
 Sets the center position of the flare on the X axis. More...
 
FlareModifierSetFlareCenterY (const Real Y)
 Sets the center position of the flare on the Y axis. More...
 
FlareModifierSetFlareRadius (const Vector2 &Radius)
 Sets the radius size of the flare. More...
 
FlareModifierSetFlareRadius (const Real X, const Real Y)
 Sets the radius size of the flare. More...
 
FlareModifierSetFlareRadiusX (const Real X)
 Sets the radius size of the flare on the X axis. More...
 
FlareModifierSetFlareRadiusY (const Real Y)
 Sets the radius size of the flare on the Y axis. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
 TextureModifier ()
 Blank constructor.
 
virtual ~TextureModifier ()
 Class destructor.
 

Protected Attributes

Real FlareBrightness
 A modifier for the intensity of the flare colour. More...
 
Vector2 FlareCenter
 The central position of the flare on the texture in relative coordinates. More...
 
ColourValue FlareColour
 The colour of the flare to draw. More...
 
Vector2 FlareRadius
 The radius of the flare to draw in relative coordinates. More...
 

Detailed Description

A modifier that will draw an illuminated circle that fades over a distance to a previous texture.

Definition at line 84 of file flaremodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::FlareModifier::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 131 of file flaremodifier.cpp.

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

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetColour ( const ColourValue Colour)

Sets the colour of the flare to be rendered.

Parameters
ColourThe colour of the flare to draw. Initial Value: (1.0,1.0,1.0,1.0).
Returns
Returns a reference to this.

Definition at line 137 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetColour ( const Real  Red,
const Real  Green,
const Real  Blue,
const Real  Alpha = 1.0 
)

Sets the colour of the flare to be rendered.

Parameters
RedThe amount of red colour in the flare to draw. Initial Value: 1.0.
GreenThe amount of green colour in the flare to draw. Initial Value: 1.0.
BlueThe amount of blue colour in the flare to draw. Initial Value: 1.0.
AlphaThe amount of alpha colour in the flare to draw. Initial Value: 1.0.
Returns
Returns a reference to this.

Definition at line 143 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareBrightness ( const Real  Brightness)

Sets the brightness of the flare.

Parameters
BrightnessA modifier for the intensity of the flare colour. Initial Value: 1.0.
Returns
Returns a reference to this.

Definition at line 199 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareCenter ( const Vector2 Center)

Sets the center position of the flare.

Parameters
CenterThe central position of the flare on the texture in relative coordinates. Initial Value: (0.5,0.5).
Returns
Returns a reference to this.

Definition at line 149 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareCenter ( const Real  X,
const Real  Y 
)

Sets the center position of the flare.

Parameters
XThe center position of the flare on the X axis in relative coordinates. Initial Value: 0.5.
YThe center position of the flare on the Y axis in relative coordinates. Initial Value: 0.5.
Returns
Returns a reference to this.

Definition at line 155 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareCenterX ( const Real  X)

Sets the center position of the flare on the X axis.

Parameters
XThe center position of the flare on the X axis in relative coordinates. Initial Value: 0.5.
Returns
Returns a reference to this.

Definition at line 162 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareCenterY ( const Real  Y)

Sets the center position of the flare on the Y axis.

Parameters
YThe center position of the flare on the Y axis in relative coordinates. Initial Value: 0.5.
Returns
Returns a reference to this.

Definition at line 168 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareRadius ( const Vector2 Radius)

Sets the radius size of the flare.

Parameters
RadiusThe radius of the flare to draw in relative coordinates. Initial Value: (0.5,0.5).
Returns
Returns a reference to this.

Definition at line 174 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareRadius ( const Real  X,
const Real  Y 
)

Sets the radius size of the flare.

Parameters
XThe radius of the flare on the X axis in relative coordinates. Initial Value: 0.5.
YThe radius of the flare on the Y axis in relative coordinates. Initial Value: 0.5.
Returns
Returns a reference to this.

Definition at line 180 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareRadiusX ( const Real  X)

Sets the radius size of the flare on the X axis.

Parameters
XThe radius of the flare on the X axis in relative coordinates. Initial Value: 0.5.
Returns
Returns a reference to this.

Definition at line 187 of file flaremodifier.cpp.

FlareModifier & Mezzanine::Graphics::Procedural::FlareModifier::SetFlareRadiusY ( const Real  Y)

Sets the radius size of the flare on the Y axis.

Parameters
YThe radius of the flare on the Y axis in relative coordinates. Initial Value: 0.5.
Returns
Returns a reference to this.

Definition at line 193 of file flaremodifier.cpp.

Member Data Documentation

Real Mezzanine::Graphics::Procedural::FlareModifier::FlareBrightness
protected

A modifier for the intensity of the flare colour.

Definition at line 98 of file flaremodifier.h.

Vector2 Mezzanine::Graphics::Procedural::FlareModifier::FlareCenter
protected

The central position of the flare on the texture in relative coordinates.

Definition at line 92 of file flaremodifier.h.

ColourValue Mezzanine::Graphics::Procedural::FlareModifier::FlareColour
protected

The colour of the flare to draw.

Definition at line 89 of file flaremodifier.h.

Vector2 Mezzanine::Graphics::Procedural::FlareModifier::FlareRadius
protected

The radius of the flare to draw in relative coordinates.

Definition at line 95 of file flaremodifier.h.


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