Procedural::Polygon Class Reference

Draw a polygon. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Polygon:

Public Member Functions
	Polygon (TextureBufferPtr pBuffer)
	Default constructor. More...
Polygon &	setColour (Ogre::ColourValue colour)
	Set the fill colour of the polygon. More...
Polygon &	setColour (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the fill colour of the polygon. More...
Polygon &	setRadius (size_t radius)
	Set the absolute radius of the polygon edges. More...
Polygon &	setRadius (Ogre::Real radius)
	Set the relative radius of the polygon edges. More...
Polygon &	setCenterX (size_t x)
	Set absolute x position of polygon center point in px. More...
Polygon &	setCenterX (Ogre::Real x)
	Set relative x position of polygon center point as Real. More...
Polygon &	setCenterY (size_t y)
	Set absolute y position of polygon center point in px. More...
Polygon &	setCenterY (Ogre::Real y)
	Set relative y position of polygon center point as Real. More...
Polygon &	setCenter (Ogre::Vector2 pos, bool relative=true)
	Set the position of polygon center point. More...
Polygon &	setCenter (size_t x, size_t y)
	Set the position of polygon center point. More...
Polygon &	setCenter (Ogre::Real x, Ogre::Real y, bool relative=true)
	Set the position of polygon center point. More...
Polygon &	setSides (size_t n)
	Set number of polygon sides. 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 polygon.

Draw a regular polygon 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::Polygon(&bufferSolid).setColour(Ogre::ColourValue::Red).setSides(5).process();

Constructor & Destructor Documentation

Polygon()

Procedural::Polygon::Polygon

(

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

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setCenter() [1/3]

Polygon& Procedural::Polygon::setCenter	(	Ogre::Real	x,
		Ogre::Real	y,
		bool	relative = true
	)

Set the position of polygon center point.

Parameters

x	New relative x position of polygon center [0.0, 1.0] (default 0.5)
y	New relative y position of polygon center [0.0, 1.0] (default 0.5)
relative	If this is set to true (default) the vector data are relative [0.0, 1.0]; else absolut [px]

setCenter() [2/3]

Polygon& Procedural::Polygon::setCenter	(	Ogre::Vector2	pos,
		bool	relative = true
	)

Set the position of polygon center point.

Parameters

pos	Vector to the center point of the polygon (default: x=0.5, y=0.5)
relative	If this is set to true (default) the vector data are relative [0.0, 1.0]; else absolut [px]

setCenter() [3/3]

Polygon& Procedural::Polygon::setCenter	(	size_t	x,
		size_t	y
	)

Set the position of polygon center point.

Parameters

x	New absolute x position of polygon center (default 1/2 * image width)
y	New absolute y position of polygon center (default 1/2 * image width)

setCenterX() [1/2]

Polygon& Procedural::Polygon::setCenterX

(

Ogre::Real

x

)

Set relative x position of polygon center point as Real.

Parameters

x	New relative x position of polygon center [0.0, 1.0] (default 0.5)

setCenterX() [2/2]

Polygon& Procedural::Polygon::setCenterX

(

size_t

x

)

Set absolute x position of polygon center point in px.

Parameters

x	New absolute x position of polygon center (default 1/2 * image width)

setCenterY() [1/2]

Polygon& Procedural::Polygon::setCenterY

(

Ogre::Real

y

)

Set relative y position of polygon center point as Real.

Parameters

y	New relative y position of polygon center [0.0, 1.0] (default 0.5)

setCenterY() [2/2]

Polygon& Procedural::Polygon::setCenterY

(

size_t

y

)

Set absolute y position of polygon center point in px.

Parameters

y	New absolute y position of polygon center (default 1/2 * image width)

setColour() [1/2]

Polygon& Procedural::Polygon::setColour

(

Ogre::ColourValue

colour

)

Set the fill colour of the polygon.

Parameters

colour

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

setColour() [2/2]

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

Set the fill colour of the polygon.

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

setRadius() [1/2]

Polygon& Procedural::Polygon::setRadius

(

Ogre::Real

radius

)

Set the relative radius of the polygon edges.

Parameters

radius

New relative radius of the polygon edges [0.0, 1.0] (default 0.5)

setRadius() [2/2]

Polygon& Procedural::Polygon::setRadius

(

size_t

radius

)

Set the absolute radius of the polygon edges.

Parameters

radius

New absolute radius of the polygon edges in px (default smaller value of 1/2 * image width and 1/2 * image height)

setSides()

Polygon& Procedural::Polygon::setSides

(

size_t

n

)

Set number of polygon sides.

Parameters

n	New number of polygon sides (default 3)

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