Predefined controller function based on a waveform. More...

Inheritance diagram for Ogre::WaveformControllerFunction:

Collaboration diagram for Ogre::WaveformControllerFunction:

Public Member Functions
	WaveformControllerFunction (WaveformType wType, Real base=0, Real frequency=1, Real phase=0, Real amplitude=1, bool deltaInput=true, Real dutyCycle=0.5)
	Default constructor, requires at least a wave type, other parameters can be defaulted unless required. More...

Real	calculate (Real source)
	Overridden function. More...

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

Protected Member Functions
Real	getAdjustedInput (Real input)
	Overridden from ControllerFunction. More...

Protected Attributes
Real	mAmplitude

Real	mBase

Real	mDeltaCount

bool	mDeltaInput
	If true, function will add input values together and wrap at 1.0 before evaluating. More...

Real	mDutyCycle

Real	mFrequency

Real	mPhase

WaveformType	mWaveType

Detailed Description

Predefined controller function based on a waveform.

Remarks

A waveform function translates parametric input to parametric output based on a wave. The factors affecting the function are:

wave type - the shape of the wave
base - the base value of the output from the wave
frequency - the speed of the wave in cycles per second
phase - the offset of the start of the wave, e.g. 0.5 to start half-way through the wave
amplitude - scales the output so that instead of lying within [0,1] it lies within [0,1] * amplitude
duty cycle - the active width of a PWM signal

: Note that for simplicity of integration with the rest of the controller insfrastructure, the output of the wave is parametric i.e. 0..1, rather than the typical wave output of [-1,1]. To compensate for this, the traditional output of the wave is scaled by the following function before output:

: Hence a wave output of -1 becomes 0, a wave output of 1 becomes 1, and a wave output of 0 becomes 0.5.

Constructor & Destructor Documentation

Ogre::WaveformControllerFunction::WaveformControllerFunction	(	WaveformType	wType,
		Real	base = `0`,
		Real	frequency = `1`,
		Real	phase = `0`,
		Real	amplitude = `1`,
		bool	deltaInput = `true`,
		Real	dutyCycle = `0.5`
	)

Default constructor, requires at least a wave type, other parameters can be defaulted unless required.

Parameters

deltaInput	If true, signifies that the input will be a delta value such that the function should add it to an internal counter before calculating the output.
dutyCycle	Used in PWM mode to specify the pulse width.