Procedural::Cloud Class Reference

Creates a cloud structured image. More...

#include <ProceduralTextureGenerator.h>

Inheritance diagram for Procedural::Cloud:

Public Member Functions
	Cloud (TextureBufferPtr pBuffer)
	Default constructor. More...
Cloud &	setColour (Ogre::ColourValue colour)
	Set the colour of the background. More...
Cloud &	setColour (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Sets the colour of the background. More...
Cloud &	setSeed (Ogre::uint seed)
	Set the seed for "random" number generator. More...
TextureBufferPtr	process ()
	Run image generation. More...
Ogre::String	getName ()
	Get name of the filter as string. More...
void	setLog (bool enable=true)
	Enable/Disable logging. More...

Protected Member Functions
void	logMsg (Ogre::String msg)

Protected Attributes
TextureBufferPtr	mBuffer
Ogre::String	mName
bool	mLog

Detailed Description

Creates a cloud structured image.

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

Example:

Procedural::TextureBuffer bufferCloud(256);
Procedural::Cloud(&bufferCloud).process();

Constructor & Destructor Documentation

Cloud()

Procedural::Cloud::Cloud

(

TextureBufferPtr

pBuffer

)

Default constructor.

Parameters

pBuffer

Image buffer where to store the generated image.

Member Function Documentation

getName()

Ogre::String Procedural::TextureProcessing::getName ( )

inherited

Get name of the filter as string.

logMsg()

void Procedural::TextureProcessing::logMsg ( Ogre::String  msg )

protectedinherited

process()

TextureBufferPtr Procedural::Cloud::process ( )

virtual

Run image generation.

Returns

Pointer to image buffer which has been set in the constructor.

Implements Procedural::TextureProcessing.

setColour() [1/2]

Cloud& Procedural::Cloud::setColour

(

Ogre::ColourValue

colour

)

Set the colour of the background.

Parameters

colour

New colour for background (default Ogre::ColourValue::White)

setColour() [2/2]

Cloud& Procedural::Cloud::setColour	(	Ogre::Real	red,
		Ogre::Real	green,
		Ogre::Real	blue,
		Ogre::Real	alpha = 1.0f
	)

Sets the colour of the background.

Parameters

red	Red value of background colour [0.0, 1.0] (default 1.0)
green	Green value of background colour [0.0, 1.0] (default 1.0)
blue	Blue value of background colour [0.0, 1.0] (default 1.0)
alpha	Alpha value of background colour [0.0, 1.0] (default 1.0)

setLog()

void Procedural::TextureProcessing::setLog ( bool  enable = true )

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

setSeed()

Cloud& Procedural::Cloud::setSeed

(

Ogre::uint

seed

)

Set the seed for "random" number generator.

Parameters

seed	Seed value where to set the random number generator (default 5120)

Member Data Documentation

mBuffer

TextureBufferPtr Procedural::TextureProcessing::mBuffer

protectedinherited

mLog

bool Procedural::TextureProcessing::mLog

protectedinherited

mName

Ogre::String Procedural::TextureProcessing::mName

protectedinherited

---

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

• ProceduralTextureGenerator.h