cmProc4.h/c : Update comments and documentation on cmScMod object.
This commit is contained in:
parent
ace80b2f7a
commit
19d31789db
@ -3535,6 +3535,7 @@ cmScModEntry_t* _cmScModulatorInsertEntry(cmScModulator* p, unsigned idx, unsign
|
|||||||
return rc;
|
return rc;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
cmRC_t _cmScModulatorParse2( cmScModulator* p, cmCtx_t* ctx, cmSymTblH_t stH, const cmChar_t* fn )
|
cmRC_t _cmScModulatorParse2( cmScModulator* p, cmCtx_t* ctx, cmSymTblH_t stH, const cmChar_t* fn )
|
||||||
{
|
{
|
||||||
cmRC_t rc = cmOkRC;
|
cmRC_t rc = cmOkRC;
|
||||||
@ -3648,6 +3649,7 @@ cmRC_t _cmScModulatorParse2( cmScModulator* p, cmCtx_t* ctx, cmSymTblH_t stH, co
|
|||||||
|
|
||||||
return rc;
|
return rc;
|
||||||
}
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
cmRC_t _cmScModulatorParse( cmScModulator* p, cmCtx_t* ctx, cmSymTblH_t stH, const cmChar_t* fn )
|
cmRC_t _cmScModulatorParse( cmScModulator* p, cmCtx_t* ctx, cmSymTblH_t stH, const cmChar_t* fn )
|
||||||
{
|
{
|
||||||
@ -4140,6 +4142,7 @@ cmRC_t cmScModulatorExec( cmScModulator* p, unsigned scLocIdx )
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Update the active variables
|
||||||
cmScModVar_t* pp = NULL;
|
cmScModVar_t* pp = NULL;
|
||||||
cmScModVar_t* vp = p->alist;
|
cmScModVar_t* vp = p->alist;
|
||||||
for(; vp!=NULL; vp=vp->alink)
|
for(; vp!=NULL; vp=vp->alink)
|
||||||
|
27
cmProc4.h
27
cmProc4.h
@ -495,6 +495,31 @@ unsigned cmScAlignScanToTimeLineEvent( cmScMatcher* p, cmTlH_t tlH, cmTlObj_t*
|
|||||||
void cmScAlignScanMarkers( cmRpt_t* rpt, cmTlH_t tlH, cmScH_t scH );
|
void cmScAlignScanMarkers( cmRpt_t* rpt, cmTlH_t tlH, cmScH_t scH );
|
||||||
|
|
||||||
//=======================================================================================================================
|
//=======================================================================================================================
|
||||||
|
/*
|
||||||
|
Syntax: <loc> <mod> <var> <type> <params>
|
||||||
|
<loc> - score location
|
||||||
|
<mod> - name of the modulator
|
||||||
|
<var> - variable name
|
||||||
|
<type> - type of operation
|
||||||
|
|
||||||
|
<params>
|
||||||
|
|
||||||
|
<min> - set a variable min value
|
||||||
|
<max> - set a variable max value
|
||||||
|
<rate> - limit how often a variable is transmitted while it is ramping
|
||||||
|
<val> - type dependent value - see 'Types' below.
|
||||||
|
<end> - ending value for a ramping variable
|
||||||
|
<dur> - determines the length of time to get to the ending value
|
||||||
|
|
||||||
|
The value of parameters may be literal numeric values or may refer to
|
||||||
|
variables by their name.
|
||||||
|
|
||||||
|
Types:
|
||||||
|
set = set <var> to <val> which may be a literal or another variable.
|
||||||
|
line = ramp from its current value to <val> over <dur> seconds
|
||||||
|
sline = set <var> to <val> and ramp to <end> over <dur> seconds
|
||||||
|
|
||||||
|
*/
|
||||||
enum
|
enum
|
||||||
{
|
{
|
||||||
kInvalidModTId,
|
kInvalidModTId,
|
||||||
@ -535,7 +560,7 @@ typedef struct cmScModVar_str
|
|||||||
unsigned phase; // cycle phase since activation
|
unsigned phase; // cycle phase since activation
|
||||||
double min;
|
double min;
|
||||||
double max;
|
double max;
|
||||||
double rate; // output rate in milliseconds
|
double rate; // output rate in milliseconds (use
|
||||||
struct cmScModEntry_str* entry; // last entry assoc'd with this value
|
struct cmScModEntry_str* entry; // last entry assoc'd with this value
|
||||||
struct cmScModVar_str* vlink; // p->vlist link
|
struct cmScModVar_str* vlink; // p->vlist link
|
||||||
struct cmScModVar_str* alink; // p->alist link
|
struct cmScModVar_str* alink; // p->alist link
|
||||||
|
Loading…
Reference in New Issue
Block a user