Class for beam extensions (in Finale's Special Tools). More...

#include <ff_entrydetails.h>

Inheritance diagram for FCBeamExtensionMod:

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.

	FCBeamExtensionMod ()
	The constructor.

void	UseUpStemData (bool useupstem)
	Sets if upstem or downstem data should be loaded/saved. Finale stores upstem and downstem data in separate pools with different locator keys. It then applies one of them based on the current stem direction in the current view (for example, the part or the score).

void	SetNoteEntry (FCNoteEntry *pEntry) override
	Overridden method to assign a note entry with the data.

void	SetLeftAdjustment (Evpu16 adjust)
	Sets the left-side adjustment,.

Evpu16	GetLeftAdjustment () const
	Gets the left-side adjustment,.

void	SetRightAdjustment (Evpu16 adjust)
	Sets the right-side adjustment,.

Evpu16	GetRightAdjustment () const
	Gets the right-side adjustment,.

void	SetExtend (int beamindex, bool value)
	Sets if a beam should be extended.

void	SetExtendAll (bool value)
	Sets if all beams should extend or not.

bool	GetExtend (int beamindex) const
	Returns true if the beam should extend.

bool	GetExtend8th () const
	Returns if the 16th note beam should extend or not.

void	SetExtend8th (bool state)
	Sets if the 16th note beam should extend or not.

bool	GetExtend16th () const
	Returns if the 16th note beam should extend or not.

void	SetExtend16th (bool state)
	Sets if the 16th note beam should extend or not.

bool	GetExtend32nd () const
	Returns if the 32nd note beam should extend or not.

void	SetExtend32nd (bool state)
	Sets if the 32nd note beam should extend or not.

bool	GetExtend64th () const
	Returns if the 64th note beam should extend or not.

void	SetExtend64th (bool state)
	Sets if the 64th note beam should extend or not.

bool	GetExtend128th () const
	Returns if the 128th note beam should extend or not.

void	SetExtend128th (bool state)
	Sets if the 128th note beam should extend or not.

bool	GetExtend256th () const
	Returns if the 256th note beam should extend or not.

void	SetExtend256th (bool state)
	Sets if the 256th note beam should extend or not.

Public Member Functions inherited from __FCEntryDetail
	__FCEntryDetail ()
	The constructor.

void	SetEntnumAndInci (ENTNUM entnum, twobyte inci)
	Sets the entry number reference and inci for the object.

virtual bool	Load (ENTNUM entnum, twobyte inci)
	Loads the data at the given entry number and inci.

bool	Reload () override
	Overridden Reload() method, that supports complex (mixed) data.

bool	SaveAs (ENTNUM entnum, twobyte inci)
	Saves the data at the given entry number and inci.

bool	LoadFirst () override
	Overloaded version of LoadFirst that will load the first inci for the entry. SetNoteEntry must be called first.

bool	LoadNext () override
	Overloaded version of LoadNext.

FCNoteEntry *	GetNoteEntry ()
	Returns a pointer to the mapped note entry.

twobyte	GetItemInci () const
	Returns the inci number for the stored object.

ENTNUM	GetItemEntryNumber () const
	Returns the note entry number for the stored object.

virtual bool	SaveNew ()
	Saves a new inci and sets the correct flag in the associated note entry.

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

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

virtual bool	LoadLast ()
	Loads the very last element in the database, if any.

virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any.

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
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 __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

Class for beam extensions (in Finale's Special Tools).

One object instance contains all the beam extensions for a note entry. (There should only be one FCBeamExtensionMod for each note entry.) The beam extension appears on the first the note entry of the beam.

Added in version 0.63.

Constructor & Destructor Documentation

◆ FCBeamExtensionMod()

FCBeamExtensionMod::FCBeamExtensionMod ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

const char * FCBeamExtensionMod::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 __FCEntryDetail.

◆ GetClassID()

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

◆ GetExtend()

bool FCBeamExtensionMod::GetExtend ( int beamindex ) const

inline

Returns true if the beam should extend.

Lua-supported.

Parameters

beamindex Beam number (0-9), 0 is the 8th note beam, 1 is the 16th note beam, 2 is the 32nd note beam, etc.

◆ GetExtend128th()

bool FCBeamExtensionMod::GetExtend128th ( ) const

inline

Returns if the 128th note beam should extend or not.

Lua-supported (also as property).

◆ GetExtend16th()

bool FCBeamExtensionMod::GetExtend16th ( ) const

inline

Returns if the 16th note beam should extend or not.

Lua-supported (also as property).

◆ GetExtend256th()

bool FCBeamExtensionMod::GetExtend256th ( ) const

inline

Returns if the 256th note beam should extend or not.

Lua-supported (also as property).

◆ GetExtend32nd()

bool FCBeamExtensionMod::GetExtend32nd ( ) const

inline

Returns if the 32nd note beam should extend or not.

Lua-supported (also as property).

◆ GetExtend64th()

bool FCBeamExtensionMod::GetExtend64th ( ) const

inline

Returns if the 64th note beam should extend or not.

Lua-supported (also as property).

◆ GetExtend8th()

bool FCBeamExtensionMod::GetExtend8th ( ) const

inline

Returns if the 16th note beam should extend or not.

Lua-supported (also as property).

◆ GetLeftAdjustment()

Evpu16 FCBeamExtensionMod::GetLeftAdjustment ( ) const

inline

Gets the left-side adjustment,.

Lua-supported (also as property).

◆ GetRightAdjustment()

Evpu16 FCBeamExtensionMod::GetRightAdjustment ( ) const

inline

Gets the right-side adjustment,.

Lua-supported (also as property).

◆ SetExtend()

void FCBeamExtensionMod::SetExtend	(	int	beamindex,
		bool	value )

inline

Sets if a beam should be extended.

Lua-supported.

Parameters

beamindex	Beam number (0-9), 0 is the 8th note beam, 1 is the 16th note beam, 2 is the 32nd note beam, etc.
value	If set, break the secondary beam.

◆ SetExtend128th()

void FCBeamExtensionMod::SetExtend128th ( bool state )

inline

Sets if the 128th note beam should extend or not.

Lua-supported (also as property).

◆ SetExtend16th()

void FCBeamExtensionMod::SetExtend16th ( bool state )

inline

Sets if the 16th note beam should extend or not.

Lua-supported (also as property).

◆ SetExtend256th()

void FCBeamExtensionMod::SetExtend256th ( bool state )

inline

Sets if the 256th note beam should extend or not.

Lua-supported (also as property).

◆ SetExtend32nd()

void FCBeamExtensionMod::SetExtend32nd ( bool state )

inline

Sets if the 32nd note beam should extend or not.

Lua-supported (also as property).

◆ SetExtend64th()

void FCBeamExtensionMod::SetExtend64th ( bool state )

inline

Sets if the 64th note beam should extend or not.

Lua-supported (also as property).

◆ SetExtend8th()

void FCBeamExtensionMod::SetExtend8th ( bool state )

inline

Sets if the 16th note beam should extend or not.

Lua-supported (also as property).

◆ SetExtendAll()

void FCBeamExtensionMod::SetExtendAll ( bool value )

inline

Sets if all beams should extend or not.

Lua-supported.

Parameters

value True to break the beam. False to remove the breaks.

◆ SetLeftAdjustment()

void FCBeamExtensionMod::SetLeftAdjustment ( Evpu16 adjust )

inline

Sets the left-side adjustment,.

Lua-supported (also as property).

◆ SetNoteEntry()

void FCBeamExtensionMod::SetNoteEntry ( FCNoteEntry * pEntry )

inlineoverridevirtual

Overridden method to assign a note entry with the data.

Reimplemented from __FCEntryDetail.

◆ SetRightAdjustment()

void FCBeamExtensionMod::SetRightAdjustment ( Evpu16 adjust )

inline

Sets the right-side adjustment,.

Lua-supported (also as property).

◆ UseUpStemData()

void FCBeamExtensionMod::UseUpStemData ( bool useupstem )

inline

Sets if upstem or downstem data should be loaded/saved. Finale stores upstem and downstem data in separate pools with different locator keys. It then applies one of them based on the current stem direction in the current view (for example, the part or the score).

Remarks: Normally this value is set automatically by SetNoteEntry using FCNoteEntry::CalcStemUp. However in certain circumstances, when you will be flipping or reversing stem directions, you may need to override the automatic setting. If you need to do so, call UseUpStemData immediately after calling SetNoteEntry and before calling any Load, Save, or Delete function.; Note that an entry can store data for both upstem and downstem. Entries can be displayed in contexts where they are upstem and other contexts where they are downstem, for example when displaying concert pitch versus transposed pitch or when displaying the entry in a part versus the score. The direction of the stem in context determines which version of FCBeamExtensionMod Finale displays.; Generally speaking, neither staff crossing nor stem reversal change the stem context for which FCBeamExtensionMod data Finale uses. This can lead to confusing situations. The first note of a beam with stems up can be crossed to a higher staff, and with stem reversal it appears to be down-stem. However, for the purposes of FCBeamExtensionMod it is still up-stem.

Lua-supported (0.74)

Parameters

useupstem True - use the data for stem up. False - use the data for stem down.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FCBeamExtensionMod()

Member Function Documentation

◆ ClassName()

◆ GetClassID()

◆ GetExtend()

◆ GetExtend128th()

◆ GetExtend16th()

◆ GetExtend256th()

◆ GetExtend32nd()

◆ GetExtend64th()

◆ GetExtend8th()

◆ GetLeftAdjustment()

◆ GetRightAdjustment()

◆ SetExtend()

◆ SetExtend128th()

◆ SetExtend16th()

◆ SetExtend256th()

◆ SetExtend32nd()

◆ SetExtend64th()

◆ SetExtend8th()

◆ SetExtendAll()

◆ SetLeftAdjustment()

◆ SetNoteEntry()

◆ SetRightAdjustment()

◆ UseUpStemData()