Procedural::Segment Class Reference

Colours image segments based on threshold. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Segment:

Public Member Functions
	Segment (TextureBufferPtr pBuffer)
	Default constructor. More...
Segment &	setColourSource (TextureBufferPtr coloursource)
	Set parameter image for colour source. More...
Segment &	setThreshold (Ogre::uchar threshold)
	Set threshold value. More...
TextureBufferPtr	process ()
	Run image manipulation. 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

Colours image segments based on threshold.

Takes segments of base image based on a threshold, and colors each segment based on .

Example:

// Image colour
Procedural::TextureBuffer bufferGradient(256);
Procedural::Gradient(&bufferGradient).setColours(Ogre::ColourValue::Black, Ogre::ColourValue::Red, Ogre::ColourValue::Green, Ogre::ColourValue::Blue).process();
 
// Image structure
Procedural::TextureBuffer bufferCell(256);
Procedural::Cell(&bufferCell).setDensity(4).setRegularity(234).process();
 
// Filter
Procedural::Segment(&bufferCell).setColourSource(&bufferGradient).process();

Constructor & Destructor Documentation

Segment()

Procedural::Segment::Segment

(

TextureBufferPtr

pBuffer

)

Default constructor.

Parameters

pBuffer

Image buffer where to modify the 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::Segment::process ( )

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setColourSource()

Segment& Procedural::Segment::setColourSource

(

TextureBufferPtr

coloursource

)

Set parameter image for colour source.

Parameters

coloursource

Pointer to an input image (default NULL)

setLog()

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

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

setThreshold()

Segment& Procedural::Segment::setThreshold

(

Ogre::uchar

threshold

)

Set threshold value.

Parameters

threshold

New threshold value [0, 255] (default 128)

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:

• ProceduralTextureModifiers.h