A modifier that draws a simple coloured ellipse onto the texture. More...

#include <ellipsemodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::EllipseModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::EllipseModifier:

Public Member Functions
	EllipseModifier ()
	Blank constructor.

virtual	~EllipseModifier ()
	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...

EllipseModifier &	SetColour (const ColourValue &Colour)
	Sets the colour of the ellipse to be generated. More...

EllipseModifier &	SetColour (const Real Red, const Real Green, const Real Blue, const Real Alpha=1.0)
	Sets the colour of the ellipse to be generated. More...

EllipseModifier &	SetColour (const UInt8 Red, const UInt8 Green, const UInt8 Blue, const UInt8 Alpha)
	Sets the colour of the ellipse to be generated. More...

EllipseModifier &	SetEllipse (const Real XPosition, const Real YPosition, const Real XRadius, const Real YRadius)
	Sets the relative position and radius of this ellipse.. More...

EllipseModifier &	SetEllipse (const Integer XPosition, const Integer YPosition, const Integer XRadius, const Integer YRadius)
	Sets the offsets for the position and radius of this ellipse. More...

EllipseModifier &	SetEllipse (const Real XPositionRel, const Real YPositionRel, const Real XRadiusRel, const Real YRadiusRel, const Integer XPositionAdj, const Integer YPositionAdj, const Integer XRadiusAdj, const Integer YRadiusAdj)
	Sets the relative and offset values for the ellipse. More...

EllipseModifier &	SetPosition (const Real XPositionRel, const Real YPositionRel, const Integer XPositionAdj, const Integer YPositionAdj)
	Sets the relative and offset values for the ellipse position. More...

EllipseModifier &	SetRadius (const Real XRadiusRel, const Real YRadiusRel, const Integer XRadiusAdj, const Integer YRadiusAdj)
	Sets the relative and offset values for the ellipse radius. More...

EllipseModifier &	SetXPositionAdj (const Integer X)
	Sets the absolute component of the left edge. More...

EllipseModifier &	SetXPositionRel (const Real X)
	Sets the relative component of the left edge. More...

EllipseModifier &	SetXRadiusAdj (const Integer X)
	Sets the absolute component for the horizontal radius. More...

EllipseModifier &	SetXRadiusRel (const Real X)
	Sets the relative component of the horizontal radius. More...

EllipseModifier &	SetYPositionAdj (const Integer Y)
	Sets the absolute component of the top edge. More...

EllipseModifier &	SetYPositionRel (const Real Y)
	Sets the relative component of the top edge. More...

EllipseModifier &	SetYRadiusAdj (const Integer Y)
	Sets the absolute component for the vertical radius. More...

EllipseModifier &	SetYRadiusRel (const Real Y)
	Sets the relative component of the vertical radius. More...

Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
	TextureModifier ()
	Blank constructor.

virtual	~TextureModifier ()
	Class destructor.

Protected Member Functions
void	PutPixel (const Integer XPos, const Integer YPos, TextureBuffer &Buffer)
	Convenience method for placing a pixel for the ellipse. More...

Protected Attributes
ColourValue	FillColour
	The colour of the ellipse to apply to the texture. More...

Integer	PositionXAdj
	The left edge adjustment of the ellipse after relative coordinates are calculated. More...

Real	PositionXRel
	The left edge of the ellipse in relative coordinates. More...

Integer	PositionYAdj
	The top edge adjustment of the ellipse after relative coordinates are calculated. More...

Real	PositionYRel
	The top edge of the ellipse in relative coordinates. More...

Integer	RadiusXAdj
	The horizontal radius adjustment of the ellipse after relative coordinates are calculated. More...

Real	RadiusXRel
	The horizontal radius of the ellipse in relative coordinates. More...

Integer	RadiusYAdj
	The vertical radius adjustment of the ellipse after relative coordinates are calculated. More...

Real	RadiusYRel
	The vertical radius of the ellipse in relative coordinates. More...

Detailed Description

A modifier that draws a simple coloured ellipse onto the texture.

Definition at line 82 of file ellipsemodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::EllipseModifier::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 185 of file ellipsemodifier.cpp.

void Mezzanine::Graphics::Procedural::EllipseModifier::Modify ( TextureBuffer & Buffer )

virtual

Alters the generated pixels in a TextureBuffer.

Parameters

Buffer The buffer to be modified.

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

Definition at line 107 of file ellipsemodifier.cpp.

void Mezzanine::Graphics::Procedural::EllipseModifier::PutPixel	(	const Integer	XPos,
		const Integer	YPos,
		TextureBuffer &	Buffer
	)

protected

Convenience method for placing a pixel for the ellipse.

Parameters

XPos	The position on the X axis to place the pixel.
YPos	The position on the Y axis to place the pixel.
Buffer	A reference to the buffer being worked on.

Definition at line 93 of file ellipsemodifier.cpp.

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

Sets the colour of the ellipse to be generated.

Parameters

Colour The colour of the ellipse to generate. Initial Value: 1.0, 1.0, 1.0, 1.0.

Returns: Returns a reference to this.

Definition at line 191 of file ellipsemodifier.cpp.

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

Sets the colour of the ellipse to be generated.

Parameters

Red	The Red component for the colour of the ellipse to generate. Initial Value: 1.0.
Green	The Green component for the colour of the ellipse to generate. Initial Value: 1.0.
Blue	The Blue component for the colour of the ellipse to generate. Initial Value: 1.0.
Alpha	The Alpha component for the colour of the ellipse to generate. Initial Value: 1.0.

Returns: Returns a reference to this.

Definition at line 194 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetColour	(	const UInt8	Red,
		const UInt8	Green,
		const UInt8	Blue,
		const UInt8	Alpha
	)

Sets the colour of the ellipse to be generated.

Parameters

Red	The Red component for the colour of the ellipse to generate. Initial Value: 255.
Green	The Green component for the colour of the ellipse to generate. Initial Value: 255.
Blue	The Blue component for the colour of the ellipse to generate. Initial Value: 255.
Alpha	The Alpha component for the colour of the ellipse to generate. Initial Value: 255.

Returns: Returns a reference to this.

Definition at line 197 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetEllipse	(	const Real	XPosition,
		const Real	YPosition,
		const Real	XRadius,
		const Real	YRadius
	)

Sets the relative position and radius of this ellipse..

Parameters

XPosition	The left edge of the ellipse in relative coordinates. Initial Value: 0.5.
YPosition	The top edge of the ellipse in relative coordinates. Initial Value: 0.5.
XRadius	The horizontal radius of the ellipse in relative coordinates. Initial Value: 0.5.
YRadius	The vertical radius of the ellipse in relative coordinates. Initial Value: 0.5.

Returns: Returns a reference to this.

Definition at line 200 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetEllipse	(	const Integer	XPosition,
		const Integer	YPosition,
		const Integer	XRadius,
		const Integer	YRadius
	)

Sets the offsets for the position and radius of this ellipse.

Parameters

XPosition	The left edge adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.
YPosition	The top edge adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.
XRadius	The horizontal radius adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.
YRadius	The vertical radius adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.

Returns: Returns a reference to this.

Definition at line 209 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetEllipse	(	const Real	XPositionRel,
		const Real	YPositionRel,
		const Real	XRadiusRel,
		const Real	YRadiusRel,
		const Integer	XPositionAdj,
		const Integer	YPositionAdj,
		const Integer	XRadiusAdj,
		const Integer	YRadiusAdj
	)

Sets the relative and offset values for the ellipse.

Parameters

XPositionRel	The left edge of the ellipse in relative coordinates. Initial Value: 0.5.
YPositionRel	The top edge of the ellipse in relative coordinates. Initial Value: 0.5.
XRadiusRel	The horizontal radius of the ellipse in relative coordinates. Initial Value: 0.5.
YRadiusRel	The vertical radius of the ellipse in relative coordinates. Initial Value: 0.5.
XPositionAdj	The left edge adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.
YPositionAdj	The top edge adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.
XRadiusAdj	The horizontal radius adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.
YRadiusAdj	The vertical radius adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.

Returns: Returns a reference to this.

Definition at line 218 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetPosition	(	const Real	XPositionRel,
		const Real	YPositionRel,
		const Integer	XPositionAdj,
		const Integer	YPositionAdj
	)

Sets the relative and offset values for the ellipse position.

Parameters

XPositionRel	The left edge of the ellipse in relative coordinates. Initial Value: 0.5.
YPositionRel	The top edge of the ellipse in relative coordinates. Initial Value: 0.5.
XPositionAdj	The left edge adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.
YPositionAdj	The top edge adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.

Returns: Returns a reference to this.

Definition at line 231 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetRadius	(	const Real	XRadiusRel,
		const Real	YRadiusRel,
		const Integer	XRadiusAdj,
		const Integer	YRadiusAdj
	)

Sets the relative and offset values for the ellipse radius.

Parameters

XRadiusRel	The horizontal radius of the ellipse in relative coordinates. Initial Value: 0.5.
YRadiusRel	The vertical radius of the ellipse in relative coordinates. Initial Value: 0.5.
XRadiusAdj	The horizontal radius adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.
YRadiusAdj	The vertical radius adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.

Returns: Returns a reference to this.

Definition at line 240 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetXPositionAdj ( const Integer X )

Sets the absolute component of the left edge.

Parameters

X	The left edge adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.

Returns: Returns a reference to this.

Definition at line 261 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetXPositionRel ( const Real X )

Sets the relative component of the left edge.

Parameters

X	The left edge of the ellipse in relative coordinates. Initial Value: 0.5.

Returns: Returns a reference to this.

Definition at line 249 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetXRadiusAdj ( const Integer X )

Sets the absolute component for the horizontal radius.

Parameters

X	The horizontal radius adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.

Returns: Returns a reference to this.

Definition at line 267 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetXRadiusRel ( const Real X )

Sets the relative component of the horizontal radius.

Parameters

X	The horizontal radius of the ellipse in relative coordinates. Initial Value: 0.5.

Returns: Returns a reference to this.

Definition at line 255 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetYPositionAdj ( const Integer Y )

Sets the absolute component of the top edge.

Parameters

Y	The top edge adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.

Returns: Returns a reference to this.

Definition at line 264 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetYPositionRel ( const Real Y )

Sets the relative component of the top edge.

Parameters

Y	The top edge of the ellipse in relative coordinates. Initial Value: 0.5.

Returns: Returns a reference to this.

Definition at line 252 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetYRadiusAdj ( const Integer Y )

Sets the absolute component for the vertical radius.

Parameters

Y	The vertical radius adjustment of the ellipse after relative coordinates are calculated. Initial Value: 0.

Returns: Returns a reference to this.

Definition at line 270 of file ellipsemodifier.cpp.

EllipseModifier & Mezzanine::Graphics::Procedural::EllipseModifier::SetYRadiusRel ( const Real Y )

Sets the relative component of the vertical radius.

Parameters

Y	The vertical radius of the ellipse in relative coordinates. Initial Value: 0.5.

Returns: Returns a reference to this.

Definition at line 258 of file ellipsemodifier.cpp.

Member Data Documentation

ColourValue Mezzanine::Graphics::Procedural::EllipseModifier::FillColour

protected

The colour of the ellipse to apply to the texture.

Definition at line 87 of file ellipsemodifier.h.

Integer Mezzanine::Graphics::Procedural::EllipseModifier::PositionXAdj

protected

The left edge adjustment of the ellipse after relative coordinates are calculated.

Definition at line 102 of file ellipsemodifier.h.

Real Mezzanine::Graphics::Procedural::EllipseModifier::PositionXRel

protected

The left edge of the ellipse in relative coordinates.

Definition at line 90 of file ellipsemodifier.h.

Integer Mezzanine::Graphics::Procedural::EllipseModifier::PositionYAdj

protected

The top edge adjustment of the ellipse after relative coordinates are calculated.

Definition at line 105 of file ellipsemodifier.h.

Real Mezzanine::Graphics::Procedural::EllipseModifier::PositionYRel

protected

The top edge of the ellipse in relative coordinates.

Definition at line 93 of file ellipsemodifier.h.

Integer Mezzanine::Graphics::Procedural::EllipseModifier::RadiusXAdj

protected

The horizontal radius adjustment of the ellipse after relative coordinates are calculated.

Definition at line 108 of file ellipsemodifier.h.

Real Mezzanine::Graphics::Procedural::EllipseModifier::RadiusXRel

protected

The horizontal radius of the ellipse in relative coordinates.

Definition at line 96 of file ellipsemodifier.h.

Integer Mezzanine::Graphics::Procedural::EllipseModifier::RadiusYAdj

protected

The vertical radius adjustment of the ellipse after relative coordinates are calculated.

Definition at line 111 of file ellipsemodifier.h.

Real Mezzanine::Graphics::Procedural::EllipseModifier::RadiusYRel

protected

The vertical radius of the ellipse in relative coordinates.

Definition at line 99 of file ellipsemodifier.h.

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

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/Procedural/Texture/ellipsemodifier.h
/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/Procedural/Texture/ellipsemodifier.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation