Procedural::Noise Class Reference

Fills full image with noise in a given colour. More...

#include <ProceduralTextureGenerator.h>

Inheritance diagram for Procedural::Noise:

Public Types
enum	NOISE_TYPE { NOISE_WHITE, NOISE_PERLIN }
	Noise generator type. More...

Public Member Functions
	Noise (TextureBufferPtr pBuffer)
	Default constructor. More...
Noise &	setColour (Ogre::ColourValue colour)
	Set the colour of the noise. More...
Noise &	setColour (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the colour of the noise. More...
Noise &	setSeed (Ogre::uint seed)
	Set the seed for "random" number generator. More...
Noise &	setType (NOISE_TYPE type)
	Set the type of noise generation. 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

Fills full image with noise in a given colour.

High quality noise with various noise algorithms.

Examples: White noise (default)

Procedural::TextureBuffer bufferNoiseWhite(256);
Procedural::Noise(&bufferNoiseWhite).setType(Procedural::Noise::NOISE_WHITE).process();

Perlin noise

Procedural::TextureBuffer bufferNoisePerlin(256);
Procedural::Noise(&bufferNoisePerlin).setType(Procedural::Noise::NOISE_PERLIN).process();

Member Enumeration Documentation

NOISE_TYPE

enum Procedural::Noise::NOISE_TYPE

Noise generator type.

Enumerator
NOISE_WHITE	White noise.
NOISE_PERLIN	Perlin noise.

Constructor & Destructor Documentation

Noise()

Procedural::Noise::Noise

(

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::Noise::process ( )

virtual

Run image generation.

Returns

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

Implements Procedural::TextureProcessing.

setColour() [1/2]

Noise& Procedural::Noise::setColour

(

Ogre::ColourValue

colour

)

Set the colour of the noise.

Parameters

colour

New colour of the noise (default Ogre::ColourValue::White)

setColour() [2/2]

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

Set the colour of the noise.

Parameters

red	Red value of the noise colour [0.0, 1.0] (default 1.0)
green	Green value of the noise colour [0.0, 1.0] (default 1.0)
blue	Blue value of the noise colour [0.0, 1.0] (default 1.0)
alpha	Alpha value of the noise 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()

Noise& Procedural::Noise::setSeed

(

Ogre::uint

seed

)

Set the seed for "random" number generator.

Parameters

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

setType()

Noise& Procedural::Noise::setType

(

NOISE_TYPE

type

)

Set the type of noise generation.

Parameters

type	Type of noise generator (default NOISE_WHITE)

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