Class for attaching an articulation definition to an entry. More...

#include <ff_entrydetails.h>

Inheritance diagram for FCArticulation:

Public Types
enum	PLACEMENTMODE { ARTICPLACEMENT_AUTOMATIC = 0 , ARTICPLACEMENT_ABOVE , ARTICPLACEMENT_BELOW }
	The settings for flipped, above, below. More...

enum	STACKINGMODE { ARTICSTACKING_USEDEFINITION = 0 , ARTICSTACKING_NEVER }
	The settings for stacking for this assignment. 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_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
EXTAG	Tag () const override
	The Enigma tag for the derived class.

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.

	FCArticulation ()
	The constructor.

void	SetArticulationDef (FCArticulationDef *pDef)
	Assigns an articulation definition to the articulation instance.

void	SetID (CMPER cmper)
	Sets the (1-based) articulation definition ID.

void	SetHorizontalPos (Evpu16 pos)
	Sets the horizontal position.

void	SetHorizontalCopyToPos (Evpu16 pos)
	Sets the point to which a cloned mark extends horizontally, measured from GetHorizontalPos.

void	SetVerticalPos (Evpu16 pos)
	Sets the vertical position.

void	SetVerticalCopyToPos (Evpu16 pos)
	Sets the point to which a cloned mark extends vertically, measured from the lowest note.

bool	GetVisible () const
	Returns the visibility state of the articulation.

void	SetVisible (bool state)
	Sets the visibility state of the articulation.

STACKINGMODE	GetStackingMode () const
	Returns the stacking mode of the articulation.

void	SetStackingMode (STACKINGMODE value)
	Sets the stackable state of the articulation.

PLACEMENTMODE	GetPlacementMode () const
	Gets the setting for where the articulation should be placed compared to the note entry.

void	SetPlacementMode (PLACEMENTMODE value)
	Sets where the articulation should be placed compared to the note entry.

Evpu16	GetHorizontalPos () const
	Returns the horizontal position.

Evpu16	GetHorizontalCopyToPos () const
	Returns the point to which a cloned mark extends horizontal, measured from GetHorizontalPos.

Evpu16	GetVerticalPos () const
	Returns the vertical position.

Evpu16	GetVerticalCopyToPos () const
	Returns the point to which a cloned mark extends vertically, measured from the lowest note.

twobyte	GetID () const
	Returns the (1-based) articulation definition ID.

FCArticulationDef *	CreateArticulationDef ()
	Creates a articulation definition object for the articulation.

bool	CalcMetricPos (FCPoint *pPoint)
	Calculate the metric position for an articulation.

bool	CalcFlippedSymbolUsed ()
	Returns true if the flipped version of the articulation is used (based on the entry metrics).

void	ResetPos (FCArticulationDef *pDef)
	Resets the articulation positioning based on the articulation definition. This method does not support the "Center horizontally" option on versions of Finale before Finale 26.

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

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.

virtual void	SetNoteEntry (FCNoteEntry *pEntry)
	Maps the data to an entry.

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.

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 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
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 attaching an articulation definition to an entry.

This class requires PDK_FRAMEWORK_ENTRIES to be defined.

Todo: implement property for EDTARTIC_ASSIGN_AVOID_SLUR if Finale ever adds it to the UI.

Member Enumeration Documentation

◆ PLACEMENTMODE

enum FCArticulation::PLACEMENTMODE

The settings for flipped, above, below.

Lua-supported (0.58).

◆ STACKINGMODE

enum FCArticulation::STACKINGMODE

The settings for stacking for this assignment.

Lua-supported (0.58).

Constructor & Destructor Documentation

◆ FCArticulation()

FCArticulation::FCArticulation ( )

The constructor.

Lua-supported.

Member Function Documentation

◆ CalcFlippedSymbolUsed()

bool FCArticulation::CalcFlippedSymbolUsed ( )

Returns true if the flipped version of the articulation is used (based on the entry metrics).

This method requires that SetNoteEntry() has been called before the call.

Lua-supported.

◆ CalcMetricPos()

bool FCArticulation::CalcMetricPos ( FCPoint * pPoint )

Calculate the metric position for an articulation.

Lua-supported.

Returns: True on success.

◆ ClassName()

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

◆ CreateArticulationDef()

FCArticulationDef * FCArticulation::CreateArticulationDef ( )

Creates a articulation definition object for the articulation.

Lua-supported.

Returns: The created articulation definition object. This object must be deleted from the heap after use.

◆ DebugDump()

void FCArticulation::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 __FCEntryDetail.

◆ GetClassID()

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

◆ GetHorizontalCopyToPos()

Evpu16 FCArticulation::GetHorizontalCopyToPos ( ) const

inline

Returns the point to which a cloned mark extends horizontal, measured from GetHorizontalPos.

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

◆ GetHorizontalPos()

Evpu16 FCArticulation::GetHorizontalPos ( ) const

inline

Returns the horizontal position.

Lua-supported (also as property).

◆ GetID()

twobyte FCArticulation::GetID ( ) const

inline

Returns the (1-based) articulation definition ID.

To set the definition ID, use the SetArticulationDef method.

Lua-supported (also as property).

Returns: The 1-based index in the document's lists of articulations.

◆ GetPlacementMode()

FCArticulation::PLACEMENTMODE FCArticulation::GetPlacementMode ( ) const

Gets the setting for where the articulation should be placed compared to the note entry.

Can be any of these constants: ARTICPLACEMENT_AUTOMATIC, ARTICPLACEMENT_ABOVE, ARTICPLACEMENT_BELOW

Only works on Finale 26 and later.

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

◆ GetStackingMode()

FCArticulation::STACKINGMODE FCArticulation::GetStackingMode ( ) const

Returns the stacking mode of the articulation.

Can be either of these constants: ARTICSTACKING_USEDEFINITION, ARTICSTACKING_NEVER

Only works on Finale 26 and later.

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

◆ GetVerticalCopyToPos()

Evpu16 FCArticulation::GetVerticalCopyToPos ( ) const

inline

Returns the point to which a cloned mark extends vertically, measured from the lowest note.

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

◆ GetVerticalPos()

Evpu16 FCArticulation::GetVerticalPos ( ) const

inline

Returns the vertical position.

Lua-supported (also as property).

◆ GetVisible()

bool FCArticulation::GetVisible ( ) const

Returns the visibility state of the articulation.

Only works on 2014b and later.

Lua-supported (also as property).

◆ ResetPos()

void FCArticulation::ResetPos ( FCArticulationDef * pDef )

Resets the articulation positioning based on the articulation definition. This method does not support the "Center horizontally" option on versions of Finale before Finale 26.

Lua-supported.

◆ SetArticulationDef()

void FCArticulation::SetArticulationDef ( FCArticulationDef * pDef )

Assigns an articulation definition to the articulation instance.

Lua-supported.

Parameters

pDef	The articulation definition. If it's NULL, nothing will be assigned.

◆ SetHorizontalCopyToPos()

void FCArticulation::SetHorizontalCopyToPos ( Evpu16 pos )

inline

Sets the point to which a cloned mark extends horizontally, measured from GetHorizontalPos.

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

◆ SetHorizontalPos()

void FCArticulation::SetHorizontalPos ( Evpu16 pos )

inline

Sets the horizontal position.

Lua-supported (also as property).

◆ SetID()

void FCArticulation::SetID ( CMPER cmper )

inline

Sets the (1-based) articulation definition ID.

Avoid using this whenever possible. Instead, use the SetArticulationDef method. This is particularly important starting with Finale 26, because SetArticulationDef sets up some internal state for the automatic stacking and slur avoidance features.

Lua-supported (also as property).

◆ SetPlacementMode()

void FCArticulation::SetPlacementMode ( FCArticulation::PLACEMENTMODE value )

Sets where the articulation should be placed compared to the note entry.

Can be any of these constants: ARTICPLACEMENT_AUTOMATIC, ARTICPLACEMENT_ABOVE, ARTICPLACEMENT_BELOW

Only works on Finale 26 and later.

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

◆ SetStackingMode()

void FCArticulation::SetStackingMode ( FCArticulation::STACKINGMODE value )

Sets the stackable state of the articulation.

Can be either of these constants: ARTICSTACKING_USEDEFINITION, ARTICSTACKING_NEVER

Only works on Finale 26 and later.

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

◆ SetVerticalCopyToPos()

void FCArticulation::SetVerticalCopyToPos ( Evpu16 pos )

inline

Sets the point to which a cloned mark extends vertically, measured from the lowest note.

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

◆ SetVerticalPos()

void FCArticulation::SetVerticalPos ( Evpu16 pos )

inline

Sets the vertical position.

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

◆ SetVisible()

void FCArticulation::SetVisible ( bool state )

Sets the visibility state of the articulation.

Only works on 2014b and later.

Lua-supported (also as property).

◆ Tag()

EXTAG FCArticulation::Tag ( ) const

inlineoverridevirtual

The Enigma tag for the derived class.

(Have this public so it's possible to query from the outside world.)

Implements __FCBaseData.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PLACEMENTMODE

◆ STACKINGMODE

Constructor & Destructor Documentation

◆ FCArticulation()

Member Function Documentation

◆ CalcFlippedSymbolUsed()

◆ CalcMetricPos()

◆ ClassName()

◆ CreateArticulationDef()

◆ DebugDump()

◆ GetClassID()

◆ GetHorizontalCopyToPos()

◆ GetHorizontalPos()

◆ GetID()

◆ GetPlacementMode()

◆ GetStackingMode()

◆ GetVerticalCopyToPos()

◆ GetVerticalPos()

◆ GetVisible()

◆ ResetPos()

◆ SetArticulationDef()

◆ SetHorizontalCopyToPos()

◆ SetHorizontalPos()

◆ SetID()

◆ SetPlacementMode()

◆ SetStackingMode()

◆ SetVerticalCopyToPos()

◆ SetVerticalPos()

◆ SetVisible()

◆ Tag()