Jamoma API
0.6.0.a19
|
TTRamp generates a linear traversal from 0.0 to 1.0 over the course of a specified time period. More...
#include <TTRamp.h>
Public Attributes | |
TTObject | mDriveUnit |
< It is public in order to be able to extend clock or function unit parameters as attributes of another object More... | |
TTObject | mFunctionUnit |
The actual function unit object defined by mFunction // TODO: Jamomacore #294 : Ease the access of the object of a kTypeObject attribute of a TTObject. | |
Public Attributes inherited from TTObjectBase | |
TTBoolean | valid |
If the object isn't completely built, or is in the process of freeing, this will be false. | |
TTBoolean | track |
enable the print of a log message to ease the track of reference counting mechanism on an instance More... | |
Protected Member Functions | |
void | setupProcess () |
Internal method for setting which process method to use. More... | |
void | setStep () |
Internal method called when the ramp is triggered (by setting the rampTime) | |
TTErr | processVectorAccurateDown (TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs) |
Process method – This method is special! It only sets the first sample of the vector and does not use it's input! | |
TTErr | processVectorAccurateUp (TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs) |
Process method – This method is special! It only sets the first sample of the vector and does not use it's input! | |
TTErr | processSampleAccurateDown (TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs) |
Process method. | |
TTErr | processSampleAccurateUp (TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs) |
Process method. | |
TTErr | setMode (const TTValue &value) |
Setter for the mode attribute. More... | |
TTErr | RampTimeInSamples (const TTValue &newValue) |
Trigger a ramp with a time set in samples. | |
TTErr | setRampTime (const TTValue &newValue) |
Trigger a ramp with a time set in milliseconds. | |
TTErr | Stop () |
Stop the current ramp. More... | |
virtual TTErr | test (TTValue &returnedTestInfo) |
Unit Tests. | |
Protected Member Functions inherited from TTObjectBase | |
TTObjectBase (const TTValue arguments) | |
Constructor. More... | |
Protected Attributes | |
TTSymbol | attrMode |
mode: sample_accurate or vector_accurate | |
TTFloat64 | attrRampTime |
ramp time in milliseconds | |
TTUInt32 | rampSamples |
ramp time in samples | |
TTBoolean | direction |
0 = ramp up, 1 = ramp down | |
Protected Attributes inherited from TTObjectBase | |
TTList | observers |
List of all objects watching this object for life-cycle and other changes. | |
Friends | |
void TTMODULAR_EXPORT | TTRampDriveCallback (TTPtr object, TTFloat64 position, TTFloat64 date) |
< It is public in order to be able to extend clock or function unit parameters as attributes of another object More... | |
Additional Inherited Members | |
Public Member Functions inherited from TTObjectBase | |
virtual | ~TTObjectBase () |
Destructor. | |
TTUInt16 | getReferenceCount () |
Query an object to get its current reference count. More... | |
TTUInt32 | getObserverCount () const |
Query an object to get the number of observers. More... | |
TTErr | registerAttribute (const TTSymbol name, const TTDataType type, void *address) |
Register an attribute. More... | |
TTErr | extendAttribute (const TTSymbol name, const TTObjectBasePtr extendedObject, const TTSymbol extendedName) |
Extend the attribute of an existing TTObjectBase to this TTObjectBase (using another attribute name) More... | |
TTErr | removeAttribute (const TTSymbol name) |
Remove an attribute. More... | |
TTErr | findAttribute (const TTSymbol name, TTAttribute **attr) |
Find an attribute. More... | |
TTErr | setAttributeValue (const TTSymbol name, TTValue &value) |
Set an attribute value for an object. More... | |
template<class T > | |
TTErr | set (const TTSymbol aName, T aValue) |
Set an attribute value for an object This is the same as calling setAttributeValue(). More... | |
TTErr | getAttributeValue (const TTSymbol name, TTValue &value) |
Get an attribute value for an object. More... | |
template<class T > | |
TTErr | get (const TTSymbol aName, T &aReturnedValue) |
Get an attribute value for an object This is the same as calling getAttributeValue(). More... | |
TTSymbol | getAttributeType (const TTSymbol name) |
Return the type of an attribute as a symbol. More... | |
TTErr | getAttributeGetterFlags (const TTSymbol name, TTAttributeFlags &value) |
Get the getterFlags of an attribute. More... | |
TTErr | setAttributeGetterFlags (const TTSymbol name, TTAttributeFlags &value) |
Set the getterFlags of an attribute. More... | |
TTErr | getAttributeSetterFlags (const TTSymbol name, TTAttributeFlags &value) |
Get the setterFlags of an attribute. More... | |
TTErr | setAttributeSetterFlags (const TTSymbol name, TTAttributeFlags &value) |
Set the setterFlags of an attribute. More... | |
TTErr | registerAttributeProperty (const TTSymbol attributeName, const TTSymbol propertyName, const TTValue &initialValue, TTGetterMethod getter, TTSetterMethod setter) |
Register an attribute property. More... | |
TTErr | registerMessageProperty (const TTSymbol messageName, const TTSymbol propertyName, const TTValue &initialValue, TTGetterMethod getter, TTSetterMethod setter) |
Register an message property. More... | |
TTErr | getAttribute (const TTSymbol name, TTAttributePtr *attributeObject) |
Search for and locate an attribute. More... | |
TTErr | getMessage (const TTSymbol name, TTMessagePtr *messageObject) |
Search for and locate a message. More... | |
void | getAttributeNames (TTValue &attributeNameList) |
Return a list of names of the available attributes. More... | |
void | getMessageNames (TTValue &messageNameList) |
Return a list of names of the available messages. More... | |
TTSymbol | getName () const |
Return the name of this class. More... | |
TTErr | registerMessage (const TTSymbol name, TTMethod method) |
Register a message with this object. More... | |
TTErr | findMessage (const TTSymbol name, TTMessage **message) |
Find a message registered with this object. More... | |
TTErr | removeMessage (const TTSymbol name) |
Remove a message. More... | |
TTErr | sendMessage (const TTSymbol name) |
TODO: Document this function. More... | |
TTErr | registerObserverForMessage (const TTObject &observingObject, const TTSymbol messageName) |
Register an observer for a message. More... | |
TTErr | registerObserverForAttribute (const TTObject &observingObject, const TTSymbol attributeName) |
Register an observer for an attribute. More... | |
TTErr | registerObserverForNotifications (const TTObject &observingObject) |
Register an observer. More... | |
TTErr | unregisterObserverForMessage (const TTObject &observingObject, const TTSymbol messageName) |
Unregister an observer for a message. More... | |
TTErr | unregisterObserverForAttribute (const TTObject &observingObject, const TTSymbol attributeName) |
Unregister an observer for an attribute. More... | |
TTErr | unregisterObserverForNotifications (const TTObject &observingObject) |
Unregister an observer for notifications. More... | |
TTErr | sendNotification (const TTSymbol name, const TTValue &arguments) |
Send a notification. More... | |
TTErr | logMessage (TTImmutableCString fmtstring,...) |
Log messages scoped to this object instance. More... | |
TTErr | logWarning (TTImmutableCString fmtstring,...) |
Log warnings scoped to this object instance. More... | |
TTErr | logError (TTImmutableCString fmtstring,...) |
Log errors scoped to this object instance. More... | |
TTErr | logDebug (TTImmutableCString fmtstring,...) |
Log messages (scoped to this object instance) to output only if the basic debugging flag is enabled in the environment. More... | |
TTErr | lock () |
Lock the object in order to ensure thread-safe processing. More... | |
TTErr | unlock () |
Unlock the object when thread-safe processing is no longer required. More... | |
TTBoolean | isLocked () |
Query if the object currently is locked for thread-safe processing. More... | |
TTBoolean | waitForLock () |
If the object is locked (e.g. More... | |
TTRamp generates a linear traversal from 0.0 to 1.0 over the course of a specified time period.
The first sample of the ramp is 0.0 and the last sample of the ramp is 1.0. This behaviour makes this ramp suitable for generating a window functions or similar where all values of the function are to be present over the time encapsulated by the ramping signal.
Definition at line 20 of file DSP/extensions/GeneratorLib/includes/TTRamp.h.
Setter for the mode attribute.
The options are 'sample' and 'vector' which determine the desired accuracy of the ramp that is generated.
Definition at line 71 of file DSP/extensions/GeneratorLib/source/TTRamp.cpp.
References attrMode, kTTErrNone, and setupProcess().
|
protected |
Internal method for setting which process method to use.
Definition at line 86 of file DSP/extensions/GeneratorLib/source/TTRamp.cpp.
References attrMode, direction, processSampleAccurateDown(), processSampleAccurateUp(), processVectorAccurateDown(), processVectorAccurateUp(), setProcessMethod, and TT.
Referenced by RampTimeInSamples(), setMode(), and setRampTime().
|
protected |
Stop the current ramp.
Definition at line 79 of file DSP/extensions/GeneratorLib/source/TTRamp.cpp.
References kTTErrNone.
|
friend |
< It is public in order to be able to extend clock or function unit parameters as attributes of another object
baton | .. |
data | .. |
Definition at line 370 of file Modular/library/source/TTRamp.cpp.
TTObject TTRamp::mDriveUnit |
< It is public in order to be able to extend clock or function unit parameters as attributes of another object
The actual clock unit object defined by mDrive // TODO: Jamomacore #294 : Ease the access of the object of a kTypeObject attribute of a TTObject
Definition at line 36 of file Modular/library/includes/TTRamp.h.