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

#include <ff_celldetails.h>

Inheritance diagram for FCMidiExpression:

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_ACTIVELYRIC , FCID_ALLOTMENT , FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE , FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , 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_ENIGMATEXTSTYLE , 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_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE , 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_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS , FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD , FCID_BEAMEXTENSIONMOD , 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
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

const PDKFRAMEWORK_CLASSID	GetClassID () const override
	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.

	FCMidiExpression ()
	The constructor.

TimeEdu32	GetMeasurePos () const override
	Gets the horizontal position within the measure.

bool	IsController () const
	Returns true if it's a MIDI controller event. Call SetUseController to set to a controller event.

twobyte	GetControllerNumber () const
	Returns the controller number for MIDI controller events.

twobyte	GetControllerValue () const
	Returns the controller value for MIDI controller events.

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

void	SetControllerNumber (twobyte number)
	Sets the controller number for MIDI controller events. SetUseController must be called BEFORE setting the number.

void	SetControllerValue (twobyte number)
	Sets the controller value for MIDI controller events. SetUseController must be called BEFORE setting the value.

bool	IsPressure () const
	Returns true if it's a MIDI channel pressure/aftertouch event. Call SetUsePressure to set to a channel pressure/aftertouch event.

void	SetPressureValue (twobyte value)
	Sets the value for MIDI channel pressure events. SetUsePressure must be called BEFORE setting the value.

twobyte	GetPressureValue () const
	Returns the value for MIDI channel pressure events.

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

bool	IsPitchWheel () const
	Returns true if it's a Pitch Wheel event. Call SetUsePitchWheel to set to a pitch wheel event.

void	SetPitchWheelValue (twobyte value)
	Sets the value for pitch wheel events. The SetUsePitchWheel method must be called BEFORE setting the value.

twobyte	GetPitchWheelValue () const
	Returns the value for pitch wheel events.

void	SetUsePitchWheel ()
	Sets the event to a Pitch Wheel event. This should be made before calling SetPitchWheelValue.

bool	IsPatchChange () const
	Returns true if it's a Patch Change event. Call SetUsePatchChange to set to a patch change event.

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

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.

twobyte	GetPatchChangeMode () const
	Returns the patch change mode for a patch change event, wich defines how the patch change is sent.

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.

twobyte	GetPatchChangeBankData1 () const
	Returns the patch change value 1 for a patch change event.

void	SetPatchChangeBankData2 (twobyte number)
	Sets the patch change value 2 for a patch change event. SetUsePatchChange must be called before using this method.

twobyte	GetPatchChangeBankData2 () const
	Returns the patch change number for a patch change event.

void	SetMeasurePos (TimeEdu32 value)
	Sets the horizontal position within the measure.

void	DebugDump () override
	Outputs the class data/information for debugging purposes.

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.

FCCell *	GetConnectedCell () const
	Returns the connected cell.

bool	LoadFirst () override
	Overloads the LoadFirst method with a one that loads the cell data into cmper1 (staff), cmper2 (measure), inci (0)

bool	LoadLast () override
	Overloads the LoadLast method with a one that loads the cell data into cmper1 (staff), cmper2 (measure) and the last found inci.

bool	LoadNext () override
	Overloaded method of LoadNext that will only load incis within the same cmper1/cmper2.

bool	LoadPrevious () override

virtual bool	SaveNew ()
	Creates new data. Make sure to call __FCCellDetail::ConnectCell() first.

virtual eMeas	GetMeasure () const
	Returns the connected measure (based on the connected cell or actual storage).

virtual twobyte	GetStaff () const
	Returns the connected staff (based on the connected cell).

Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data.

bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID.

virtual EXTAG	Tag () const =0
	The Enigma tag for the derived class.

virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.

virtual int	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded.

virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created.

void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object.

virtual void	CloneMemoryFrom (__FCBaseData *pSource)

const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation.

int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation.

const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation.

EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any.

void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags.

	__FCBaseData ()
	The constructor.

virtual	~__FCBaseData ()
	Virtual destructor.

virtual bool	Save ()
	Saves the currently loaded to its current location.

virtual bool	Reload ()
	Refreshes the data for the object, to synch the data with Finale's current data.

virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.

virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object.

bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.

bool	RelinkToScore ()
	Relinks all parts to the contents of the score.

__FCBaseData *	CreateClone ()
	Creates an identical copy of an object.

void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes.

void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.

void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.

FCNumbers *	CreateRawDataDump ()
	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.

Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.

void	DebugMsgInt (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.

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.

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.

void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.

void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.

int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.

void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.

void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.

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.

int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.

void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.

void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.

void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.

void *	GetUserData () const
	Gets the user data attached to the instance of an object.

void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.

virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.

void	StoreXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.

void	StoreXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int value)
	Helper function to store integer objects in the XML file.

void	StoreXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool value)
	Helper function to store boolean objects in the XML file.

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.

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.

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.

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.

virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.

bool	ReadXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.

bool	ReadXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.

bool	ReadXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.

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.

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.

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.

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.

virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

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.

static void	DebugOutInt (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.

static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.

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.

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.

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.

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.

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.

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".

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.

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.

static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.

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!

virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object.

bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.

void	_TagDocumentID ()
	For internal use only.

Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.

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.

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:

Controller
Patch change
Channel pressure/aftertouch
Pitch wheel

Member Function Documentation

◆ ClassName()

const char * FCMidiExpression::ClassName ( ) const

inlineoverridevirtual

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

Lua-supported.

Reimplemented from __FCCellDetail.

◆ DebugDump()

void FCMidiExpression::DebugDump ( )

inlineoverridevirtual

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.

◆ GetClassID()

const PDKFRAMEWORK_CLASSID FCMidiExpression::GetClassID ( ) const

inlineoverridevirtual

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 (also read-only property) (0.55).

Implements __FCBaseData.

◆ GetControllerNumber()

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.

◆ GetControllerValue()

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.

◆ GetMeasurePos()

TimeEdu32 FCMidiExpression::GetMeasurePos ( ) const

inlineoverridevirtual

Gets the horizontal position within the measure.

Lua-supported (also as property).

Returns: The position in EDUs (Enigma duration units).

Reimplemented from __FCCellDetail.

◆ GetPatchChangeBankData1()

twobyte FCMidiExpression::GetPatchChangeBankData1 ( ) const

inline

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

This controls the controller 0 patch changes.

Lua-supported (also as property),

◆ GetPatchChangeBankData2()

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).

Lua-supported (also as property),

◆ GetPatchChangeMode()

twobyte FCMidiExpression::GetPatchChangeMode ( ) const

inline

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

Lua-supported (also as property),

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).

◆ GetPatchChangeNumber()

twobyte FCMidiExpression::GetPatchChangeNumber ( ) const

inline

Returns the patch change number for a patch change event.

Lua-supported (also as property),

◆ GetPitchWheelValue()

twobyte FCMidiExpression::GetPitchWheelValue ( ) const

inline

Returns the value for pitch wheel events.

Lua-supported (also as property).

◆ GetPressureValue()

twobyte FCMidiExpression::GetPressureValue ( ) const

inline

Returns the value for MIDI channel pressure events.

Lua-supported (also as property).

◆ IsController()

bool FCMidiExpression::IsController ( ) const

inline

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

Lua-supported.

◆ IsPatchChange()

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.

◆ IsPitchWheel()

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.

◆ IsPressure()

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.

◆ SetControllerNumber()

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).

◆ SetControllerValue()

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).

◆ SetMeasurePos()

void FCMidiExpression::SetMeasurePos ( TimeEdu32 value )

inline

Sets the horizontal position within the measure.

Lua-supported (also as property).

Parameters

value The elapsed duration position (in Enigma duration units).

◆ SetPatchChangeBankData1()

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.

Lua-supported (also as property),

◆ SetPatchChangeBankData2()

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).

Lua-supported (also as property),

◆ SetPatchChangeMode()

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.

Lua-supported (also as property),

Parameters

mode 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).

◆ SetPatchChangeNumber()

void FCMidiExpression::SetPatchChangeNumber ( twobyte number )

inline

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

Lua-supported (also as property),

◆ SetPitchWheelValue()

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

◆ SetPressureValue()

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).

Parameters

value Values in the range of 0 to 127.

◆ SetUseController()

void FCMidiExpression::SetUseController ( )

inline

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

Lua-supported.

◆ SetUsePatchChange()

void FCMidiExpression::SetUsePatchChange ( )

inline

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

Lua-supported.

◆ SetUsePitchWheel()

void FCMidiExpression::SetUsePitchWheel ( )

inline

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

Lua-supported.

◆ SetUsePressure()

void FCMidiExpression::SetUsePressure ( )

inline

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

Lua-supported.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClassName()

◆ DebugDump()

◆ GetClassID()

◆ GetControllerNumber()

◆ GetControllerValue()

◆ GetMeasurePos()

◆ GetPatchChangeBankData1()

◆ GetPatchChangeBankData2()

◆ GetPatchChangeMode()

◆ GetPatchChangeNumber()

◆ GetPitchWheelValue()

◆ GetPressureValue()

◆ IsController()

◆ IsPatchChange()

◆ IsPitchWheel()

◆ IsPressure()

◆ SetControllerNumber()

◆ SetControllerValue()

◆ SetMeasurePos()

◆ SetPatchChangeBankData1()

◆ SetPatchChangeBankData2()

◆ SetPatchChangeMode()

◆ SetPatchChangeNumber()

◆ SetPitchWheelValue()

◆ SetPressureValue()

◆ SetUseController()

◆ SetUsePatchChange()

◆ SetUsePitchWheel()

◆ SetUsePressure()