Jamoma API  0.6.0.a19

Various typedefs used in Jamoma. More...

+ Collaboration diagram for Typedefs:

Classes

struct  MaxAudioGraphWrappedClass
 Type definition for an AudioGraph class wrapped as a Max external. More...
 
struct  t_xyz
 Data structure for storing a 1,2 or 3 dimensional space data. More...
 
struct  t_decodeCoefficients
 Data structure for storing ambisonics decoding coeficients. More...
 
struct  t_dbap_bformat
 Structure for the j.dbap_bformat Max object. More...
 
struct  t_extra
 Data structure for storing extra data. More...
 

Typedefs

typedef TTCallbackTTCallbackPtr
 Pointer to a TTCallback object.
 
typedef TTClassTTClassPtr
 Pointer to a TTClass.
 
typedef TTErr(TTDataObjectBase::* TTMatrixCalculateMethod) (const TTMatrixArray *inputMatrices, TTMatrixArray *outputMatrices)
 A type that can be used to store a pointer to a calculate method (which calculates an array of matrices).
 
typedef TTDataObjectBaseTTDataObjectBasePtr
 Pointer to a TTDataObjectBase.
 
typedef TTDictionaryTTDictionaryPtr
 [doxygenAppendixC_typedefExample] More...
 
typedef TTDictionaryBaseTTDictionaryBasePtr
 Pointer to a TTDictionary.
 
typedef TTObjectBase *(* TTObjectBaseInstantiationMethod) (TTSymbol className, const TTValue arguments)
 A function pointer for an instance creation function required to be provided by all classes.
 
typedef TTErr(* TTExtensionInitializationMethod) ()
 A function pointer for an instance creation function required to be provided by all classes.
 
typedef TTErr(TTObjectBase::* TTMethod) (const TTSymbol methodName, const TTValue &anInputValue, TTValue &anOutputValue)
 A type that can be used to store a pointer to a message for an object.
 
typedef TTErr(TTObjectBase::* TTMethodValue) (const TTValue &anInputValue, TTValue &anOutputValue)
 A type that can be used to call a message for an object that does not declare the name argument.
 
typedef TTErr(TTObjectBase::* TTMethodInputValue) (const TTValue &anInputValue)
 A type that can be used to call a message for an object that does not declare the name argument.
 
typedef TTErr(TTObjectBase::* TTMethodOutputValue) (TTValue &anOutputValue)
 A type that can be used to call a message for an object that does not declare the name argument.
 
typedef TTErr(TTObjectBase::* TTMethodNone) ()
 A type that can be used to call a message for an object that does not declare any arguments.
 
typedef TTErr(TTObjectBase::* TTGetterMethod) (const TTAttribute &attribute, TTValue &value)
 A type that can be used to store a pointer to a message for an object.
 
typedef TTErr(TTObjectBase::* TTSetterMethod) (const TTAttribute &attribute, const TTValue &value)
 A type that can be used to store a pointer to a message for an object.
 
typedef TTAudioEngineTTAudioEnginePtr
 A pointer to a TTAudioEngine.
 
typedef std::vector< TTSpatDBAPSource > TTSpatDBAPSourceVector
 Pointer to a vector of TTSpatEntity points.
 
typedef std::vector< TTSpatEntityTTSpatEntityVector
 Pointer to a vector of TTSpatEntity points.
 
typedef std::vector< TTSpatSourceTTSpatSourceVector
 Pointer to a vector of TTSpatSource points.
 
typedef std::vector< TTSpatSinkTTSpatSinkVector
 Pointer to a vector of TTSpatSink points.
 
typedef TTErr(TTAudioObjectBase::* TTProcessMethod) (TTAudioSignalArrayPtr in, TTAudioSignalArrayPtr out)
 A type that can be used to store a pointer to a process method (which calculates a vector of samples). More...
 
typedef TTErr(TTAudioObjectBase::* TTCalculateMethod) (const TTFloat64 &x, TTFloat64 &y, TTPtr data)
 A type that can be used to store a pointer to a calculate method (which calculates a single sample). More...
 
typedef TTAudioObjectBaseTTAudioObjectBasePtr
 Pointer to a TTAudioObjectBase.
 
typedef TTUInt16 TTChannelCount
 Data type used when counting the number of channels in multi-channel audio signals and processes.
 
typedef std::vector< TTAudioGraphDescriptionVector > TTAudioGraphDescriptionVectors
 Here I'm documenting TTAudioGraphDescriptionVectors.
 
typedef TTAudioGraphDescriptionVectors::iterator TTAudioGraphDescriptionVectorsIter
 Here I'm documenting TTAudioGraphDescriptionVectorsIter.
 
typedef TTAudioGraphGeneratorTTAudioGraphGeneratorPtr
 Pointer to a TTAudioGraphGenerator.
 
typedef TTAudioGraphInputTTAudioGraphInputPtr
 A pointer to TTAudioGraphInput.
 
typedef TTAudioGraphOutputTTAudioGraphOutputPtr
 A pointer to a TTAudioGraphOutput.
 
typedef TTAudioGraphSourceTTAudioGraphSourcePtr
 Pointer to a TTAudioGraphSource.
 
typedef std::vector< TTAudioGraphSourceTTAudioGraphSourceVector
 A vector of #TTAudioGraphSources.
 
typedef TTAudioGraphSourceVector::iterator TTAudioGraphSourceIter
 An iterator on TTAudioGraphSourceVector.
 
typedef MaxAudioGraphWrappedClassMaxAudioGraphWrappedClassPtr
 A pointer to a MaxAudioGraphWrappedClass.
 
typedef MaxAudioGraphWrappedClassOptionsMaxAudioGraphWrappedClassOptionsPtr
 A pointer to MaxAudioGraphWrappedClassOptions.
 
typedef void(* Spec_WrapTTModularClass) (WrappedClassPtr c)
 Definition for specific TT class things. More...
 
typedef void(* Spec_WrappedClass_new) (TTPtr self, long argc, t_atom *argv)
 Wrapper for the new method, called when a new obejct is being instantiated. More...
 
typedef void(* Spec_WrappedClass_free) (TTPtr self)
 Wrapper for the 'free' method, called when an object is being freed. More...
 
typedef MaxAudioGraphWrappedClassMaxAudioGraphWrappedClassPtr
 A pointer to a MaxAudioGraphWrappedClass.
 
typedef MaxAudioGraphWrappedClassOptionsMaxAudioGraphWrappedClassOptionsPtr
 A pointer to MaxAudioGraphWrappedClassOptions.
 
typedef void(* Spec_WrapTTModularClass) (WrappedClassPtr c)
 Definition for specific TT class things. More...
 
typedef void(* Spec_WrappedClass_new) (TTPtr self, long argc, t_atom *argv)
 Wrapper for the new method, called when a new obejct is being instantiated. More...
 
typedef void(* Spec_WrappedClass_free) (TTPtr self)
 Wrapper for the 'free' method, called when an object is being freed. More...
 
typedef TTInt32 TTRowID
 Datatype for any number used to indicate a row index within a matrix. More...
 
typedef TTInt32 TTColumnID
 Datatype for any number used to indicate a column index within the matrix. More...
 
typedef TTInt16 TTElementID
 Datatype for any number used to indicate an element index within the matrix. More...
 

Detailed Description

Various typedefs used in Jamoma.

Typedef Documentation

typedef void(* Spec_WrappedClass_free) (TTPtr self)

Wrapper for the 'free' method, called when an object is being freed.

Free up memory, ensure that any events scheduled in the future are terminated, etc.

Parameters
selfThis object

Definition at line 60 of file TTModularClassWrapperPd.h.

typedef void(* Spec_WrappedClass_free) (TTPtr self)

Wrapper for the 'free' method, called when an object is being freed.

Free up memory, ensure that any events scheduled in the future are terminated, etc.

Parameters
selfThis object

Definition at line 70 of file TTModularClassWrapperMax.h.

typedef void(* Spec_WrappedClass_new) (TTPtr self, long argc, t_atom *argv)

Wrapper for the new method, called when a new obejct is being instantiated.

Parameters
selfThis object
argct_atomarray count (length) for the array of arguments
argvPointer to the atom array of arguments

Definition at line 52 of file TTModularClassWrapperPd.h.

typedef void(* Spec_WrappedClass_new) (TTPtr self, long argc, t_atom *argv)

Wrapper for the new method, called when a new obejct is being instantiated.

Parameters
selfThis object
argct_atomarray count (length) for the array of arguments
argvPointer to the atom array of arguments

Definition at line 62 of file TTModularClassWrapperMax.h.

typedef void(* Spec_WrapTTModularClass) (WrappedClassPtr c)

Definition for specific TT class things.

TODO: This description is non-informative.

Parameters
c

Definition at line 43 of file TTModularClassWrapperPd.h.

typedef void(* Spec_WrapTTModularClass) (WrappedClassPtr c)

Definition for specific TT class things.

TODO: This description is non-informative.

Parameters
c

Definition at line 53 of file TTModularClassWrapperMax.h.

typedef TTErr(TTAudioObjectBase::* TTCalculateMethod) (const TTFloat64 &x, TTFloat64 &y, TTPtr data)

A type that can be used to store a pointer to a calculate method (which calculates a single sample).

Parameters
xA single sample to be processed
yA single processed sample
dataAdditional data to be used by the calculation implementation, such as the channel number for which to compute.

Definition at line 47 of file TTAudioObjectBase.h.

Datatype for any number used to indicate a column index within the matrix.

See also
TTRowID

Definition at line 216 of file TTBase.h.

[doxygenAppendixC_typedefExample]

Pointer to a TTDictionary.

Definition at line 279 of file TTDictionary.h.

Datatype for any number used to indicate an element index within the matrix.

See also
TTRowID

Definition at line 224 of file TTBase.h.

typedef TTErr(TTAudioObjectBase::* TTProcessMethod) (TTAudioSignalArrayPtr in, TTAudioSignalArrayPtr out)

A type that can be used to store a pointer to a process method (which calculates a vector of samples).

Parameters
inAudio to be processed
outProcessed audio
Returns
TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 38 of file TTAudioObjectBase.h.

Datatype for any number used to indicate a row index within a matrix.

Three typedefs ( TTRowID, TTColumnID & TTElementID ) are used so that we can easily distinguish between these important matrix attributes, have consistent datatypes throughout TTMatrixBase and quickly change those datatypes should the need arise in the future.

Although these values should always be positive, we have intentionally avoided unsigned numbers because of boundary checking considerations in the TTMatrixBase::makeInBounds() method. Negative, signed integers have the potential to become very large numbers when casting to an unsigned integers. This can cause errors during a boundary check, such as values clipping to the high boundary instead of the low boundary or numerous iterations of loop to bring a wrapped value back into the acceptable range.

They can potentially be used to override functions that take the numbers in either order. For example, linear algebra-related matrices will likely access elements in TTRowID, TTColumnID order. However, video processing objects will likely access elements in TTColumnID, TTRowID order.

Definition at line 207 of file TTBase.h.