Finale PDK Framework 0.71
Public Types | Public Member Functions | List of all members
FCPartStaffVoicing Class Reference

Class that represents the Voicing information for a single staff in a part. More...

#include <ff_parts.h>

Inheritance diagram for FCPartStaffVoicing:
__FCNoInciOther __FCOther __FCBaseData __FCBase

Public Types

enum  PARTWILLDISPLAY { PARTDISP_ALLNOTES_IN_SINGLE_LAYER = 0 , PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS = 1 }
 Predefined constants for "will display" rules. More...
 
enum  VOICINGLAYERRULES { VOICINGLAYERRULE_ALL_NOTES = 0 , VOICINGLAYERRULE_TOP_NOTE = 1 , VOICINGLAYERRULE_BOTTOM_NOTE = 2 , VOICINGLAYERRULE_SELECTED_NOTES = 3 }
 Predefined constants for "In Measures Containing a Single Layer, Display* rules. More...
 
enum  VOICINGCOUNTNOTES { VCOUNTNOTES_FROM_THE_TOP = 1 , VCOUNTNOTES_FROM_THE_BOTTOM = 2 }
 Predefined constants for how to count notes when selecting notes. More...
 
- 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_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. More...
 
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. More...
 
 FCPartStaffVoicing ()
 The constructor. Sets the basic data for the part. More...
 
bool GetIsVoicingEnabled () const
 Returns true if the staff has Voicing enabled. More...
 
void SetIsVoicingEnabled (bool value)
 Sets whether the staff has Voicing enabled. More...
 
PARTWILLDISPLAY GetWillDisplay () const
 Returns the value for "This Staff in This Part Will Display". More...
 
void SetWillDisplay (PARTWILLDISPLAY value)
 Sets the value for "This Staff in This Part Will Display". More...
 
int GetSingleLayerNumber () const
 Returns the 1-based single layer number from which to display notes. More...
 
void SetSingleLayerNumber (int value)
 Sets the 1-based single layer number from which to display notes. More...
 
VOICINGLAYERRULES GetSingleLayerDisplayRule () const
 Returns the value for "In Measures Containing a Single Layer, Display". More...
 
void SetSingleLayerDisplayRule (VOICINGLAYERRULES value)
 Sets the value for "In Measures Containing a Single Layer, Display". More...
 
int GetMultipleLayerNumber () const
 Returns the 1-based layer number from which to display notes when there are multiple layers. More...
 
void SetMultipleLayerNumber (int value)
 Sets the 1-based layer number from which to display notes when there are multiple layers. More...
 
bool GetSingleLayerSelect1st () const
 If true, uses the 1st note in a single layer. More...
 
void SetSingleLayerSelect1st (bool value)
 Sets whether to use the 1st note in a single layer. More...
 
bool GetSingleLayerSelect2nd () const
 If true, uses the 2nd note in a single layer. More...
 
void SetSingleLayerSelect2nd (bool value)
 Sets whether to use the 2nd note in a single layer. More...
 
bool GetSingleLayerSelect3rd () const
 If true, uses the 3rd note in a single layer. More...
 
void SetSingleLayerSelect3rd (bool value)
 Sets whether to use the 3rd note in a single layer. More...
 
bool GetSingleLayerSelect4th () const
 If true, uses the 4th note in a single layer. More...
 
void SetSingleLayerSelect4th (bool value)
 Sets whether to use the 4th note in a single layer. More...
 
bool GetSingleLayerSelect5th () const
 If true, uses the 5th note in a single layer. More...
 
void SetSingleLayerSelect5th (bool value)
 Sets whether to use the 5th note in a single layer. More...
 
VOICINGCOUNTNOTES GetCountNotesRule () const
 Returns the rule for "Count Notes". More...
 
void SetCountNotesRule (VOICINGCOUNTNOTES value)
 Sets the rule for "Count Notes". More...
 
bool GetIncludeSingleNotePassages () const
 If true, include single-note passages. More...
 
void SetIncludeSingleNotePassages (bool value)
 Sets whether to include single-note passages. More...
 
void DebugDump () override
 Outputs the class data/information for debugging purposes. More...
 
- Public Member Functions inherited from __FCNoInciOther
 __FCNoInciOther ()
 The constructor.
 
virtual bool Load (CMPER itemno)
 Loads the indicated item. More...
 
bool Reload () override
 Overridden Reload() method to support complex data types. More...
 
virtual bool SaveAs (CMPER itemno)
 Saves the data under another item number. The object will now be connected to the new item number. More...
 
virtual bool DeepSaveAs (CMPER itemno)
 Saves the data under another item number, but also makes a deep copy of the object. More...
 
bool DeepDeleteData () override
 Deletes the data and all related data available in other data structures. More...
 
virtual bool SaveNew ()
 Creates the data as completely new item number. The object will now be connected to the new item number. More...
 
virtual CMPER GetItemNo () const
 Returns the item number. This typically points to items such as a page number, a measure number, a 1-based expression definition number, etc. More...
 
void SetItemNo (CMPER cmper)
 Sets the item number. Use with extreme care! This is mostly intended for situations when creating new records isn't supported by Finale (preventing SaveAs to work). More...
 
bool LoadFirst () override
 Loads the first element of 1-based data. More...
 
- Public Member Functions inherited from __FCOther
void SetCmperAndInci (CMPER cmper, twobyte inci)
 Sets both the CMPER and the incident number in the dataID record. Mainly for internal use.
 
 __FCOther ()
 The constructor.
 
bool IsIdenticalRecord (__FCOther *pCompare)
 Compares an object to see if both objects point to the same data record. 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 () const =0
 The Enigma tag for the derived class. More...
 
virtual EVERSION EnigmaVersion () const
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeLoad () const =0
 Returns the data size for the data structure that should be loaded. More...
 
virtual int DataSizeSave () const
 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 () const
 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 DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...
 
virtual bool LoadLast ()
 Loads the very last element in the database, if any. More...
 
virtual bool LoadNext ()
 Loads the next element from the database, if any. More...
 
virtual bool LoadPrevious ()
 Loads the previous element in the database, if any. More...
 
bool RelinkToCurrentView ()
 Relinks the contents in the current view so that the score and part(s) match. More...
 
bool RelinkToScore ()
 Relinks all parts to the contents of the score. More...
 
__FCBaseDataCreateClone ()
 Creates an identical copy of an object. More...
 
void DebugDataDump () override
 Outputs a memory dump of the data block in the object for debugging purposes. More...
 
void DebugDataByteArrayDump () override
 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
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. 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. More...
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets/resets a 32 bit flag, by using a bit mask. 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...
 
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. 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 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. More...
 
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. 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.
 
void _TagDocumentID ()
 For internal use only. More...
 
- 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. More...
 
EDataID _dataid
 The EdataID for the last loaded/saved object.
 

Detailed Description

Class that represents the Voicing information for a single staff in a part.

This class can only be loaded when its part has edit focus. There is at most one instance per staff. Use the staff number to call the Load method. If the Load method fails, then that staff does not have any Voicing information. If the Load method succeeds, use GetIsVoicingEnabled to determine if the staff has voiced part settings.

The Score never has Voicing information.

Member Enumeration Documentation

◆ PARTWILLDISPLAY

Predefined constants for "will display" rules.

Lua-supported (0.61).

Enumerator
PARTDISP_ALLNOTES_IN_SINGLE_LAYER 

All notes in Layer (use GetSingleLayerNumber and SetSingleLayerNumber to specify which).

PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS 

Selected notes from one or more Layers.

◆ VOICINGCOUNTNOTES

Predefined constants for how to count notes when selecting notes.

Lua-supported (0.61).

Enumerator
VCOUNTNOTES_FROM_THE_TOP 

Count notes from the top.

VCOUNTNOTES_FROM_THE_BOTTOM 

Count notes from the bottom.

◆ VOICINGLAYERRULES

Predefined constants for "In Measures Containing a Single Layer, Display* rules.

Lua-supported (0.61).

Enumerator
VOICINGLAYERRULE_ALL_NOTES 

All Notes

VOICINGLAYERRULE_TOP_NOTE 

Top Note

VOICINGLAYERRULE_BOTTOM_NOTE 

Bottom Note

VOICINGLAYERRULE_SELECTED_NOTES 

Selected Note(s)

Constructor & Destructor Documentation

◆ FCPartStaffVoicing()

FCPartStaffVoicing::FCPartStaffVoicing ( )
inline

The constructor. Sets the basic data for the part.

Lua-supported.

Member Function Documentation

◆ ClassName()

const char * FCPartStaffVoicing::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 __FCNoInciOther.

◆ DebugDump()

void FCPartStaffVoicing::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 __FCNoInciOther.

◆ GetClassID()

const PDKFRAMEWORK_CLASSID FCPartStaffVoicing::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.

◆ GetCountNotesRule()

VOICINGCOUNTNOTES FCPartStaffVoicing::GetCountNotesRule ( ) const
inline

Returns the rule for "Count Notes".

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

Returns
One of the VOICINGCOUNTNOTES constants.

◆ GetIncludeSingleNotePassages()

bool FCPartStaffVoicing::GetIncludeSingleNotePassages ( ) const
inline

If true, include single-note passages.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ GetIsVoicingEnabled()

bool FCPartStaffVoicing::GetIsVoicingEnabled ( ) const
inline

Returns true if the staff has Voicing enabled.

Lua-supported (also as property) (0.61).

◆ GetMultipleLayerNumber()

int FCPartStaffVoicing::GetMultipleLayerNumber ( ) const
inline

Returns the 1-based layer number from which to display notes when there are multiple layers.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS.

Lua-supported (also as property) (0.61).

◆ GetSingleLayerDisplayRule()

VOICINGLAYERRULES FCPartStaffVoicing::GetSingleLayerDisplayRule ( ) const
inline

Returns the value for "In Measures Containing a Single Layer, Display".

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS.

Lua-supported (also as property) (0.61).

Returns
One of the VOICINGLAYERRULES constants.

◆ GetSingleLayerNumber()

int FCPartStaffVoicing::GetSingleLayerNumber ( ) const
inline

Returns the 1-based single layer number from which to display notes.

This value is only used when GetWillDisplay == PARTDISP_ALLNOTES_IN_SINGLE_LAYER.

Lua-supported (also as property) (0.61).

◆ GetSingleLayerSelect1st()

bool FCPartStaffVoicing::GetSingleLayerSelect1st ( ) const
inline

If true, uses the 1st note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ GetSingleLayerSelect2nd()

bool FCPartStaffVoicing::GetSingleLayerSelect2nd ( ) const
inline

If true, uses the 2nd note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ GetSingleLayerSelect3rd()

bool FCPartStaffVoicing::GetSingleLayerSelect3rd ( ) const
inline

If true, uses the 3rd note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ GetSingleLayerSelect4th()

bool FCPartStaffVoicing::GetSingleLayerSelect4th ( ) const
inline

If true, uses the 4th note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ GetSingleLayerSelect5th()

bool FCPartStaffVoicing::GetSingleLayerSelect5th ( ) const
inline

If true, uses the 5th note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ GetWillDisplay()

PARTWILLDISPLAY FCPartStaffVoicing::GetWillDisplay ( ) const
inline

Returns the value for "This Staff in This Part Will Display".

Lua-supported (also as property) (0.61).

Returns
One of the PARTWILLDISPLAY constants.

◆ SetCountNotesRule()

void FCPartStaffVoicing::SetCountNotesRule ( VOICINGCOUNTNOTES  value)
inline

Sets the rule for "Count Notes".

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

Parameters
valueAny of the VOICINGCOUNTNOTES constants.

◆ SetIncludeSingleNotePassages()

void FCPartStaffVoicing::SetIncludeSingleNotePassages ( bool  value)
inline

Sets whether to include single-note passages.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ SetIsVoicingEnabled()

void FCPartStaffVoicing::SetIsVoicingEnabled ( bool  value)
inline

Sets whether the staff has Voicing enabled.

Lua-supported (also as property) (0.61).

◆ SetMultipleLayerNumber()

void FCPartStaffVoicing::SetMultipleLayerNumber ( int  value)
inline

Sets the 1-based layer number from which to display notes when there are multiple layers.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS.

Lua-supported (also as property) (0.61).

◆ SetSingleLayerDisplayRule()

void FCPartStaffVoicing::SetSingleLayerDisplayRule ( VOICINGLAYERRULES  value)
inline

Sets the value for "In Measures Containing a Single Layer, Display".

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS.

Lua-supported (also as property) (0.61).

Parameters
valueAny of the VOICINGLAYERRULES constants.

◆ SetSingleLayerNumber()

void FCPartStaffVoicing::SetSingleLayerNumber ( int  value)
inline

Sets the 1-based single layer number from which to display notes.

This value is only used when GetWillDisplay == PARTDISP_ALLNOTES_IN_SINGLE_LAYER.

Lua-supported (also as property) (0.61).

◆ SetSingleLayerSelect1st()

void FCPartStaffVoicing::SetSingleLayerSelect1st ( bool  value)
inline

Sets whether to use the 1st note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ SetSingleLayerSelect2nd()

void FCPartStaffVoicing::SetSingleLayerSelect2nd ( bool  value)
inline

Sets whether to use the 2nd note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ SetSingleLayerSelect3rd()

void FCPartStaffVoicing::SetSingleLayerSelect3rd ( bool  value)
inline

Sets whether to use the 3rd note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ SetSingleLayerSelect4th()

void FCPartStaffVoicing::SetSingleLayerSelect4th ( bool  value)
inline

Sets whether to use the 4th note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ SetSingleLayerSelect5th()

void FCPartStaffVoicing::SetSingleLayerSelect5th ( bool  value)
inline

Sets whether to use the 5th note in a single layer.

This value is only used when GetWillDisplay == PARTDISP_SELECTED_NOTES_MULTIPLE_LAYERS and GetSingleLayerDisplayRule == VOICINGLAYERRULE_SELECTED_NOTES.

Lua-supported (also as property) (0.61).

◆ SetWillDisplay()

void FCPartStaffVoicing::SetWillDisplay ( PARTWILLDISPLAY  value)
inline

Sets the value for "This Staff in This Part Will Display".

Lua-supported (also as property) (0.61).

Parameters
valueAny of the PARTWILLDISPLAY constants.