FCNotePitch Class Reference

Encapsulates a note as a locally stored data, instead of a reference in a TGF. More...

#include <ff_noteframe.h>

Inheritance diagram for FCNotePitch:

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.
	FCNotePitch ()
	The constructor.
void	CopyFrom (FCNote *pNote)
	Copies the note pitch info from a FCNote object.
Public Member Functions inherited from FCNote
	FCNote (int index, EXNOTE *pexnote, FCNoteEntry *pParent)
	The constructor.
FCNoteEntry *	GetEntry () const
	Returns the note entry object for the note.
bool	GetAccidental () const
	Gets the accidental state bit for the note. This method should normally NOT be used (use CalcAccidental instead).
bool	GetAccidentalFreeze () const
	Returns the freezed accidental state.
bool	GetAccidentalParentheses () const
	Returns the parentheses accidental state.
twobyte	GetDisplacement () const
	Returns the vertical note position on the staff.
bool	GetLegality () const
	Gets the legality bit, that marks that the note is valid.
twobyte	GetRaiseLower () const
	Returns the raised/lowered state of the note.
bool	GetSpacing () const
	Returns if the note should be used in the spacing algorithm or not.
bool	GetPlayback () const
	Gets the playback status for the note.
bool	GetTie () const
	Gets the tie start state for the note.
bool	GetTieBackwards () const
	Gets the backwards tie state for the note.
bool	GetCrossStaff () const
	Gets the cross staff state for the note.
bool	GetDownstem2nd () const
	Gets the Downstem 2nd state for the note.
bool	GetUpstem2nd () const
	Gets the Upstem 2nd state for the note.
bool	GetUpstemSplit () const
	Gets the upstem split state for the note.
eNoteID	GetNoteID () const
	Returns the unique note ID.
int	GetNoteIndex () const
	Returns the index of the note within its FCNoteEntry.
void	GetString (FCString *pString, FCKeySignature *pKey, bool simplifydoublesharp=false, bool writtenpitch=false)
	Creates a string representation of the note.
bool	CalcAccidental () const
	Returns the displayed state of an accidental. This is the method that should be used to find out if an accidental is displayed.
twobyte	CalcOctave (FCKeySignature *pKey, int transposeinterval=0)
	Returns the sounding octave for the note.
twobyte	CalcWrittenOctave (FCKeySignature *pKey, int transposevalue, bool simplifytranspose, bool chromatictranspose)
	Returns the written octave for the note, taking a specific transposition into account.
bool	SetString (FCString *pString, FCKeySignature *pKey, bool writtenpitch)
	Changes the note based on the string representation. See FCNote::GetString for syntax.
FCTransposer *	GetTransposer ()
	Returns a transposer that can be used to transpose this note.
void	SetAccidental (bool state)
	Sets the accidental state for the note.
void	SetAccidentalFreeze (bool state)
	Sets the freezed accidental state.
void	SetAccidentalParentheses (bool state)
	Sets the parentheses accidental state.
void	SetSpacing (bool state)
	Sets if the note should be used in the spacing algorithm or not.
void	SetPlayback (bool state)
	Sets if the note should play back or be muted.
void	SetLegality (bool state)
	Sets the legality bit, marking that the note is valid.
void	SetDisplacement (twobyte disp)
	Sets the note's vertical position on the staff. The displacement is relative to the key.
void	SetRaiseLower (twobyte amount)
	Raises or lowers the pitch of the note.
void	SetNoteID (eNoteID noteid)
	Sets the unique note ID. Use with extreme care!
void	SetTie (bool value)
	Sets the tie state for the note.
void	SetTieBackwards (bool value)
	Sets the "tie end" state for the note.
void	SetCrossStaff (bool state)
	Sets the cross staff state for the note.
void	SetUpstemSplit (bool state)
	Sets the upstem split state for the note.
int	CalcNumberOfLedgerLines ()
	Returns the number of ledger lines the note appears on.
bool	CalcOnLedgerLine ()
	Returns true if the note appears specifically on a ledger line. The ledger line must coincide with the staff position of the note. If the note falls in a space above or below a ledger line, the function returns false. To determine if any particular note has ledger lines, use CalcNumberOfLedgerLines.
int	CalcCrossStaffNumber ()
	Returns the staff ID that belongs to the cross staff note.
bool	CalcRightsidePlacement ()
	Returns true if the notehead is on the right side of the stem.
twobyte	CalcNoteheadWidth ()
	Returns the width of the notehead.
twobyte	CalcStaffPosition ()
	Calculates the displacement from the top staffline. It takes the current score position into account (including clefs, staff styles and so on).
char	CalcPitchChar ()
	Returns the sounding note name character for the note.
char	CalcWrittenPitchChar ()
	Returns the written note name character for the note.
twobyte	CalcPitchRaiseLower (bool writtenpitch)
	Returns the number of sharps or flats the note actually has in the key signature.
twobyte	CalcMIDIKey ()
	Returns the MIDI key number for the note.
bool	CalcVisibleInPart () const
	Returns true if the note is visible in the current part or score. The only time it might be false is if the note is suppressed by voiced part settings. (See FCPartStaffVoicing.)
bool	CalcIsTopNote () const
	Returns true if the note is the top note in the entry. If some notes in the entry are suppressed in the current voiced part, the function returns true for the top visible note in the part. (See FCPartStaffVoicing.)
bool	CalcIsBottomNote () const
	Returns true if the note is the bottom visible note note in the entry. If some notes in the entry are suppressed in the current voiced part, the function returns true for the bottom visible note in the part. (See FCPartStaffVoicing.)
void	SetMIDIKey (twobyte midikey)
	Sets the MIDI key number for the note.
bool	IsIdenticalPitch (FCNote *pPitchNote)
	Returns true if the pitch is identical to the supplied note.
bool	IsHigherPitchThan (FCNote *pPitchCompareNote)
	Returns true if the pitch is higher than the pitch in the parameter's note.
bool	IsLowerPitchThan (FCNote *pPitchCompareNote)
	Returns true if the pitch is lower than the pitch in the parameter's note.
bool	IsUpper2nd () const
	Returns true if this note is an upper 2nd in a chord.
bool	IsLower2nd () const
	Returns true if this note is a lower 2nd in a chord.
bool	IsNonAligned2nd () const
	Returns true if this note is not aligned with its entry.
bool	MatchSpellingToScore ()
	Reverts a part's note spelling to that of the score. It is useful for reversing an unlinked enharmonic flip.
void	MarkForErase ()
	Marks the note for erase when the entry is saved.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
Public Member Functions inherited from __FCBase
virtual const PDKFRAMEWORK_CLASSID	GetClassID () const
	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.
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.
virtual void	DebugDataDump ()
	Outputs a memory dump of the data block in the object for debugging purposes.
virtual void	DebugDataByteArrayDump ()
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
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
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...
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 __FCBase
	__FCBase ()
	The constructor.

Detailed Description

Encapsulates a note as a locally stored data, instead of a reference in a TGF.

This class requires PDK_FRAMEWORK_ENTRIES to be defined.

It uses the same methods as the FCNote class for accessing the data, but accesses the pitch information locally.

Member Function Documentation

ClassName()

const char * FCNotePitch::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 FCNote.