Procedural::Abnormals Class Reference

Use alpha channel as an mask for an other image. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Abnormals:

Public Types
enum	ABNORMALS_COMPENSATION { COMPENSATION_NORMAL, COMPENSATION_HEIGHT, COMPENSATION_QUATERNION }
	Methods how to work with parameter map. More...
enum	ABNORMALS_MIRROR { MIRROR_NONE, MIRROR_X_YZ, MIRROR_Y_XZ, MIRROR_X_Y_Z }
	Methods how to fix broken normal maps. More...

Public Member Functions
	Abnormals (TextureBufferPtr pBuffer)
	Default constructor. More...
Abnormals &	setParameterImage (TextureBufferPtr image)
	Set parameter image for compensation. More...
Abnormals &	setRotation (Ogre::Real rotation)
	Set rotation angle. More...
Abnormals &	setRotation (Ogre::Radian rotation)
	Set rotation angle. More...
Abnormals &	setRotation (Ogre::Degree rotation)
	Set rotation angle. More...
Abnormals &	setAxis (Ogre::Vector3 axis)
	Set rotation axis. More...
Abnormals &	setAxis (Ogre::Real x, Ogre::Real y, Ogre::Real z=1.0f)
	Set rotation axis. More...
Abnormals &	setSensitivity (Ogre::uchar sensitivity)
	Set sensitivity. More...
Abnormals &	setCompensation (ABNORMALS_COMPENSATION compensation)
	Set compensation method. More...
Abnormals &	setMirror (ABNORMALS_MIRROR mirror)
	Set mirror method. 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

Use alpha channel as an mask for an other image.

Can take normal, height or quaternion map as second input.

Map translations

• Alpha channel: a(0, 255) -> angle(0, 2pi)
• Coords: r(0,255) -> x(-1, 1)
• Height map: luminance(0, 255) -> angle(0, 2pi) (axis is Z)
• Normal map: is blended with the source

Options

• Rotation: w(0, 1) -> angle(0, 2pi), rest are axis direction coordinates
• Sensitivity: (0, 255) -> angle(0, 2pi) * map alpha
• Compensation: How to deal with map
• Mirror: For broken normal maps

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::Abnormals(&bufferGradient).setParameterImage(&bufferCell).process();

Todo:

Need bugfix

Member Enumeration Documentation

ABNORMALS_COMPENSATION

enum Procedural::Abnormals::ABNORMALS_COMPENSATION

Methods how to work with parameter map.

Enumerator
COMPENSATION_NORMAL	Use as a normal map.
COMPENSATION_HEIGHT	Use as a height map.
COMPENSATION_QUATERNION	Use as a list of quaternion.

ABNORMALS_MIRROR

enum Procedural::Abnormals::ABNORMALS_MIRROR

Methods how to fix broken normal maps.

Enumerator
MIRROR_NONE	None.
MIRROR_X_YZ	X : YZ.
MIRROR_Y_XZ	Y : XZ.
MIRROR_X_Y_Z	X+Y : Z.

Constructor & Destructor Documentation

Abnormals()

Procedural::Abnormals::Abnormals

(

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

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setAxis() [1/2]

Abnormals& Procedural::Abnormals::setAxis	(	Ogre::Real	x,
		Ogre::Real	y,
		Ogre::Real	z = 1.0f
	)

Set rotation axis.

Parameters

x	New x coordinate of rotation axis (default 0.0)
y	New y coordinate of rotation axis (default 0.0)
z	New z coordinate of rotation axis (default 1.0)

setAxis() [2/2]

Abnormals& Procedural::Abnormals::setAxis

(

Ogre::Vector3

axis

)

Set rotation axis.

Parameters

axis	New rotation axis (default Ogre::Vector3(0.0f, 0.0f, 1.0f))

setCompensation()

Abnormals& Procedural::Abnormals::setCompensation

(

ABNORMALS_COMPENSATION

compensation

)

Set compensation method.

Parameters

compensation

Compensation method to use (default COMPENSATION_NORMAL)

setLog()

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

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

setMirror()

Abnormals& Procedural::Abnormals::setMirror

(

ABNORMALS_MIRROR

mirror

)

Set mirror method.

Parameters

mirror

Compensation method to use (default MIRROR_NONE)

setParameterImage()

Abnormals& Procedural::Abnormals::setParameterImage

(

TextureBufferPtr

image

)

Set parameter image for compensation.

Parameters

image

Pointer to second image (default NULL)

Note

If the parameter image is set to NULL there won't be any compensation.

setRotation() [1/3]

Abnormals& Procedural::Abnormals::setRotation

(

Ogre::Degree

rotation

)

Set rotation angle.

Parameters

rotation

New rotation angle [0, 360] degree (default 0)

setRotation() [2/3]

Abnormals& Procedural::Abnormals::setRotation

(

Ogre::Radian

rotation

)

Set rotation angle.

Parameters

rotation

New rotation angle [0.0, Ogre::Math::TWO_PI] rad (default 0.0)

setRotation() [3/3]

Abnormals& Procedural::Abnormals::setRotation

(

Ogre::Real

rotation

)

Set rotation angle.

Parameters

rotation

New rotation angle [0.0, 1.0] (default 0.0)

setSensitivity()

Abnormals& Procedural::Abnormals::setSensitivity

(

Ogre::uchar

sensitivity

)

Set sensitivity.

Parameters

sensitivity

New sensitivity value [0, 255] (default 127)

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