Finale PDK Framework 0.77
Power Up Your Finale Music Software
|
Helper class for FCSmartShape, controlling the end points of a smart shape. This class is only constructed indirectly by the FCSmartShape.GetTerminateSegmentLeft and FCSmartShape.GetTerminateSegmentRight() methods. More...
#include <ff_smartshapes.h>
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. | |
FCSmartShapeSegment (__SSTERMSEG *pSeg, FCSmartShape *pReference, bool leftsidesegment) | |
The constructor. Called by the FCSmartShape class. | |
twobyte | GetStaff () const |
Returns the staff of the end point segment. | |
twobyte | GetMeasure () const |
Returns the measure of the end point segment. | |
twobyte | GetNoteID () const |
Returns the note ID for the smart shape segment. | |
TimeEdu32 | GetMeasurePos () const |
Returns the measure position for measure-attached shapes. | |
ENTNUM | GetEntryNumber () const |
Returns the note entry number for entry-attached shapes. | |
twobyte | GetEndpointOffsetX () const |
Returns the horizontal offset compared to the measure attachment position. | |
twobyte | GetEndpointOffsetY () const |
Returns the vertical offset compared to the measure attachment position. | |
twobyte | GetControlPoint1OffsetX () const |
Returns the horizontal offset for the first control point (for slurs). | |
twobyte | GetControlPoint1OffsetY () const |
Returns the vertical offset for the first control point (for slurs). | |
twobyte | GetControlPoint2OffsetX () const |
Returns the horizontal offset for the second control point (for slurs). | |
twobyte | GetControlPoint2OffsetY () const |
Returns the vertical offset for the second control point (for slurs). | |
twobyte | GetBreakOffsetX () const |
Returns the horizontal break offset. | |
twobyte | GetBreakOffsetY () const |
Returns the vertical break offset. | |
void | SetStaff (twobyte staff) |
Sets the staff of the end point segment. | |
void | SetMeasure (twobyte measureno) |
Sets the measure number for the smart shape end point. | |
void | SetNoteID (twobyte noteID) |
Sets the note ID for the segment. | |
void | SetMeasurePos (TimeEdu32 edupos) |
Sets the measure position for measure-attached shapes. | |
void | SetEndpointOffsetX (twobyte value) |
Sets the horizontal offset, compared to the measure attachment position. | |
void | SetEndpointOffsetY (twobyte value) |
Sets the vertical offset, compared to the measure attachment position. | |
void | SetControlPoint1OffsetX (twobyte value) |
Sets the horizontal offset for the first control point (for slurs). | |
void | SetControlPoint1OffsetY (twobyte value) |
Sets the vertical offset for the first control point (for slurs). | |
void | SetControlPoint2OffsetX (twobyte value) |
Sets the horizontal offset for the second control point (for slurs). | |
void | SetControlPoint2OffsetY (twobyte value) |
Sets the vertical offset for the second control point (for slurs). | |
void | SetBreakOffsetX (twobyte value) |
Sets the horizontal break offset. | |
void | SetBreakOffsetY (twobyte value) |
Sets the vertical break offset. | |
void | SetEntryNumber (ENTNUM value) |
Sets the note entry reference number for the end connection point. | |
void | SetEntry (FCNoteEntry *pEntry) |
Connects the entry number to the smart shape end point and sets the smart shape flag for the entry. | |
void | SetCustomOffset (bool rightside) |
Sets the required flags for a custom positioned end segment position. | |
TimeEdu32 | CalcMeasurePos () const |
Calculates the measure position of the endpoint. Works with both measure- and entry-attached smart shapes. | |
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. | |
Helper class for FCSmartShape, controlling the end points of a smart shape. This class is only constructed indirectly by the FCSmartShape.GetTerminateSegmentLeft and FCSmartShape.GetTerminateSegmentRight() methods.
TimeEdu32 FCSmartShapeSegment::CalcMeasurePos | ( | ) | const |
Calculates the measure position of the endpoint. Works with both measure- and entry-attached smart shapes.
Lua-supported (0.68).
|
inlineoverridevirtual |
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
Lua-supported.
Implements __FCBase.
|
overridevirtual |
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 __FCBase.
|
inline |
Returns the horizontal break offset.
Lua-supported (also as property).
|
inline |
Returns the vertical break offset.
Lua-supported (also as property).
|
inline |
Returns the horizontal offset for the first control point (for slurs).
Lua-supported (also as property).
|
inline |
Returns the vertical offset for the first control point (for slurs).
Lua-supported (also as property).
|
inline |
Returns the horizontal offset for the second control point (for slurs).
Lua-supported (also as property).
|
inline |
Returns the vertical offset for the second control point (for slurs).
Lua-supported (also as property).
|
inline |
Returns the horizontal offset compared to the measure attachment position.
For Finale 2014 and above, this controls the offset compared to the anchor point for measure-attached smart shapes.
Lua-supported (also as property).
|
inline |
Returns the vertical offset compared to the measure attachment position.
Lua-supported (also as property).
|
inline |
Returns the note entry number for entry-attached shapes.
Lua-supported (also as property).
|
inline |
Returns the measure of the end point segment.
Lua-supported (also as property).
|
inline |
Returns the measure position for measure-attached shapes.
Consider using CalcMeasurePos instead of this function. It calculates the correct measure position of any smart shape segment, regardless of attachment type.
Lua-supported (also as property).
twobyte FCSmartShapeSegment::GetNoteID | ( | ) | const |
Returns the note ID for the smart shape segment.
Lua-supported (also as property).
|
inline |
Returns the staff of the end point segment.
Lua-supported (also as property).
|
inline |
Sets the horizontal break offset.
Lua-supported (also as property).
|
inline |
Sets the vertical break offset.
Lua-supported (also as property).
|
inline |
Sets the horizontal offset for the first control point (for slurs).
Lua-supported (also as property).
|
inline |
Sets the vertical offset for the first control point (for slurs).
Lua-supported (also as property).
|
inline |
Sets the horizontal offset for the second control point (for slurs).
Lua-supported (also as property).
|
inline |
Sets the vertical offset for the second control point (for slurs).
Lua-supported (also as property).
|
inline |
Sets the required flags for a custom positioned end segment position.
Lua-supported.
rightside | If true, the right-side offset adjustment of a smartshape. If false, the left-side offset adjustment. |
|
inline |
Sets the horizontal offset, compared to the measure attachment position.
For Finale 2014 and above, this controls the offset compared to the anchor point for measure-attached smart shapes.
This method only has a visible effect when custom offsets where enabled for this segment using #SetCustomOffset().
Lua-supported (also as property).
|
inline |
Sets the vertical offset, compared to the measure attachment position.
This method only has a visible effect when custom offsets where enabled for this segment using SetCustomOffset().
Lua-supported (also as property).
|
inline |
Connects the entry number to the smart shape end point and sets the smart shape flag for the entry.
This does not assign the measure number to the smart shape end point.
Lua-supported.
pEntry | If NULL, it sets the entry reference number to 0. Otherwise, it sets the entry reference number for the end point and set's the entry's smart shape flag. |
|
inline |
Sets the note entry reference number for the end connection point.
Lua-supported (also as property).
|
inline |
Sets the measure number for the smart shape end point.
Lua-supported (also as property).
|
inline |
Sets the measure position for measure-attached shapes.
Lua-supported (also as property).
|
inline |
Sets the staff of the end point segment.
Lua-supported (also as property).