TTTrajectory Class Reference

Generalized Trajectory Function Wrapper. More...

#include <TTTrajectory.h>

Inheritance diagram for TTTrajectory:

Collaboration diagram for TTTrajectory:

Public Member Functions
TTErr	setType (const TTValue &newValue)
	Setting the trajectory type. More...
TTErr	getTypes (const TTValue &, TTValue &listOfTrajectoryTypesToReturn)
	Return a list of all the available trajectory types. More...
TTErr	getCurrentType (const TTValue &, TTValue &CurrentTypeToReturn)
	Return the current trajectory type. More...
TTErr	getCurrentAttributeNames (const TTValue &, TTValue &listOfCurrentAttributesToReturn)
	Return a list of the attribute names used in the selected trajectory type. More...
TTErr	ramp (const TTValue &arguments, TTValue &)
	Function to trigger the trajectory generation when ramp mode is selected. More...
TTErr	reset ()
	reset the phasor and ramp generators More...
TTErr	setA (const TTValue &newValue)
	Set parameter A, actual usage depends on selected trajectory type. More...
TTErr	setB (const TTValue &newValue)
	Set parameter B, actual usage depends on selected trajectory type. More...
TTErr	setC (const TTValue &newValue)
	Set parameter C, actual usage depends on selected trajectory type. More...
TTErr	setDeltaX (const TTValue &newValue)
	Set parameter DeltaX, actual usage depends on selected trajectory type. More...
TTErr	setDeltaY (const TTValue &newValue)
	Set parameter DeltaY, actual usage depends on selected trajectory type. More...
TTErr	setDeltaZ (const TTValue &newValue)
	Set parameter DeltaZ, actual usage depends on selected trajectory type. More...
TTErr	setMode (const TTValue &newValue)
	Set mode to "ramp" or "phasor". More...
TTErr	setProcessPointers ()
	Internal function to set the process pointers to the ramp o phasor generator according to the setMode function. More...
TTErr	processAudioPhasorInternal (TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs)
	Internal Computing the phasor signal to drive the trajectory functions. More...
TTErr	processAudioRampInternal (TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs)
	Internal Computing the ramp signal to drive the trajectory functions. More...

Protected Attributes
TTAudioObjectBasePtr	mActualTrajectoryObject
	The actual trajectory object that this object is currently wrapping.
TTFloat64	mA
	Trajectory Parameter, usage depend on the actual trajectory.
TTFloat64	mB
	Trajectory Parameter, usage depend on the actual trajectory.
TTFloat64	mC
	Trajectory Parameter, usage depend on the actual trajectory.
TTFloat64	mDeltaX
	Trajectory Parameter, usage depend on the actual trajectory.
TTFloat64	mDeltaY
	Trajectory Parameter, usage depend on the actual trajectory.
TTFloat64	mDeltaZ
	Trajectory Parameter, usage depend on the actual trajectory function.
TTSymbol	mType
	The name of the current trajectory type.
TTSymbol	mMode
	the underlying signal generator, can be "phasor" or "ramp"
TTAudioObject	mPhasor
	The internal phasor generator.
TTAudio	mPhasorOutputSignal
	The output vector of the phasor generator.
TTAudioObject	mRamp
	The internal ramp generator.
TTAudio	mRampOutputSignal
	The output vector of the ramp generator.

Detailed Description

Generalized Trajectory Function Wrapper.

Definition at line 23 of file TTTrajectory.h.

Member Function Documentation

TTErr TTTrajectory::getCurrentAttributeNames ( const TTValue &  , TTValue &  listOfCurrentAttributesToReturn  )

inline

Return a list of the attribute names used in the selected trajectory type.

Parameters

listOfCurrentAttributesToReturn

Pointer to an array that will be filled all attributes used in the current trajectory type.

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 111 of file TTTrajectory.h.

References TTValue::append(), TTValue::clear(), TTObjectBase::getAttributeNames(), kTTErrNone, TTValue::size(), and TT.

Here is the call graph for this function:

TTErr TTTrajectory::getCurrentType ( const TTValue &  , TTValue &  CurrentTypeToReturn  )

inline

Return the current trajectory type.

Parameters

CurrentTypeToReturn

Pointer to an array that will be filled the current trajectory type.

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 99 of file TTTrajectory.h.

References kTTErrNone, and mType.

TTErr TTTrajectory::getTypes ( const TTValue &  , TTValue &  listOfTrajectoryTypesToReturn  )

inline

Return a list of all the available trajectory types.

Parameters

listOfTrajectoryTypesToReturn

Pointer to an array that will be filled with a list of all available trajectory types.

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 86 of file TTTrajectory.h.

References TTObject::GetRegisteredClassNamesForTags(), TTValue::resize(), and TT.

Here is the call graph for this function:

TTErr TTTrajectory::processAudioPhasorInternal ( TTAudioSignalArrayPtr  inputs, TTAudioSignalArrayPtr  outputs  )

inline

Internal Computing the phasor signal to drive the trajectory functions.

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 331 of file TTTrajectory.h.

References TTAudioObjectBase::process().

Referenced by setProcessPointers().

Here is the call graph for this function:

TTErr TTTrajectory::processAudioRampInternal ( TTAudioSignalArrayPtr  inputs, TTAudioSignalArrayPtr  outputs  )

inline

Internal Computing the ramp signal to drive the trajectory functions.

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 343 of file TTTrajectory.h.

References TTAudioObjectBase::process().

Referenced by setProcessPointers().

Here is the call graph for this function:

TTErr TTTrajectory::ramp ( const TTValue &  arguments, TTValue &    )

inline

Function to trigger the trajectory generation when ramp mode is selected.

Parameters

arguments

additional arguments will determine ramping: ramp <startValue|double> <stopValue|double> <time|double> <type|string> ramp <stopValue|double> <time|double> <type|string> ramp <startValue|double> <stopValue|double> <time|double> ramp <stopValue|double> <time|double>

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 141 of file TTTrajectory.h.

References kTTErrNone, kTTErrWrongNumValues, TTObject::set(), setType(), TTValue::size(), TT, and ttDataTypeInfo.

Here is the call graph for this function:

TTErr TTTrajectory::reset ( )

inline

reset the phasor and ramp generators

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 214 of file TTTrajectory.h.

References kTTErrNone, and TTObject::set().

Here is the call graph for this function:

TTErr TTTrajectory::setA ( const TTValue &  newValue )

inline

Set parameter A, actual usage depends on selected trajectory type.

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 235 of file TTTrajectory.h.

References TTObjectBase::setAttributeValue(), and TT.

Here is the call graph for this function:

TTErr TTTrajectory::setB ( const TTValue &  newValue )

inline

Set parameter B, actual usage depends on selected trajectory type.

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 245 of file TTTrajectory.h.

References TTObjectBase::setAttributeValue(), and TT.

Here is the call graph for this function:

TTErr TTTrajectory::setC ( const TTValue &  newValue )

inline

Set parameter C, actual usage depends on selected trajectory type.

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 255 of file TTTrajectory.h.

References TTObjectBase::setAttributeValue(), and TT.

Here is the call graph for this function:

TTErr TTTrajectory::setDeltaX ( const TTValue &  newValue )

inline

Set parameter DeltaX, actual usage depends on selected trajectory type.

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 265 of file TTTrajectory.h.

References TTObjectBase::setAttributeValue(), and TT.

Here is the call graph for this function:

TTErr TTTrajectory::setDeltaY ( const TTValue &  newValue )

inline

Set parameter DeltaY, actual usage depends on selected trajectory type.

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 275 of file TTTrajectory.h.

References TTObjectBase::setAttributeValue(), and TT.

Here is the call graph for this function:

TTErr TTTrajectory::setDeltaZ ( const TTValue &  newValue )

inline

Set parameter DeltaZ, actual usage depends on selected trajectory type.

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 285 of file TTTrajectory.h.

References TTObjectBase::setAttributeValue(), and TT.

Here is the call graph for this function:

TTErr TTTrajectory::setMode ( const TTValue &  newValue )

inline

Set mode to "ramp" or "phasor".

Parameters

newValue

new value

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 305 of file TTTrajectory.h.

References setProcessPointers().

Here is the call graph for this function:

TTErr TTTrajectory::setProcessPointers ( )

inline

Internal function to set the process pointers to the ramp o phasor generator according to the setMode function.

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 314 of file TTTrajectory.h.

References kTTErrNone, processAudioPhasorInternal(), processAudioRampInternal(), TTAudioObjectBase::setProcess(), and TT.

Referenced by setMode().

Here is the call graph for this function:

TTErr TTTrajectory::setType ( const TTValue &  newValue )

inline

Setting the trajectory type.

Parameters

newValue

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 48 of file TTTrajectory.h.

References kTTErrNone, TTObjectBase::setAttributeValue(), TT, and TTObjectBaseInstantiate().

Referenced by ramp().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• TTTrajectory.h