Procedural::RectangleTexture Class Reference

Draw a rectangle. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::RectangleTexture:

Public Member Functions
	RectangleTexture (TextureBufferPtr pBuffer)
	Default constructor. More...
RectangleTexture &	setColour (Ogre::ColourValue colour)
	Set the fill colour of the rectangle. More...
RectangleTexture &	setColour (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the fill colour of the rectangle. More...
RectangleTexture &	setX1 (size_t x1)
	Set absolute x position of top left start point of the rectangle in px. More...
RectangleTexture &	setX1 (Ogre::Real x1)
	Set relative x position of top left start point of the rectangle as Real. More...
RectangleTexture &	setY1 (size_t y1)
	Set absolute y position of top left start point of the rectangle in px. More...
RectangleTexture &	setY1 (Ogre::Real y1)
	Set relative y position of top left start point of the rectangle as Real. More...
RectangleTexture &	setX2 (size_t x2)
	Set absolute x position of bottom right end point of the rectangle in px. More...
RectangleTexture &	setX2 (Ogre::Real x2)
	Set relative x position of bottom right end point of the rectangle as Real. More...
RectangleTexture &	setY2 (size_t y2)
	Set absolute y position of bottom right end point of the rectangle in px. More...
RectangleTexture &	setY2 (Ogre::Real y2)
	Set relative y position of bottom right end point of the rectangle as Real. More...
RectangleTexture &	setRectangle (Ogre::RealRect rect, bool relative=true)
	Set the full rectangle coordinates. More...
RectangleTexture &	setRectangle (Ogre::Rect rect)
	Set the full rectangle coordinates. More...
RectangleTexture &	setRectangle (Ogre::Vector2 pos1, Ogre::Vector2 pos2, bool relative=true)
	Set the full rectangle coordinates. More...
RectangleTexture &	setRectangle (size_t x1, size_t y1, size_t x2, size_t y2)
	Set the full rectangle coordinates. More...
RectangleTexture &	setRectangle (Ogre::Real x1, Ogre::Real y1, Ogre::Real x2, Ogre::Real y2)
	Set the full rectangle coordinates. 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

Draw a rectangle.

Draw a filled rectangle on top of previous content.

Example:

Procedural::TextureBuffer bufferSolid(256);
Procedural::Solid(&bufferSolid).setColour(Ogre::ColourValue(0.0f, 0.5f, 1.0f, 1.0f)).process();
Procedural::RectangleTexture(&bufferSolid).setColour(Ogre::ColourValue::Red).setRectangle(0.25f, 0.25f, 0.75f, 0.75f).process();

Constructor & Destructor Documentation

RectangleTexture()

Procedural::RectangleTexture::RectangleTexture

(

TextureBufferPtr

pBuffer

)

Default constructor.

Parameters

pBuffer

Image buffer where to modify the image.

References Procedural::TextureBuffer::getHeight(), and Procedural::TextureBuffer::getWidth().

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

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setColour() [1/2]

RectangleTexture& Procedural::RectangleTexture::setColour

(

Ogre::ColourValue

colour

)

Set the fill colour of the rectangle.

Parameters

colour

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

setColour() [2/2]

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

Set the fill colour of the rectangle.

Parameters

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

setRectangle() [1/5]

RectangleTexture& Procedural::RectangleTexture::setRectangle	(	Ogre::Real	x1,
		Ogre::Real	y1,
		Ogre::Real	x2,
		Ogre::Real	y2
	)

Set the full rectangle coordinates.

Parameters

x1	New relative x position of rectangle start [0.0, 1.0] (default 0.0)
y1	New relative y position of rectangle start [0.0, 1.0] (default 0.0)
x2	New relative x position of rectangle end [0.0, 1.0] (default 1.0)
y2	New relative y position of rectangle end [0.0, 1.0] (default 1.0)

setRectangle() [2/5]

RectangleTexture& Procedural::RectangleTexture::setRectangle	(	Ogre::RealRect	rect,
		bool	relative = true
	)

Set the full rectangle coordinates.

Parameters

rect	Full rectangle description (default: left=0.0, top=0.0, right=1.0, bottom=1.0)
relative	If this is set to true (default) the rectangle data are relative [0.0, 1.0]; else absolut [px]

setRectangle() [3/5]

RectangleTexture& Procedural::RectangleTexture::setRectangle

(

Ogre::Rect

rect

)

Set the full rectangle coordinates.

Parameters

rect	Full absolute rectangle description (default: left=0, top=0, right=image width, bottom=image height)

setRectangle() [4/5]

RectangleTexture& Procedural::RectangleTexture::setRectangle	(	Ogre::Vector2	pos1,
		Ogre::Vector2	pos2,
		bool	relative = true
	)

Set the full rectangle coordinates.

Parameters

pos1	Vector to top left start point of the rectangle (default: x=0.0, y=0.0)
pos2	Vector to bottom right end point of the rectangle (default: x=1.0, y=1.0)
relative	If this is set to true (default) the vector data are relative [0.0, 1.0]; else absolut [px]

setRectangle() [5/5]

RectangleTexture& Procedural::RectangleTexture::setRectangle	(	size_t	x1,
		size_t	y1,
		size_t	x2,
		size_t	y2
	)

Set the full rectangle coordinates.

Parameters

x1	New absolute x position of rectangle start (default 0)
y1	New absolute y position of rectangle start (default 0)
x2	New absolute x position of rectangle end (default: image width)
y2	New absolute y position of rectangle end (default: image height)

setX1() [1/2]

RectangleTexture& Procedural::RectangleTexture::setX1

(

Ogre::Real

x1

)

Set relative x position of top left start point of the rectangle as Real.

Parameters

x1	New relative x position of rectangle start [0.0, 1.0] (default 0.0)

setX1() [2/2]

RectangleTexture& Procedural::RectangleTexture::setX1

(

size_t

x1

)

Set absolute x position of top left start point of the rectangle in px.

Parameters

x1	New absolute x position of rectangle start (default 0)

setX2() [1/2]

RectangleTexture& Procedural::RectangleTexture::setX2

(

Ogre::Real

x2

)

Set relative x position of bottom right end point of the rectangle as Real.

Parameters

x2	New relative x position of rectangle end [0.0, 1.0] (default 1.0)

setX2() [2/2]

RectangleTexture& Procedural::RectangleTexture::setX2

(

size_t

x2

)

Set absolute x position of bottom right end point of the rectangle in px.

Parameters

x2	New absolute x position of rectangle end (default: image width)

setY1() [1/2]

RectangleTexture& Procedural::RectangleTexture::setY1

(

Ogre::Real

y1

)

Set relative y position of top left start point of the rectangle as Real.

Parameters

y1	New relative y position of rectangle start [0.0, 1.0] (default 0.0)

setY1() [2/2]

RectangleTexture& Procedural::RectangleTexture::setY1

(

size_t

y1

)

Set absolute y position of top left start point of the rectangle in px.

Parameters

y1	New absolute x position of rectangle start (default 0)

setY2() [1/2]

RectangleTexture& Procedural::RectangleTexture::setY2

(

Ogre::Real

y2

)

Set relative y position of bottom right end point of the rectangle as Real.

Parameters

y2	New relative y position of rectangle end [0.0, 1.0] (default 1.0)

setY2() [2/2]

RectangleTexture& Procedural::RectangleTexture::setY2

(

size_t

y2

)

Set absolute y position of bottom right end point of the rectangle in px.

Parameters

y2	New absolute x position of rectangle end (default: image height)

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