Draw a cycloid. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Cycloid:

Public Types
enum	CYCLOID_TYPE { HYPOCYCLOID, HYPOTROCHOID, EPICYCLOID, EPITROCHOID, ROSE_CURVE, LISSAJOUS_CURVE }
	Which type of cycloid should be painted. More...

enum	CYCLOID_PARAMETER { PARAMETER_R, PARAMETER_r, PARAMETER_d, PARAMETER_e, PARAMETER_k }
	Which parameter should be set. More...

Public Member Functions
	Cycloid (TextureBufferPtr pBuffer)
	Default constructor. More...

Cycloid &	setType (CYCLOID_TYPE type)
	Set the algorithm to for drawing. More...

Cycloid &	setColour (Ogre::ColourValue colour)
	Set the drawing colour for cycloid structure. More...

Cycloid &	setColour (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the drawing colour for cycloid structure. More...

Cycloid &	setCenterX (Ogre::Real centerx)
	Set the relative center position of the cycloid main circle on x axis. More...

Cycloid &	setCenterY (Ogre::Real centery)
	Set the relative center position of the cycloid main circle on y axis. More...

Cycloid &	setParameter (CYCLOID_PARAMETER paramType, Ogre::Real value)
	Set the parameter value. More...

Cycloid &	setPenSize (Ogre::uint size)
	Set the size for the pen to draw. 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 cycloid.

Draw a cycloid 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::Cycloid(&bufferSolid).setColour(Ogre::ColourValue::Red).setPenSize(2).setType(Procedural::Cycloid::HYPOTROCHOID).process();

Cycloid types

CYCLOID_TYPE	Name	Image
`HYPOCYCLOID`	Hypocycloid http://en.wikipedia.org/wiki/Hypocycloid
`HYPOTROCHOID`	Hypotrochoid http://en.wikipedia.org/wiki/Hypotrochoid
`EPICYCLOID`	Epicycloid http://en.wikipedia.org/wiki/Epicycloid
`EPITROCHOID`	Epitrochoid http://en.wikipedia.org/wiki/Epitrochoid
`ROSE_CURVE`	Rose curve http://en.wikipedia.org/wiki/Rose_curve
`LISSAJOUS_CURVE`	Lissajous curve http://en.wikipedia.org/wiki/Lissajous_curve

Default parameters

Name	Parameter R	Parameter r	Parameter d	Parameter e	Parameter k
Hypocycloid	3/6 * Size	1/6 * Size	unsused	unsused	k = R / r	3
Hypotrochoid	5/14 * Size	3/14 * Size	5/14 * Size			2
Epicycloid	3/10 * Size	1/10 * Size	unsused			3
Epitrochoid	3/10 * Size	1/10 * Size	1/20 * Size			3
Rose curve	1/2 * Size	4	1		k = r / d	4
Lissajous curve	1/2 * Size	5	4	π/2	k = r / d	5/4

Member Enumeration Documentation

◆ CYCLOID_PARAMETER

enum Procedural::Cycloid::CYCLOID_PARAMETER

Which parameter should be set.

Enumerator
PARAMETER_R	Set parameter R.
PARAMETER_r	Set parameter r.
PARAMETER_d	Set parameter d.
PARAMETER_e	Set parameter e.
PARAMETER_k	Set parameter k.

◆ CYCLOID_TYPE

enum Procedural::Cycloid::CYCLOID_TYPE

Which type of cycloid should be painted.

Enumerator
HYPOCYCLOID	Draw a Hypocycloid.
HYPOTROCHOID	Draw a Hypotrochoid.
EPICYCLOID	Draw a Epicycloid.
EPITROCHOID	Draw a Epitrochoid.
ROSE_CURVE	Draw a Rose curve.
LISSAJOUS_CURVE	Draw a Lissajous curve.

Constructor & Destructor Documentation

◆ Cycloid()

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

virtual

Run image manipulation.

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

Implements Procedural::TextureProcessing.

◆ setCenterX()

Cycloid& Procedural::Cycloid::setCenterX ( Ogre::Real centerx )

Set the relative center position of the cycloid main circle on x axis.

Parameters

centerx New relative center of the cycloid main circle [0.0, 1.0] (default 0.5)

◆ setCenterY()

Cycloid& Procedural::Cycloid::setCenterY ( Ogre::Real centery )

Set the relative center position of the cycloid main circle on y axis.

Parameters

centery New relative center of the cycloid main circle [0.0, 1.0] (default 0.5)

◆ setColour() [1/2]

Cycloid& Procedural::Cycloid::setColour ( Ogre::ColourValue colour )

Set the drawing colour for cycloid structure.

Parameters

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

◆ setColour() [2/2]

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

Set the drawing colour for cycloid structure.

Parameters

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

◆ setParameter()

Cycloid& Procedural::Cycloid::setParameter	(	CYCLOID_PARAMETER	paramType,
		Ogre::Real	value
	)

Set the parameter value.

Parameters

paramType	Selection which parameter should be set
value	New value for selected parameter

See also: Default parameters for default values

Note: Unsused paramerters will be ignored. Setting k parameter calculates the first used parameter. For example k = R / r will calculate R by R = k * r (also r from r = k * d).

◆ setPenSize()

Cycloid& Procedural::Cycloid::setPenSize ( Ogre::uint size )

Set the size for the pen to draw.

Parameters

size	New size for the drawing pen (default 1)

◆ setType()

Cycloid& Procedural::Cycloid::setType ( CYCLOID_TYPE type )

Set the algorithm to for drawing.

Parameters

type	New algorithm to draw (default HYPOCYCLOID)

Note: Call this function on first place! setType resets all numerical parameter to special defaults according on used algorithm.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ CYCLOID_PARAMETER

◆ CYCLOID_TYPE

Constructor & Destructor Documentation

◆ Cycloid()

Member Function Documentation

◆ getName()

◆ logMsg()

◆ process()

◆ setCenterX()

◆ setCenterY()

◆ setColour() [1/2]

◆ setColour() [2/2]

◆ setLog()

◆ setParameter()

◆ setPenSize()

◆ setType()

Member Data Documentation

◆ mBuffer

◆ mLog

◆ mName