FCShapeDef Class Reference

Class for a shape definition (as in Finale's Shape selection dialog). More...

#include <ff_other.h>

Inheritance diagram for FCShapeDef:

Public Types
enum	SHAPEDEF_TYPES {   SHAPEDEFTYPE_UNKNOWN = -1 , SHAPEDEFTYPE_OTHER = 0 , SHAPEDEFTYPE_ARTICULATION = 1 , SHAPEDEFTYPE_BARLINE = 2 ,   SHAPEDEFTYPE_EXECUTABLESHAPE = 3 , SHAPEDEFTYPE_EXPRESSION = 4 , SHAPEDEFTYPE_NOTE = 5 , SHAPEDEFTYPE_FRAME = 6 ,   SHAPEDEFTYPE_ARROWHEAD = 7 , SHAPEDEFTYPE_FRETBOARD = 8 , SHAPEDEFTYPE_CLEF = 9 }
	The shape definition types, to be used with FCShapeDef::SaveNewWithType(), etc.
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
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.
	FCShapeDef ()
	The constructor.
bool	_GetIsEmptyShape ()
	For internal use.
bool	CalcProtected ()
	Returns true if the shape is marked as "protected" by Finale and shouldn't be deleted. (Is this really correct???)
bool	LoadFirst () override
	Different approach for loading first for shapes.
bool	DeleteData () override
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
bool	LoadNext () override
	Different approach for loading next for shapes.
bool	Load (CMPER itemno) override
	Loads the indicated item in a special way, since there's a crash bug when loading empty shapes, at least on earlier Finale versions.
SHAPEDEF_TYPES	GetType () const
	Returns the shape definition type.
bool	SaveNewWithType (SHAPEDEF_TYPES shapedeftype)
	Saves a new shape definition the with the SaveNew() method, but also saves the type of shape with the shape. This is the preferred approach to save new shapes.
bool	SaveWithType (SHAPEDEF_TYPES shapedeftype)
	Saves an existing shape definition with the Save() method, but also saves the type of shape with the shape. This is the preferred approach to save shapes.
fourbyte	GetDataCount () const
	Returns the number of elements in the data array.
fourbyte	GetInstructionsCount () const
	Returns the total number of elements in the instructions array.
ETAG	GetInstructionTag (int index)
	Returns the instruction tag at a certain index in the shape path.
int	GetInstructionSize (int index)
	Returns how many data blocks an instruction contains. (This is a fixed number based on the instruction tag.)
FCShapeDefInstructions *	CreateInstructions ()
	Creates a collection with all the instructions for the shape.
FCStrings *	CreateTextStrings ()
	Returns a string collection with all the texts in the shape.
bool	RebuildInstructions (FCShapeDefInstructions *pCollection)
	Rebuilds the shape data from a collection (containing all the instructions for the shape).
bool	GetFontInfo (int index, FCFontInfo *pFontInfo)
	Gets the font info from a "setfont" tag.
bool	SetFontInfo (int index, FCFontInfo *pFontInfo)
	Sets the font info to a "setfont" tag.
bool	ExportAsSVGFile (FCString *pFileName, float scaling, const char *pszUnit)
	Saves the shape as a SVG (Scalable Vector File) file. An existing file with the same full path will be overwritten.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
void	InstructionDebugDump (int instructionindex)
	Special "DebugDump" to get the elements within an instruction.
Public Member Functions inherited from __FCNoInciOther
	__FCNoInciOther ()
	The constructor.
bool	Reload () override
	Overridden Reload() method to support complex data types.
virtual bool	SaveAs (CMPER itemno)
	Saves the data under another item number. The object will now be connected to the new item number.
virtual bool	DeepSaveAs (CMPER itemno)
	Saves the data under another item number, but also makes a deep copy of the object.
bool	DeepDeleteData () override
	Deletes the data and all related data available in other data structures.
virtual bool	SaveNew ()
	Creates the data as completely new item number. The object will now be connected to the new item number.
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.
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).
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.
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	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 a shape definition (as in Finale's Shape selection dialog).

For saving new objects, try to always use SaveNewWithType() to specify the type of shape that the shape is.

Please note that Finale (as in Fin2012 and earlier versions at least) has a big problem when loading empty shapes, which causes crashes. Different workarounds exist in this class to fix that. The workaround is that an empty shape can NEVER be accessed in any way by the 'special' shape tag. (The tag __ot_Shape_WORKAROUNDTAG is used as part of the workaround.)

Member Function Documentation

_GetIsEmptyShape()

bool FCShapeDef::_GetIsEmptyShape ( )

inline

For internal use.

Returns the empty-shape status.

ClassName()

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

CreateInstructions()

FCShapeDefInstructions * FCShapeDef::CreateInstructions

(

)

Creates a collection with all the instructions for the shape.

The caller must delete the returned object from the heap after use.

Lua-supported.

Returns

The pointer to the created object. Must be deleted from the heap after use.

CreateTextStrings()

FCStrings * FCShapeDef::CreateTextStrings

(

)

Returns a string collection with all the texts in the shape.

The current instructions in the shape data is scanned. Subsequent "drawchar" instructions (without any other instructions inbetween) are considered to be part of the same text string.

It's the caller's responsibility to delete the collection from the heap after use.

Lua-supported.

Returns

NULL if no text were found in the shape. Otherwise, a new FCStrings collection with all the texts found in the shape.

DebugDump()

void FCShapeDef::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.

DeleteData()

bool FCShapeDef::DeleteData ( )

inlineoverridevirtual

Deletes the associated data from Finale's database. Be careful when deleting multiple objects.

When deleting multiple objects, Finale's data table might get rearranged after each delete. For safety always delete multiple objects backwards.

Returns

True if delete was successful.

Reimplemented from __FCBaseData.

ExportAsSVGFile()

bool FCShapeDef::ExportAsSVGFile	(	FCString *	pFileName,
		float	scaling,
		const char *	pszUnit )

Saves the shape as a SVG (Scalable Vector File) file. An existing file with the same full path will be overwritten.

This method only works on Finale 25 and later versions. Finale saves the shape as a v1.1 SVG file.

Parameters

pFileName	Full path to the SVG file name where the shape should be saved.
scaling	The scaling factor of the SVG file. A scaling of 1.00 means normal scaling.
pszUnit	A pointer to a C-style string that contains the unit suffix. This can be NULL (for no defined unit) or any of these unit abbreviations: "em", "ex", "px", "pt", "pc", "cm", "mm", "in"

Returns

True on success. Always false in Finale versions earlier than Finale 25.

GetClassID()

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

GetDataCount()

fourbyte FCShapeDef::GetDataCount ( ) const

inline

Returns the number of elements in the data array.

Lua-supported (also as read-only property).

GetFontInfo()

bool FCShapeDef::GetFontInfo	(	int	index,
		FCFontInfo *	pFontInfo )

Gets the font info from a "setfont" tag.

Parameters

index	0-based index to the instruction.
pFontInfo	Pointer to the font info class.

Returns

True on success.

GetInstructionsCount()

fourbyte FCShapeDef::GetInstructionsCount ( ) const

inline

Returns the total number of elements in the instructions array.

Returns

Returns -1 on internal failure (=don't save any data back to Finale!). Otherwise, it's the number of instructions in the shape path.

Lua-supported (also as read-only property.

GetInstructionTag()

ETAG FCShapeDef::GetInstructionTag ( int index )

inline

Returns the instruction tag at a certain index in the shape path.

Parameters

index

0-based index to the instruction.

Returns

0 on index error. Otherwise, any of the st_ defines in shapetag.h of the PDK.

GetType()

SHAPEDEF_TYPES FCShapeDef::GetType ( ) const

inline

Returns the shape definition type.

The shape definition type specifies which kind of tool that created the shape. For some selection boxes (such as for arrowheads), it's also used as a filter.

Lua-supported (also as a read-only property).

Returns

If there is no loaded data, the special return value SHAPEDEFTYPE_UNKNOWN is returned. Otherwise, any of the valid SHAPEDEFTYPE_ constants, such as SHAPEDEFTYPE_EXPRESSION, SHAPEDEFTYPE_ARTICULATION, SHAPEDEFTYPE_ARROWHEAD, etc.

Load()

bool FCShapeDef::Load ( CMPER itemno )

inlineoverridevirtual

Loads the indicated item in a special way, since there's a crash bug when loading empty shapes, at least on earlier Finale versions.

Reimplemented from __FCNoInciOther.

LoadFirst()

bool FCShapeDef::LoadFirst ( )

inlineoverridevirtual

Different approach for loading first for shapes.

Reimplemented from __FCNoInciOther.

LoadNext()

bool FCShapeDef::LoadNext ( )

inlineoverridevirtual

Different approach for loading next for shapes.

Reimplemented from __FCBaseData.

RebuildInstructions()

bool FCShapeDef::RebuildInstructions

(

FCShapeDefInstructions *

pCollection

)

Rebuilds the shape data from a collection (containing all the instructions for the shape).

Any old shape data is deleted.

Lua-supported.

SaveNewWithType()

bool FCShapeDef::SaveNewWithType ( SHAPEDEF_TYPES shapedeftype )

inline

Saves a new shape definition the with the SaveNew() method, but also saves the type of shape with the shape. This is the preferred approach to save new shapes.

Parameters

shapedeftype

Any of the SHAPEDEFTYPE_ constants, such as SHAPEDEFTYPE_EXPRESSION, SHAPEDEFTYPE_ARTICULATION, SHAPEDEFTYPE_ARROWHEAD, etc.

Returns

True on a successful save.

SaveWithType()

bool FCShapeDef::SaveWithType ( SHAPEDEF_TYPES shapedeftype )

inline

Saves an existing shape definition with the Save() method, but also saves the type of shape with the shape. This is the preferred approach to save shapes.

Lua-supported.

Parameters

shapedeftype

Any of the SHAPEDEFTYPE_ constants, such as SHAPEDEFTYPE_EXPRESSION, SHAPEDEFTYPE_ARTICULATION, SHAPEDEFTYPE_ARROWHEAD, etc.

Returns

True on a successful save.

SetFontInfo()

bool FCShapeDef::SetFontInfo	(	int	index,
		FCFontInfo *	pFontInfo )

Sets the font info to a "setfont" tag.

Parameters

index	0-based index to the instruction.
pFontInfo	Pointer to the font info class.

Returns

True on success.