Procedural::Vortex Class Reference

Twist some fragment of input image. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Vortex:

Public Member Functions
	Vortex (TextureBufferPtr pBuffer)
	Default constructor. More...
Vortex &	setCenterX (Ogre::Real centerx)
	Set the relative position of the twist center on x axis. More...
Vortex &	setCenterY (Ogre::Real centery)
	Set the relative position of the twist center on y axis. More...
Vortex &	setRadiusX (Ogre::Real radiusx)
	Set the relative radius of the twist area on x axis. More...
Vortex &	setRadiusY (Ogre::Real radiusy)
	Set the relative radius of the twist area on y axis. More...
Vortex &	setTwist (Ogre::Real twist)
	Set the twist angle. More...
Vortex &	setTwist (Ogre::Radian twist)
	Set the twist angle. More...
Vortex &	setTwist (Ogre::Degree twist)
	Set the twist angle. 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

Twist some fragment of input image.

Twist parts of the input image arround a given point within a given radius.

Example:

Procedural::TextureBuffer bufferCell(256);
Procedural::Cell(&bufferCell).setDensity(4).setRegularity(234).process();
Procedural::Vortex(&bufferCell).process();

Constructor & Destructor Documentation

Vortex()

Procedural::Vortex::Vortex

(

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

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setCenterX()

Vortex& Procedural::Vortex::setCenterX

(

Ogre::Real

centerx

)

Set the relative position of the twist center on x axis.

Parameters

centerx

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

setCenterY()

Vortex& Procedural::Vortex::setCenterY

(

Ogre::Real

centery

)

Set the relative position of the twist center on y axis.

Parameters

centery

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

setLog()

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

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

setRadiusX()

Vortex& Procedural::Vortex::setRadiusX

(

Ogre::Real

radiusx

)

Set the relative radius of the twist area on x axis.

Parameters

radiusx

New relative x radius of the twist area [0.0, 1.0] (default 0.5)

setRadiusY()

Vortex& Procedural::Vortex::setRadiusY

(

Ogre::Real

radiusy

)

Set the relative radius of the twist area on y axis.

Parameters

radiusy

New relative y radius of the twist area [0.0, 1.0] (default 0.5)

setTwist() [1/3]

Vortex& Procedural::Vortex::setTwist

(

Ogre::Degree

twist

)

Set the twist angle.

Parameters

twist

New twist angle for deformation [0, 360] degree (default 90)

setTwist() [2/3]

Vortex& Procedural::Vortex::setTwist

(

Ogre::Radian

twist

)

Set the twist angle.

Parameters

twist

New twist angle for deformation [0.0, Ogre::Math::TWO_PI] rad (default Ogre::Math::HALF_PI)

setTwist() [3/3]

Vortex& Procedural::Vortex::setTwist

(

Ogre::Real

twist

)

Set the twist angle.

Parameters

twist

New twist angle for deformation [0.0, 1.0] (default 0.25)

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