Mezzanine::Graphics::Procedural::CloudGenerator Class Reference

Creates a cloud structured image. More...

#include <cloudgenerator.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::CloudGenerator:

Collaboration diagram for Mezzanine::Graphics::Procedural::CloudGenerator:

Public Member Functions
	CloudGenerator ()
	Class constructor.
virtual	~CloudGenerator ()
	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...
CloudGenerator &	SetColour (const ColourValue &Colour)
	Sets the colour of the cloud. More...
CloudGenerator &	SetColour (const Real Red, const Real Green, const Real Blue, const Real Alpha=1.0)
	Sets the colour of the cloud. More...
CloudGenerator &	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 cloud. More...
Whole	GenSeed
	The seed to be used for the random number generator. More...

Detailed Description

Creates a cloud structured image.

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

Definition at line 82 of file cloudgenerator.h.

Member Function Documentation

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

String Mezzanine::Graphics::Procedural::CloudGenerator::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 117 of file cloudgenerator.cpp.

CloudGenerator & Mezzanine::Graphics::Procedural::CloudGenerator::SetColour

(

const ColourValue &

Colour

)

Sets the colour of the cloud.

Parameters

Colour

The colour to be applied to the cloud to be generated.

Returns

Returns a reference to this.

Definition at line 123 of file cloudgenerator.cpp.

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

Sets the colour of the cloud.

Parameters

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

Returns

Returns a reference to this.

Definition at line 129 of file cloudgenerator.cpp.

CloudGenerator & Mezzanine::Graphics::Procedural::CloudGenerator::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 135 of file cloudgenerator.cpp.

Member Data Documentation

ColourValue Mezzanine::Graphics::Procedural::CloudGenerator::GenColour

protected

The colour to be applied to the cloud.

Definition at line 87 of file cloudgenerator.h.

Whole Mezzanine::Graphics::Procedural::CloudGenerator::GenSeed

protected

The seed to be used for the random number generator.

Definition at line 90 of file cloudgenerator.h.

---

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

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