Procedural::Gradient Class Reference

Fills full image with given colour gradients. More...

#include <ProceduralTextureGenerator.h>

Inheritance diagram for Procedural::Gradient:

Public Member Functions
	Gradient (TextureBufferPtr pBuffer)
	Default constructor. More...
Gradient &	setColourA (Ogre::ColourValue colour)
	Set the colour in the top left corner of the image. More...
Gradient &	setColourA (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the colour in the top left corner of the image. More...
Gradient &	setColourB (Ogre::ColourValue colour)
	Set the colour in the top right corner of the image. More...
Gradient &	setColourB (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the colour in the top right corner of the image. More...
Gradient &	setColourC (Ogre::ColourValue colour)
	Set the colour in the bottom left corner of the image. More...
Gradient &	setColourC (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the colour in the bottom left corner of the image. More...
Gradient &	setColourD (Ogre::ColourValue colour)
	Set the colour in the bottom right corner of the image. More...
Gradient &	setColourD (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the colour in the bottom right corner of the image. More...
Gradient &	setColours (Ogre::ColourValue colourA, Ogre::ColourValue colourB, Ogre::ColourValue colourC, Ogre::ColourValue colourD)
	Sets the colours of the image corners. 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 given colour gradients.

Each corner of the image has unique color.

Example:

Procedural::TextureBuffer bufferGradient(256);
Procedural::Gradient(&bufferGradient).setColours(Ogre::ColourValue::Black, Ogre::ColourValue::Red, Ogre::ColourValue::Green, Ogre::ColourValue::Blue).process();

Constructor & Destructor Documentation

Gradient()

Procedural::Gradient::Gradient

(

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

virtual

Run image generation.

Returns

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

Implements Procedural::TextureProcessing.

setColourA() [1/2]

Gradient& Procedural::Gradient::setColourA

(

Ogre::ColourValue

colour

)

Set the colour in the top left corner of the image.

Parameters

colour

New colour in the top left corner for processing (default Ogre::ColourValue::Blue)

setColourA() [2/2]

Gradient& Procedural::Gradient::setColourA	(	Ogre::Real	red,
		Ogre::Real	green,
		Ogre::Real	blue,
		Ogre::Real	alpha = 1.0f
	)

Set the colour in the top left corner of the image.

Parameters

red	Red value of new colour in the top left corner [0.0, 1.0] (default 0.0)
green	Green value of new colour in the top left corner [0.0, 1.0] (default 0.0)
blue	Blue value of new colour in the top left corner [0.0, 1.0] (default 1.0)
alpha	Alpha value of new colour in the top left corner [0.0, 1.0] (default 1.0)

setColourB() [1/2]

Gradient& Procedural::Gradient::setColourB

(

Ogre::ColourValue

colour

)

Set the colour in the top right corner of the image.

Parameters

colour

New colour in the top right corner for processing (default Ogre::ColourValue::Green)

setColourB() [2/2]

Gradient& Procedural::Gradient::setColourB	(	Ogre::Real	red,
		Ogre::Real	green,
		Ogre::Real	blue,
		Ogre::Real	alpha = 1.0f
	)

Set the colour in the top right corner of the image.

Parameters

red	Red value of new colour in the top right corner [0.0, 1.0] (default 0.0)
green	Green value of new colour in the top right corner [0.0, 1.0] (default 1.0)
blue	Blue value of new colour in the top right corner [0.0, 1.0] (default 0.0)
alpha	Alpha value of new colour in the top right corner [0.0, 1.0] (default 1.0)

setColourC() [1/2]

Gradient& Procedural::Gradient::setColourC

(

Ogre::ColourValue

colour

)

Set the colour in the bottom left corner of the image.

Parameters

colour

New colour in the bottom left corner for processing (default Ogre::ColourValue::Red)

setColourC() [2/2]

Gradient& Procedural::Gradient::setColourC	(	Ogre::Real	red,
		Ogre::Real	green,
		Ogre::Real	blue,
		Ogre::Real	alpha = 1.0f
	)

Set the colour in the bottom left corner of the image.

Parameters

red	Red value of new colour in the bottom left corner [0.0, 1.0] (default 1.0)
green	Green value of new colour in the bottom left corner [0.0, 1.0] (default 0.0)
blue	Blue value of new colour in the bottom left corner [0.0, 1.0] (default 0.0)
alpha	Alpha value of new colour in the bottom left corner [0.0, 1.0] (default 1.0)

setColourD() [1/2]

Gradient& Procedural::Gradient::setColourD

(

Ogre::ColourValue

colour

)

Set the colour in the bottom right corner of the image.

Parameters

colour

New colour in the bottom right corner for processing (default Ogre::ColourValue(0.0f, 1.0f, 1.0f))

setColourD() [2/2]

Gradient& Procedural::Gradient::setColourD	(	Ogre::Real	red,
		Ogre::Real	green,
		Ogre::Real	blue,
		Ogre::Real	alpha = 1.0f
	)

Set the colour in the bottom right corner of the image.

Parameters

red	Red value of new colour in the bottom right corner [0.0, 1.0] (default 0.0)
green	Green value of new colour in the bottom right corner [0.0, 1.0] (default 1.0)
blue	Blue value of new colour in the bottom right corner [0.0, 1.0] (default 1.0)
alpha	Alpha value of new colour in the bottom right corner [0.0, 1.0] (default 1.0)

setColours()

Gradient& Procedural::Gradient::setColours	(	Ogre::ColourValue	colourA,
		Ogre::ColourValue	colourB,
		Ogre::ColourValue	colourC,
		Ogre::ColourValue	colourD
	)

Sets the colours of the image corners.

Parameters

colourA	New colour in the top left corner (default Ogre::ColourValue::Blue)
colourB	New colour in the top right corner (default Ogre::ColourValue::Green)
colourC	New colour in the bottom left corner (default Ogre::ColourValue::Red)
colourD	New colour in the bottom right corner (default Ogre::ColourValue(0.0f, 1.0f, 1.0f))

setLog()

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

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

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