Creates a labyrinth structured image. More...

#include <labyrinthgenerator.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::LabyrinthGenerator:

Collaboration diagram for Mezzanine::Graphics::Procedural::LabyrinthGenerator:

Public Member Functions
	LabyrinthGenerator ()
	Class constructor.

virtual	~LabyrinthGenerator ()
	Class destructor.

virtual void	AddToTextureBuffer (TextureBuffer &Buffer) const
	Replaces and populates the pixels as configured in this generator to a TextureBuffer. More...

virtual String	GetName () const
	Gets the name of this generator. More...

LabyrinthGenerator &	SetColour (const ColourValue &Colour)
	Sets the colour of the background. More...

LabyrinthGenerator &	SetColour (const Real Red, const Real Green, const Real Blue, const Real Alpha=1.0)
	Sets the colour of the background. More...

LabyrinthGenerator &	SetSeed (const Whole Seed)
	Sets the seed for the "random" number generator. More...

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

virtual	~TextureGenerator ()
	Class destructor.

TextureBuffer	BuildTextureBuffer (const Whole SquareSize) const
	Creates a TextureBuffer with the pixels as configured in this generator. More...

TextureBuffer	BuildTextureBuffer (const Whole TexWidth, const Whole TexHeight) const
	Creates a TextureBuffer with the pixels as configured in this generator. More...

Image *	GenerateImage (const Whole SquareSize, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
	Generates the Image. More...

Image *	GenerateImage (const Whole TexWidth, const Whole TexHeight, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
	Generates the Image. More...

Texture *	GenerateTexture (const Whole SquareSize, const String &TexName, const String &TexGroup, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
	Generates the Texture. More...

Texture *	GenerateTexture (const Whole TexWidth, const Whole TexHeight, const String &TexName, const String &TexGroup, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
	Generates the Texture. More...

Protected Attributes
ColourValue	GenColour
	The colour to be applied to the labyrinth. More...

Whole	GenSeed
	The seed to be used for the random number generator. More...

Detailed Description

Creates a labyrinth structured image.

Creates a labyrinth structure from a specified perlin noise on a coloured background.

Definition at line 82 of file labyrinthgenerator.h.

Member Function Documentation

void Mezzanine::Graphics::Procedural::LabyrinthGenerator::AddToTextureBuffer ( TextureBuffer & Buffer ) const

virtual

Replaces and populates the pixels as configured in this generator to a TextureBuffer.

Parameters

Buffer The buffer to place this generators pixels in.

Implements Mezzanine::Graphics::Procedural::TextureGenerator.

Definition at line 93 of file labyrinthgenerator.cpp.

String Mezzanine::Graphics::Procedural::LabyrinthGenerator::GetName ( ) const

virtual

Gets the name of this generator.

Returns: Returns a String containing the name of this generator.

Implements Mezzanine::Graphics::Procedural::TextureGenerator.

Definition at line 118 of file labyrinthgenerator.cpp.

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

Sets the colour of the background.

Parameters

Colour The colour to be applied to the labyrinth to be generated.

Returns: Returns a reference to this.

Definition at line 124 of file labyrinthgenerator.cpp.

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

Sets the colour of the background.

Parameters

Red	The Red component for the background colour. Range: [0.0, 1.0].
Green	The Green component for the background colour. Range: [0.0, 1.0].
Blue	The Blue component for the background colour. Range: [0.0, 1.0].
Alpha	The Alpha component for the background colour. Range: [0.0, 1.0].

Returns: Returns a reference to this.

Definition at line 130 of file labyrinthgenerator.cpp.

LabyrinthGenerator & Mezzanine::Graphics::Procedural::LabyrinthGenerator::SetSeed ( const Whole Seed )

Sets the seed for the "random" number generator.

Parameters

Seed	The seed value for the random number generator. Initial Value: 5120.

Returns: Returns a reference to this.

Definition at line 136 of file labyrinthgenerator.cpp.

Member Data Documentation

ColourValue Mezzanine::Graphics::Procedural::LabyrinthGenerator::GenColour

protected

The colour to be applied to the labyrinth.

Definition at line 87 of file labyrinthgenerator.h.

Whole Mezzanine::Graphics::Procedural::LabyrinthGenerator::GenSeed

protected

The seed to be used for the random number generator.

Definition at line 90 of file labyrinthgenerator.h.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation