Finale PDK Framework  0.54
Public Types | Public Member Functions | List of all members
FCMidiExpression Class Reference

Encapsulates the continous MIDI data in a cell. More...

#include <ff_celldetails.h>

Inheritance diagram for FCMidiExpression:
__FCCellDetail __FCBaseData __FCBase

Public Types

enum  MIDI_CONTROLLER_NUMBERS { PEDAL_CONTROLLER = 64 }
 The standard MIDI controller numbers. Used by FCMidiExpression::GetControllerNumber() and FCMidiExpression::SetControllerNumber().
 
- Public Types inherited from __FCBase
enum  PDKFRAMEWORK_CLASSID {
  FCID_UNKNOWN = 0, FCID_ACCIDENTALMOD, FCID_ALLOTMENT, FCID_ARTICULATION,
  FCID_ARTICULATIONDEF, FCID_BACKWARDREPEAT, FCID_BASELINE, FCID_BEAMMOD,
  FCID_BEATCHARTELEMENT, FCID_BROKENBEAMMOD, FCID_CATEGORYDEF, FCID_CELLCLEFCHANGE,
  FCID_CELLFRAMEHOLD, FCID_CELLGRAPHIC, FCID_CELLTEXT, FCID_CENTERSMARTSHAPE,
  FCID_CHORD, FCID_CHORDPREFS, FCID_CHORDSUFFIXELEMENT, FCID_CHORUSSYLLABLE,
  FCID_CLEFDEF, FCID_COMPOSITETIMESIGBOTTOMELEMENT, FCID_COMPOSITETIMESIGTOPELEMENT, FCID_CROSSSTAFFMOD,
  FCID_CUSTOMSMARTLINEDEF, FCID_CUSTOMSTEMMOD, FCID_DISTANCEPREFS, FCID_DOTMOD,
  FCID_ENCLOSURE, FCID_ENDINGREPEAT, FCID_ENTRYALTERMOD, FCID_EXECUTABLESHAPEDEF,
  FCID_EXPRESSION, FCID_FONTINFO, FCID_FONTPREFS, FCID_FREEZESYSTEM,
  FCID_FRETBOARDSTYLEDEF, FCID_FRETBOARDSTYLEDEFS, FCID_FRETBOARDGROUPDEF, FCID_FRETBOARDGROUPDEFS,
  FCID_FRETINSTRUMENTDEF, FCID_GENERALPREFS, FCID_GRIDSGUIDESPREFS, FCID_GROUP,
  FCID_GROUPNAMEPOSITIONPREFS, FCID_HUMANPLAYBACKPREFS, FCID_INDEPENDENTCELLDETAIL, FCID_INSTRUMENTDEF,
  FCID_INSTRUMENTPLAYBACKDATA, FCID_KEYSIGNATURE, FCID_LAYERPREFS, FCID_LYRICSPREFS,
  FCID_MEASURE, FCID_MEASURENUMBERREGION, FCID_METATOOLASSIGNMENT, FCID_MIDIEXPRESSION,
  FCID_MISCDOCPREFS, FCID_MULTIMEASUREREST, FCID_MULTIMEASURERESTPREFS, FCID_MULTISTAFFINSTRUMENT,
  FCID_MULTISTAFFINSTRUMENTS, FCID_MUSICCHARACTERPREFS, FCID_MUSICSPACINGPREFS, FCID_NUMBER,
  FCID_NOTEHEADMOD, FCID_OTHERINCI, FCID_PERCUSSIONLAYOUTNOTE, FCID_PERCUSSIONSTAFF,
  FCID_PERFORMANCEMOD, FCID_PAGE, FCID_PAGEFORMATPREFS, FCID_PAGEGRAPHIC,
  FCID_PAGETEXT, FCID_PART, FCID_PARTEXTRACTPREFS, FCID_PARTSCOPEPREFS,
  FCID_PERCUSSIONNOTEMOD, FCID_PIANOBRACEPREFS, FCID_PLAYBACKPREFS, FCID_RAWTEXT,
  FCID_REPEATPREFS, FCID_SECONDARYBEAMBREAKMOD, FCID_SECTIONSYLLABLE, FCID_SEPARATEMEASURENUMBER,
  FCID_SEPARATEPLACEMENT, FCID_SHAPEDEF, FCID_SHAPEEXPRESSIONDEF, FCID_SLURCONTOURPREFS,
  FCID_SIZEPREFS, FCID_SMARTSHAPE, FCID_SMARTSHAPEENTRYMARK, FCID_SMARTSHAPEMEASUREMARK,
  FCID_SMARTSHAPEPREFS, FCID_STAFF, FCID_STAFFLIST, FCID_STAFFNAMEPOSITION,
  FCID_STAFFNAMEPOSITIONPREFS, FCID_STAFFSTYLEASSIGN, FCID_STAFFSTYLEDEF, FCID_STAFFSYSTEM,
  FCID_STEMCONNECTIONTABLE, FCID_STEMMOD, FCID_STRING, FCID_SYLLABLEENTRYMOD,
  FCID_SYSTEMSTAFF, FCID_TABLATURENOTEMOD, FCID_TEMPOELEMENT, FCID_TEXTBLOCK,
  FCID_TEXTEXPRESSIONDEF, FCID_TEXTREPEAT, FCID_TEXTREPEATDEF, FCID_TIEMOD,
  FCID_TIEPREFS, FCID_TIECONTOURPREFS, FCID_TIEPLACEMENTPREFS, FCID_TIMESIGNATURE,
  FCID_TUPLET, FCID_TUPLETPREFS, FCID_VERSESYLLABLE
}
 Constants for the GetClassID method. More...
 
enum  MEASUREMENTUNITS {
  MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT, MEASUREMENTUNIT_EVPUS = UNIT_EVPUS, MEASUREMENTUNIT_INCHES = UNIT_INCHES, MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS,
  MEASUREMENTUNIT_POINTS = UNIT_POINTS, MEASUREMENTUNIT_PICAS = UNIT_PICAS, MEASUREMENTUNIT_SPACES = UNIT_SPACES, MEASUREMENTUNIT_MILLIMETERS = 100
}
 Constants for Finale's standard measurement units. More...
 

Public Member Functions

virtual const char * ClassName ()
 Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...
 
virtual const PDKFRAMEWORK_CLASSID GetClassID ()
 Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects. More...
 
 FCMidiExpression ()
 The constructor.
 
TimeEdu32 GetMeasurePos () const
 Gets the horizontal position within the measure. More...
 
bool IsController () const
 Returns true if it's a MIDI controller event. Call SetUseController to set to a controller event. More...
 
twobyte GetControllerNumber () const
 Returns the controller number for MIDI controller events. More...
 
twobyte GetControllerValue () const
 Returns the controller value for MIDI controller events. More...
 
void SetUseController ()
 Sets the event to a MIDI controller event. This should be made before calling SetControllerNumber and SetControllerValue. More...
 
void SetControllerNumber (twobyte number)
 Sets the controller number for MIDI controller events. SetUseController must be called BEFORE setting the number. More...
 
void SetControllerValue (twobyte number)
 Sets the controller value for MIDI controller events. SetUseController must be called BEFORE setting the value. More...
 
bool IsPressure () const
 Returns true if it's a MIDI channel pressure/aftertouch event. Call SetUsePressure to set to a channel pressure/aftertouch event. More...
 
void SetPressureValue (twobyte value)
 Sets the value for MIDI channel pressure events. SetUsePressure must be called BEFORE setting the value. More...
 
twobyte GetPressureValue () const
 Returns the value for MIDI channel pressure events. More...
 
void SetUsePressure ()
 Sets the event to a MIDI channel pressure/aftertouch. This should be made before calling SetPressureValue. More...
 
bool IsPitchWheel () const
 Returns true if it's a Pitch Wheel event. Call SetUsePitchWheel to set to a pitch wheel event. More...
 
void SetPitchWheelValue (twobyte value)
 Sets the value for pitch wheel events. The SetUsePitchWheel method must be called BEFORE setting the value. More...
 
twobyte GetPitchWheelValue () const
 Returns the value for pitch wheel events. More...
 
void SetUsePitchWheel ()
 Sets the event to a Pitch Wheel event. This should be made before calling SetPitchWheelValue. More...
 
bool IsPatchChange () const
 Returns true if it's a Patch Change event. Call SetUsePatchChange to set to a patch change event. More...
 
void SetUsePatchChange ()
 Sets the event to a Patch Change event. This should be made before calling any setters. More...
 
void SetPatchChangeMode (twobyte mode)
 Sets the patch change mode for a patch change event, wich defines how the patch change is sent. SetUsePatchChange must be called before using this method. More...
 
twobyte GetPatchChangeMode () const
 Returns the patch change mode for a patch change event, wich defines how the patch change is sent. More...
 
void SetPatchChangeNumber (twobyte number)
 Sets the patch change number for a patch change event. SetUsePatchChange must be called before using this method.
 
twobyte GetPatchChangeNumber () const
 Returns the patch change number for a patch change event.
 
void SetPatchChangeBankData1 (twobyte mode)
 Sets the patch change value 1 for a patch change event. SetUsePatchChange must be called before using this method. More...
 
twobyte GetPatchChangeBankData1 () const
 Returns the patch change value 1 for a patch change event. More...
 
void SetPatchChangeBankData2 (twobyte number)
 Sets the patch change value 2 for a patch change event. SetUsePatchChange must be called before using this method. More...
 
twobyte GetPatchChangeBankData2 () const
 Returns the patch change number for a patch change event. More...
 
void SetMeasurePos (TimeEdu32 value)
 Sets the horizontal position within the measure. More...
 
virtual void DebugDump ()
 Outputs the class data/information for debugging purposes. More...
 
- Public Member Functions inherited from __FCCellDetail
void ConnectCell (FCCell *pCell)
 Connects the object to a cell. This must be done prior to any load/save operations. More...
 
FCCellGetConnectedCell () const
 Returns the connected cell.
 
virtual bool LoadFirst ()
 Overloads the LoadFirst method with a one that loads the cell data into cmper1 (staff), cmper2 (measure), inci (0) More...
 
virtual bool LoadLast ()
 Overloads the LoadLast method with a one that loads the cell data into cmper1 (staff), cmper2 (measure) and the last found inci. More...
 
virtual bool LoadNext ()
 Overloaded method of LoadNext that will only load incis within the same cmper1/cmper2.
 
virtual bool LoadPrevious ()
 
virtual bool SaveNew ()
 Creates new data. Make sure to call __FCCellDetail::ConnectCell() first. More...
 
virtual eMeas GetMeasure () const
 Returns the connected measure (based on the connected cell or actual storage). More...
 
virtual twobyte GetStaff () const
 Returns the connected staff (based on the connected cell). More...
 
- Public Member Functions inherited from __FCBaseData
EDOCID GetConnectedDocID () const
 Returns the document ID that was connected to the last load/save of the data. More...
 
bool VerifyConnectedDocID ()
 Checks that the stored document ID for the data object matches the current document's ID. More...
 
virtual EXTAG Tag ()=0
 The Enigma tag for the derived class. More...
 
virtual EVERSION EnigmaVersion ()
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeLoad ()=0
 Returns the data size for the data structure that should be loaded. More...
 
virtual int DataSizeSave ()
 Returns the data size for the data structure that should be saved or created. More...
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object. More...
 
virtual void CloneMemoryFrom (__FCBaseData *pSource)
 
const EDataID * _GetDataID ()
 Intended ONLY for the _CloneFrom implementation. More...
 
int _GetLoadedSize () const
 Intended ONLY for the _CloneFrom implementation. More...
 
const void * GetDataBlock ()
 Intended ONLY for the _CloneFrom implementation. More...
 
EXTAG GetCustomTag ()
 Returns the custom Enigma tag, if any. More...
 
void SetCustomTag (EXTAG tag)
 Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...
 
 __FCBaseData ()
 The constructor.
 
virtual ~__FCBaseData ()
 Virtual destructor.
 
virtual bool Save ()
 Saves the currently loaded to its current location. More...
 
virtual bool Reload ()
 Refreshes the data for the object, to synch the data with Finale's current data. More...
 
virtual bool DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...
 
virtual bool DeepDeleteData ()
 Deletes data and all data that's connected to the object. More...
 
__FCBaseDataCreateClone ()
 Creates an identical copy of an object. More...
 
virtual void DebugDataDump ()
 Outputs a memory dump of the data block in the object for debugging purposes. More...
 
virtual void DebugDataByteArrayDump ()
 Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...
 
void DebugDataOffsetDump (int offset, int size)
 For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
 
FCNumbersCreateRawDataDump ()
 Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes. More...
 
- Public Member Functions inherited from __FCBase
 __FCBase ()
 The constructor.
 
virtual ~__FCBase ()
 Virtual destructor, so all inherited classes get the virtual destructor. More...
 
void DebugMsgDigit (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...
 
void DebugMsgHex (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards. More...
 
void DebugMsgString (const char *pszPrefixText, const char *thestring)
 Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards. More...
 
void DebugMsg (const char *pszMsg)
 Creates a simple Message Box for debug purposes with just one text string. More...
 
void DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
 Outputs the menu command info for debugging purposes. More...
 
int DebugOutFormat (const char *fmt,...)
 Outputs debug text using C style "printf" syntax. More...
 
void Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
 Sets a 16 bit flag in the data block. More...
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets a 32 bit flag in the data block. More...
 
bool GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
 Gets a state from flag bits. Returns true if any bit in the mask is set. More...
 
void SetUserData (void *pData)
 Sets the user data attached to the instance of an object. More...
 
void SetUserData2 (void *pData)
 Sets the additional user data attached to the instance of an object. More...
 
void * GetUserData () const
 Gets the user data attached to the instance of an object. More...
 
void * GetUserData2 () const
 Gets the additional user data attached to the instance of an object. More...
 
virtual bool IsIdentical (__FCBase *pCompareObject)
 Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...
 
void StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file. More...
 
void StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
 Helper function to store integer objects in the XML file. More...
 
void StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
 Helper function to store boolean objects in the XML file. More...
 
void StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file, as an attribute to a node. More...
 
void StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
 Helper function to store integer objects in the XML file, as an attribute to a node. More...
 
void StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
 Helper function to store boolean objects in the XML file, as an attribute to a node. More...
 
void StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
 Helper function to store floating point objects in the XML file, as an attribute to a node. More...
 
virtual void StoreToXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to store an object's data. More...
 
bool ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file. More...
 
bool ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
 Helper method to read integer objects from the XML file. More...
 
bool ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
 Helper method to read boolean objects from the XML file. More...
 
bool ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
 Helper method to read integer objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
 Helper method to read boolean objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
 Helper method to read floating point objects from the XML file, as an attribute to a node. More...
 
virtual bool ReadFromXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to read object data. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from __FCBase
static void DebugOutPtr (const char *pszPrefixText, void *ptr)
 Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards. More...
 
static void DebugOutDigit (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...
 
static void DebugOutFloat (const char *pszPrefixText, float f)
 Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards. More...
 
static void DebugOutTag (const char *pszPrefixText, EXTAG extag)
 Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards. More...
 
static void DebugOutHex (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards. More...
 
static void DebugOutBin (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards. More...
 
static void DebugOutString (const char *pszPrefixText, const char *thestring)
 Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards. More...
 
static void DebugOutString (const char *pszPrefixText, FCString *pString)
 Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards. More...
 
static void DebugOutBool (const char *pszPrefixText, bool state)
 Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE". More...
 
static void DebugOutBlock (const void *pBuffer, int startoffset, int size)
 Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped. More...
 
static void DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
 Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped. More...
 
static void DebugOut (const char *pszLine)
 Static method to output a line of text for debugging purposes. More...
 
- Protected Member Functions inherited from __FCBaseData
virtual void * Allocate ()=0
 
virtual void Deallocate ()
 
virtual bool IsDynamicSize ()
 
bool LoadDataBlock ()
 Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.
 
void ClearData ()
 
virtual twobyte CalcLastInci ()
 For internal use only! More...
 
virtual __FCBaseDataCreateObject ()=0
 Creates a new instance of the object. More...
 
bool DataIsLoaded () const
 Returns true is any data has been loaded into the object. More...
 
void _TagDocumentID ()
 For internal use only. More...
 
- Protected Attributes inherited from __FCBaseData
EDOCID _connecteddocID
 The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
 
void * _datablock
 Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
 
bool _heapdatablock
 Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
 
int _loadedsize
 Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data. More...
 
EDataID _dataid
 The EdataID for the last loaded/saved object.
 

Detailed Description

Encapsulates the continous MIDI data in a cell.

The MIDI expression can be any of these MIDI events:

Member Function Documentation

virtual const char* FCMidiExpression::ClassName ( )
inlinevirtual

Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

Lua-supported.

Reimplemented from __FCCellDetail.

virtual void FCMidiExpression::DebugDump ( )
inlinevirtual

Outputs the class data/information for debugging purposes.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

When child class inherit this method to output the contents of its own members, it should call the parent before providing its own output.

Reimplemented from __FCCellDetail.

virtual const PDKFRAMEWORK_CLASSID FCMidiExpression::GetClassID ( )
inlinevirtual

Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.

This method must be overwritten by all child classes.

Lua-supported.

Implements __FCBaseData.

twobyte FCMidiExpression::GetControllerNumber ( ) const
inline

Returns the controller number for MIDI controller events.

Lua-supported (also as property).

Returns
0 if it isn't a MIDI controller event, otherwise the controller number.
twobyte FCMidiExpression::GetControllerValue ( ) const
inline

Returns the controller value for MIDI controller events.

Lua-supported (also as property).

Returns
0 if it isn't a MIDI controller event, otherwise the controller value.
TimeEdu32 FCMidiExpression::GetMeasurePos ( ) const
inlinevirtual

Gets the horizontal position within the measure.

Lua-supported (also as property).

Returns
The position in EDUs (Enigma duration units).

Reimplemented from __FCCellDetail.

twobyte FCMidiExpression::GetPatchChangeBankData1 ( ) const
inline

Returns the patch change value 1 for a patch change event.

This controls the controller 0 patch changes.

twobyte FCMidiExpression::GetPatchChangeBankData2 ( ) const
inline

Returns the patch change number for a patch change event.

This controls the controller 32 patch changes (except for patch change mode 4, where it defines the 2nd bank data value).

twobyte FCMidiExpression::GetPatchChangeMode ( ) const
inline

Returns the patch change mode for a patch change event, wich defines how the patch change is sent.

Returns
Values 0-4. 0 - Standard patch change (all bank data should be 0). 1 - Bank sent as controler 0, 32; then program change (bank data 1 and 2 are used). 2 - Bank sent as controller 0; then program change (bank data 1 is used). 3 - bank sent as controller 32; then program change (bank data 2 used). 4 - 2 program changes (bank data 1 and 2 are used).
twobyte FCMidiExpression::GetPitchWheelValue ( ) const
inline

Returns the value for pitch wheel events.

Lua-supported (also as property).

twobyte FCMidiExpression::GetPressureValue ( ) const
inline

Returns the value for MIDI channel pressure events.

Lua-supported (also as property).

bool FCMidiExpression::IsController ( ) const
inline

Returns true if it's a MIDI controller event. Call SetUseController to set to a controller event.

Lua-supported.

bool FCMidiExpression::IsPatchChange ( ) const
inline

Returns true if it's a Patch Change event. Call SetUsePatchChange to set to a patch change event.

Lua-supported.

bool FCMidiExpression::IsPitchWheel ( ) const
inline

Returns true if it's a Pitch Wheel event. Call SetUsePitchWheel to set to a pitch wheel event.

Lua-supported.

bool FCMidiExpression::IsPressure ( ) const
inline

Returns true if it's a MIDI channel pressure/aftertouch event. Call SetUsePressure to set to a channel pressure/aftertouch event.

Lua-supported.

void FCMidiExpression::SetControllerNumber ( twobyte  number)
inline

Sets the controller number for MIDI controller events. SetUseController must be called BEFORE setting the number.

Lua-supported (also as property).

void FCMidiExpression::SetControllerValue ( twobyte  number)
inline

Sets the controller value for MIDI controller events. SetUseController must be called BEFORE setting the value.

Lua-supported (also as property).

void FCMidiExpression::SetMeasurePos ( TimeEdu32  value)
inline

Sets the horizontal position within the measure.

Lua-supported (also as property).

Parameters
valueThe elapsed duration position (in Enigma duration units).
void FCMidiExpression::SetPatchChangeBankData1 ( twobyte  mode)
inline

Sets the patch change value 1 for a patch change event. SetUsePatchChange must be called before using this method.

This controls the controller 0 patch changes.

void FCMidiExpression::SetPatchChangeBankData2 ( twobyte  number)
inline

Sets the patch change value 2 for a patch change event. SetUsePatchChange must be called before using this method.

This controls the controller 32 patch changes (except for patch change mode 4, where it defines the 2nd bank data value).

void FCMidiExpression::SetPatchChangeMode ( twobyte  mode)
inline

Sets the patch change mode for a patch change event, wich defines how the patch change is sent. SetUsePatchChange must be called before using this method.

Parameters
modeValues 0-4. 0 - Standard patch change (all bank data should be 0). 1 - Bank sent as controler 0, 32; then program change (bank data 1 and 2 are used). 2 - Bank sent as controller 0; then program change (bank data 1 is used). 3 - bank sent as controller 32; then program change (bank data 2 used). 4 - 2 program changes (bank data 1 and 2 are used).
void FCMidiExpression::SetPitchWheelValue ( twobyte  value)
inline

Sets the value for pitch wheel events. The SetUsePitchWheel method must be called BEFORE setting the value.

Lua-supported (also as property).

Parameters
value-8192 to 8192
void FCMidiExpression::SetPressureValue ( twobyte  value)
inline

Sets the value for MIDI channel pressure events. SetUsePressure must be called BEFORE setting the value.

Lua-supported (also as property).

value Values in the range of 0 to 127.

void FCMidiExpression::SetUseController ( )
inline

Sets the event to a MIDI controller event. This should be made before calling SetControllerNumber and SetControllerValue.

Lua-supported.

void FCMidiExpression::SetUsePatchChange ( )
inline

Sets the event to a Patch Change event. This should be made before calling any setters.

Lua-supported.

void FCMidiExpression::SetUsePitchWheel ( )
inline

Sets the event to a Pitch Wheel event. This should be made before calling SetPitchWheelValue.

Lua-supported.

void FCMidiExpression::SetUsePressure ( )
inline

Sets the event to a MIDI channel pressure/aftertouch. This should be made before calling SetPressureValue.

Lua-supported.