#include <ff_other.h>

Inheritance diagram for FCShapeDefInstructions:

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

FCShapeDefInstruction *	GetItemAt (int index) const
	Overridden version of GetItemAt(). More...

FCShapeDefInstruction *	AddNull ()
	Adds a Null instruction. More...

FCShapeDefInstruction *	AddStartObject (FCPoint pOrigin, FCPoint pBoundLeftTop, FCPoint *pBoundRightBottom, int xtransform=1000, int ytransform=1000, int rotation=0)
	Adds a StartObject instruction. More...

FCShapeDefInstruction *	AddStartGroup (FCPoint pOrigin, FCPoint pBoundLeftTop, FCPoint *pBoundRightBottom, int xtransform=1000, int ytransform=1000, int rotation=0)
	Adds a StartGroup instruction. All instructions in the group will transform according to the group. The group must end with an AddEndGroup instruction. More...

FCShapeDefInstruction *	AddEndGroup ()
	Adds a LineWidth instruction, which closes the group that was started with AddStartGroup.

FCShapeDefInstruction *	AddLineWidth (int linewidth)
	Adds a LineWidth instruction. More...

FCShapeDefInstruction *	AddSetGrey (int percent)
	Adds a SetGrey instruction. More...

FCShapeDefInstruction *	AddFillSolid ()
	Adds a FillSolid instruction, which fills the path. More...

FCShapeDefInstruction *	AddClosePath ()
	Adds a ClosePath instruction. More...

FCShapeDefInstruction *	AddEllipse (int width, int height)
	Adds an Ellipse instruction (draws a circle). More...

FCShapeDefInstruction *	AddRectangle (int width, int height)
	Adds an Rectangle instruction (draws a circle). More...

FCShapeDefInstruction *	AddCurveTo (int ctrlpt_height=72)
	Adds a standard CurveTo instruction. More...

FCShapeDefInstruction *	AddCurveToDetails (int x1, int y1, int x2, int y2, int endpt_x, int endpt_y)
	Adds a CurveTo instruction with all parameters set. More...

FCShapeDefInstruction *	AddSlur (int ctrlpt_height=72)
	Adds a standard Slur instruction. More...

FCShapeDefInstruction *	AddStroke ()
	Adds a Stroke instruction (which draws a path). More...

FCShapeDefInstruction *	AddSetDash (int dashlength, int spacebetween)
	Adds a SetDash instruction. More...

FCShapeDefInstruction *	AddRLineTo (int x, int y)
	Adds a RLineTo instruction (=relative line to). More...

FCShapeDefInstruction *	AddBracket (int brackettype)
	Adds a Bracket instruction. More...

FCShapeDefInstruction *	AddSolidLineStyle ()
	A shortcut method to add a SetDash(18, 0) instruction. More...

FCShapeDefInstruction *	AddRMoveTo (int x, int y)
	Adds a RMoveTo instruction (=relative move to). More...

FCShapeDefInstruction *	AddSetFont (FCFontInfo *pFontInfo)
	Adds a SetFont instruction. More...

FCShapeDefInstruction *	AddDrawChar (eUniChar16 character)
	Adds a DrawChar instruction. More...

FCShapeDefInstruction *	AddDrawChars (const char *pszString)
	Adds a string as a series of DrawChar instructions. This method doesn't support Unicode. More...

FCShapeDefInstruction *	AddDrawCharsString (FCString *pString)
	Adds a string as a series of DrawChar instructions from a FCString object. This method supports 16-bit Unicode if the running Finale version supports it. More...

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

virtual	~__FCCollection ()
	The virtual destructor, which deallocates the array and also all its elements. More...

int	GetCount () const
	Returns the number of elements of the collection. More...

void	Add (__FCBase *pNewItem)
	Adds an element to the end of the collection. More...

bool	UniqueAdd (__FCBase *pNewItem)
	Adds an element to the end of the collection, but only if it doesn't exist in the collection before. More...

void	InsertItemAt (__FCBase *pNewItem, int index)
	Inserts an item into the collection. More...

bool	ElementExists (__FCBase *pQueryItem)
	Returns true if the element is found in the collection, otherwise false.

void	ClearAll ()
	Destroys all the objects in the collection and empties the collection. More...

void	DetachAll ()
	Removes all the objects from the collection, without freeing/destroying the objects. More...

__FCBase *	GetItemAt (int index) const
	Returns the object at the index position. Index is 0-based. More...

__FCBase *	GetLastItem () const
	Returns the last item in the collection.

__FCBase *	operator[] (int index) const
	Identical to the GetItemAt method.

int	GetIndexOf (__FCBase *pObject) const
	Returns the 0-based order index for the object within the collection. More...

__FCBase *	DetachItemAt (int index)
	Removes the object at the index position. Index is 0-based. More...

bool	ClearItemAt (int index)
	Deletes the object at the index position and disposes the object. Index is 0-based. More...

int	ToEndFrom (int index, FCIteratorHandler *pIterator)
	Processes one element after another and iterates from one specific index to the end of the collection. More...

int	ForEach (FCIteratorHandler *pIterator) override
	Processes all elements in the collection (starting with item 0), or until the iterator Iterate() returns false. More...

virtual int	ForEachIndex (FCIteratorHandler *pIterator)
	Same as ForEach, but the IterateIndex callback of the iterator handler is used instead.

__FCBase *	FindFirst (FCIteratorHandler *pIterator) override
	Process elements until a match is found. More...

__FCBase *	FindUserData (void *data_to_find)
	Returns the first element in the collection that has the indicated userdata. More...

bool	Sort (FCIteratorHandler *pIterator)
	Sorts the elements of. More...

bool	Swap (int index1, int index2)
	Swaps to items in the collection. More...

bool	IsEmpty () const
	Returns true if the collection contains no elements. More...

int	MoveFrom (__FCCollection *pOtherCollection, bool unique=false)
	Moves elements from another collection into this collection. The other will be empty after the operation. More...

bool	IsIdentical (const __FCBase *pCompareObject) const override
	Returns true if two collections are considered to be identical. More...

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

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

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

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

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

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

void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string. More...

void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes. More...

int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax. More...

virtual void	DebugDataDump ()
	Outputs a memory dump of the data block in the object for debugging purposes. More...

virtual void	DebugDataByteArrayDump ()
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...

void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag. More...

void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask. More...

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

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

void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object. More...

void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object. More...

void *	GetUserData () const
	Gets the user data attached to the instance of an object. More...

void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object. More...

void	StoreXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file. More...

void	StoreXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int value)
	Helper function to store integer objects in the XML file. More...

void	StoreXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool value)
	Helper function to store boolean objects in the XML file. More...

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

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

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

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

virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data. More...

bool	ReadXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file. More...

bool	ReadXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int *pValue)
	Helper method to read integer objects from the XML file. More...

bool	ReadXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file. More...

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

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

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

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

virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data. More...

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

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

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

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

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

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

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

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

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

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

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

static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes. More...

Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.

Detailed Description

Helper class for FCShapeDef.

This class is created by FCShapeDef:CreateInstructions.

Supports <close> in Lua 5.4 (__FCCollection::ClearAll).

Member Function Documentation

◆ AddBracket()

FCShapeDefInstruction * FCShapeDefInstructions::AddBracket ( int brackettype )

inline

Adds a Bracket instruction.

Lua-supported.

Parameters

brackettype The bracket type number.

◆ AddClosePath()

FCShapeDefInstruction * FCShapeDefInstructions::AddClosePath ( )

inline

Adds a ClosePath instruction.

Lua-supported.

◆ AddCurveTo()

FCShapeDefInstruction * FCShapeDefInstructions::AddCurveTo ( int ctrlpt_height = 72 )

inline

Adds a standard CurveTo instruction.

NOTE: Since the Shape Designer seems to define all curveto instructions in an almost identical way and control the size and orientation of the curve through the StartObject instruction, this method contains no parameters except the height (the Shape Designer defaults are filled in).

Lua-supported.

Parameters

ctrlpt_height The bezier control point's y value, where 72 is the default in this case. A negative value would result in an inverted curve.

◆ AddCurveToDetails()

FCShapeDefInstruction * FCShapeDefInstructions::AddCurveToDetails	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	endpt_x,
		int	endpt_y
	)

inline

Adds a CurveTo instruction with all parameters set.

Here are the 90 degrees clockwise movements (at standard orientation):

Curve in bottom left corner: -72, 0, -72, 72, 0, 72
Curve in top left corner: 0, 72, 72, 72, 72, 0
Curve in top right corner: 72, 0, 72, -72, 0, -72
Curve in bottom right corner: 0, -72, -72, -72, -72, 0

Here are the 90 degrees counter-clockwise movements (at standard orientation):

Curve in bottom left corner: 0, -72, 72, -72, 72, 0
Curve in top left corner: -72, 0, -72, -72, 0, -72
Curve in top right corner: 0, 72, -72, 72, -72, 0
Curve in bottom right corner: 72, 0, 72, 72, 0, 72

Lua-supported.

Parameters

x1	x coord for ctrl outer control point
y1	y coord for ctrl outer control point
x2	x coord for destination point
y2	y coord for destination point
endpt_x	x coord for inner control point
endpt_y	y coord for inner control point

◆ AddDrawChar()

FCShapeDefInstruction * FCShapeDefInstructions::AddDrawChar ( eUniChar16 character )

Adds a DrawChar instruction.

On Finale 2012 and above, the Unicode character will be used. On earlier Finale versions, only the 8-bit character part will be used.

Lua-supported.

Parameters

character The font information object.

Returns: The created/added object.

◆ AddDrawChars()

FCShapeDefInstruction * FCShapeDefInstructions::AddDrawChars ( const char * pszString )

inline

Adds a string as a series of DrawChar instructions. This method doesn't support Unicode.

Lua-supported.

Parameters

pszString The C-style string.

Returns
The pointer to the last created/added DrawChar object. If pszString is NULL or empty, no object is created and NULL is returned.

◆ AddDrawCharsString()

FCShapeDefInstruction * FCShapeDefInstructions::AddDrawCharsString ( FCString * pString )

inline

Adds a string as a series of DrawChar instructions from a FCString object. This method supports 16-bit Unicode if the running Finale version supports it.

Lua-supported.

Parameters

pString The pointer to the FCString.

Returns
The pointer to the last created/added DrawChar object. If pszString is NULL or empty, no object is created and NULL is returned.

◆ AddEllipse()

FCShapeDefInstruction * FCShapeDefInstructions::AddEllipse	(	int	width,
		int	height
	)

inline

Adds an Ellipse instruction (draws a circle).

Lua-supported.

Parameters

width	Width of bounding rectangle, current point is lower left corner.
height	Height of bounding rectangle, current point is lower left corner.

◆ AddFillSolid()

FCShapeDefInstruction * FCShapeDefInstructions::AddFillSolid ( )

inline

Adds a FillSolid instruction, which fills the path.

Lua-supported.

◆ AddLineWidth()

FCShapeDefInstruction * FCShapeDefInstructions::AddLineWidth ( int linewidth )

inline

Adds a LineWidth instruction.

This instruction should be placed before any line drawing operation.

Lua-supported.

Parameters

linewidth The line thickness in EFIX.

◆ AddNull()

FCShapeDefInstruction * FCShapeDefInstructions::AddNull ( )

inline

Adds a Null instruction.

The Null instruction should ALWAYS be last in the instruction list.

Lua-supported.

◆ AddRectangle()

FCShapeDefInstruction * FCShapeDefInstructions::AddRectangle	(	int	width,
		int	height
	)

inline

Adds an Rectangle instruction (draws a circle).

Lua-supported.

Parameters

width	Width of bounding rectangle, current point is lower left corner.
height	Height of bounding rectangle, current point is lower left corner.

◆ AddRLineTo()

FCShapeDefInstruction * FCShapeDefInstructions::AddRLineTo	(	int	x,
		int	y
	)

inline

Adds a RLineTo instruction (=relative line to).

Lua-supported.

Parameters

x	The x position to draw to compared to the current position.
y	The t position to draw to compared to the current position.

◆ AddRMoveTo()

FCShapeDefInstruction * FCShapeDefInstructions::AddRMoveTo	(	int	x,
		int	y
	)

inline

Adds a RMoveTo instruction (=relative move to).

Lua-supported.

Parameters

x	The x position.
y	The y position.

◆ AddSetDash()

FCShapeDefInstruction * FCShapeDefInstructions::AddSetDash	(	int	dashlength,
		int	spacebetween
	)

inline

Adds a SetDash instruction.

Lua-supported.

Parameters

dashlength	The dash length. Set to 18 for solid lines.
spacebetween	The length between dashes. Set to 0 for solid lines.

◆ AddSetFont()

FCShapeDefInstruction * FCShapeDefInstructions::AddSetFont ( FCFontInfo * pFontInfo )

inline

Adds a SetFont instruction.

Lua-supported.

Parameters

pFontInfo The font information object.

Returns: The created/added object. If pFontInfo is NULL, no object is created and NULL is returned.

◆ AddSetGrey()

FCShapeDefInstruction * FCShapeDefInstructions::AddSetGrey ( int percent )

inline

Adds a SetGrey instruction.

Lua-supported.

Parameters

percent The grey value in percent (0-100). 100 is white. 0 is black.

◆ AddSlur()

FCShapeDefInstruction * FCShapeDefInstructions::AddSlur ( int ctrlpt_height = 72 )

inline

Adds a standard Slur instruction.

This works identical to the AddCurveTo method, except that a slur is used.

Lua-supported.

◆ AddSolidLineStyle()

FCShapeDefInstruction * FCShapeDefInstructions::AddSolidLineStyle ( )

inline

A shortcut method to add a SetDash(18, 0) instruction.

Lua-supported.

◆ AddStartGroup()

FCShapeDefInstruction * FCShapeDefInstructions::AddStartGroup	(	FCPoint *	pOrigin,
		FCPoint *	pBoundLeftTop,
		FCPoint *	pBoundRightBottom,
		int	xtransform = `1000`,
		int	ytransform = `1000`,
		int	rotation = `0`
	)

inline

Adds a StartGroup instruction. All instructions in the group will transform according to the group. The group must end with an AddEndGroup instruction.

Same parameters as for AddStartObject.

◆ AddStartObject()

FCShapeDefInstruction * FCShapeDefInstructions::AddStartObject	(	FCPoint *	pOrigin,
		FCPoint *	pBoundLeftTop,
		FCPoint *	pBoundRightBottom,
		int	xtransform = `1000`,
		int	ytransform = `1000`,
		int	rotation = `0`
	)

inline

Adds a StartObject instruction.

This instruction should always start an object in a shape.

Lua-supported.

Parameters

pOrigin	The x, y coordinate origin where the drawing starts.
pBoundLeftTop	The left, top boundary coordinate of the object.
pBoundRightBottom	The right bottom boundary coordinate of the object.
xtransform	The horizontal transformation factor * 1000. Should be 1000 for an untransformed object.
ytransform	The vertical transformation factor * 1000. Should be 1000 for an untransformed object.
rotation	The rotation transform value. (It seems like 90 degrees equals 1024.)

Returns: NULL if any of the point values are NULL. Otherwise, pointer to the created object.

◆ AddStroke()

FCShapeDefInstruction * FCShapeDefInstructions::AddStroke ( )

inline

Adds a Stroke instruction (which draws a path).

Lua-supported.

◆ ClassName()

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

◆ GetItemAt()

FCShapeDefInstruction * FCShapeDefInstructions::GetItemAt ( int index ) const

inline

Overridden version of GetItemAt().

Lua-supported.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddBracket()

◆ AddClosePath()

◆ AddCurveTo()

◆ AddCurveToDetails()

◆ AddDrawChar()

◆ AddDrawChars()

◆ AddDrawCharsString()

◆ AddEllipse()

◆ AddFillSolid()

◆ AddLineWidth()

◆ AddNull()

◆ AddRectangle()

◆ AddRLineTo()

◆ AddRMoveTo()

◆ AddSetDash()

◆ AddSetFont()

◆ AddSetGrey()

◆ AddSlur()

◆ AddSolidLineStyle()

◆ AddStartGroup()

◆ AddStartObject()

◆ AddStroke()

◆ ClassName()

◆ GetItemAt()