Jamoma API  0.6.0.a19
Hypocycloid2D.h
Go to the documentation of this file.
1 /** @file
2  *
3  * @ingroup dspTrajectoryLib
4  *
5  * @brief Hypocycloid Function Unit in 2D for Jamoma DSP
6  *
7  * @details see http://en.wikipedia.org/wiki/Hypocycloid fo details @n
8  *
9  * @authors Nils Peters
10  *
11  * @copyright Copyright © 2011 by Nils Peters @n
12  * This code is licensed under the terms of the "New BSD License" @n
13  * http://creativecommons.org/licenses/BSD/
14  */
15 
16 #ifndef __HYPOCYCLOID_2D_H__
17 #define __HYPOCYCLOID_2D_H__
18 
19 #include "TTDSP.h"
20 
21 
22 class Hypocycloid2D : TTAudioObjectBase {
23  TTCLASS_SETUP(Hypocycloid2D)
24 
25 protected:
26 
27  TTFloat64 mA, aMinusOne;
28 
29  /** Set the trajectory parameter k of the rendering equation in http://en.wikipedia.org/wiki/Hypocycloid
30  @param Value The new value to apply.
31  @return #TTErr error code if the method fails to execute, else #kTTErrNone.
32  */
33  TTErr setA(const TTValue& value);
34 
35  /** A standard audio processing method as used by Jamoma DSP objects.
36  @param inputs The input vector that is to be processed.
37  @param outputs The resulting windowed vector.
38  @return #TTErr error code if the method fails to execute, else #kTTErrNone.
39  */
40  TTErr processAudio(TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs);
41 };
42 
43 
44 #endif // __HYPOCYCLOID_2D_H__
TTAudioObjectBase is the base class for all audio generating and processing objects in Jamoma DSP...
Jamoma DSP Library.
double TTFloat64
64 bit floating point number
Definition: TTBase.h:188
#define TTCLASS_SETUP(className)
TODO Doxygen: need more comments here.
Definition: TTFoundation.h:54
A simple container for an array of TTAudioSignal pointers.
TTErr
Jamoma Error Codes Enumeration of error codes that might be returned by any of the TTBlue functions a...
Definition: TTBase.h:342
[doxygenAppendixC_copyExample]
Definition: TTValue.h:34