The 4 (short, medium, long, tie ends) tie contour definitions. More...

#include <ff_prefs.h>

Inheritance diagram for FCTieContourPrefs:

Public Types
enum	CONTOUR_INDEXES { TCONTOURIDX_SHORT = 0 , TCONTOURIDX_MEDIUM = 1 , TCONTOURIDX_LONG = 2 , TCONTOURIDX_TIEENDS = 3 }
	The index constants for all methods in FCTieContourPrefs. 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
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...

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

	FCTieContourPrefs ()
	The constructor. More...

Evpu16	GetSpan (CONTOUR_INDEXES index) const
	Returns the horizontal span value for the contour definition. More...

float	GetLeftRelativeInset (CONTOUR_INDEXES index) const
	Returns the left-side inset, as percent. More...

Evpu16	GetLeftRawRelativeInset (CONTOUR_INDEXES index) const
	Returns the left-side inset, as raw value (percent * 2048). More...

Evpu16	GetLeftHeight (CONTOUR_INDEXES index) const
	Returns the left-side height. More...

Evpu16	GetLeftFixedInset (CONTOUR_INDEXES index) const
	Returns the left-side inset, as an absolute value. More...

float	GetRightRelativeInset (CONTOUR_INDEXES index) const
	Returns the right-side inset, as percent. More...

Evpu16	GetRightRawRelativeInset (CONTOUR_INDEXES index) const
	Returns the right-side inset, as raw value (percent * 2048). More...

Evpu16	GetRightHeight (CONTOUR_INDEXES index) const
	Returns the right-side height. More...

Evpu16	GetRightFixedInset (CONTOUR_INDEXES index) const
	Returns the right-side inset, as an absolute value. More...

void	SetSpan (CONTOUR_INDEXES index, Evpu16 value)
	Sets the horizontal span value for the contour definition. More...

void	SetLeftRelativeInset (CONTOUR_INDEXES index, float percentvalue)
	Sets the left-side inset, as percent. More...

void	SetLeftRawRelativeInset (CONTOUR_INDEXES index, Evpu16 rawvalue)
	Sets the left-side inset, as raw value. More...

void	SetLeftHeight (CONTOUR_INDEXES index, Evpu16 value)
	Sets the left-side height. More...

void	SetLeftFixedInset (CONTOUR_INDEXES index, Evpu16 value)
	Sets the left-side inset, as an absolute value. More...

void	SetRightRelativeInset (CONTOUR_INDEXES index, float percentvalue)
	Sets the right-side inset, as percent. More...

void	SetRightRawRelativeInset (CONTOUR_INDEXES index, Evpu16 rawvalue)
	Sets the right-side inset, as raw value. More...

void	SetRightHeight (CONTOUR_INDEXES index, Evpu16 value)
	Sets the right-side height. More...

void	SetRightFixedInset (CONTOUR_INDEXES index, Evpu16 value)
	Sets the right-side inset, as an absolute value. More...

Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	Overridden version of Reload(), that handles prefs from multiple sources. More...

virtual bool	Load (twobyte prefsno=1)
	The default Load method for preference data. All preference data loading must go through here at some point. More...

bool	Save () override
	Saves the currently loaded to its current location. More...

bool	LoadFirst () override
	Loads the very first element in the database, if any. More...

int	GetItemNo () const
	Returns the prefs number for the loaded data. More...

Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data. More...

bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID. More...

virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations. More...

virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created. More...

void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object. More...

const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation. More...

int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation. More...

const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation. More...

EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any. More...

void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...

	__FCBaseData ()
	The constructor.

virtual	~__FCBaseData ()
	Virtual destructor.

virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...

virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object. More...

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

virtual bool	LoadNext ()
	Loads the next element from the database, if any. More...

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

bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match. More...

bool	RelinkToScore ()
	Relinks all parts to the contents of the score. More...

__FCBaseData *	CreateClone ()
	Creates an identical copy of an object. More...

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

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

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

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

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

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

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. 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
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 __FCPrefsBase
	__FCPrefsBase ()
	standard constructor

Protected Member Functions inherited from __FCBaseData
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! More...

bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.

void	_TagDocumentID ()
	For internal use only. More...

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

EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

The 4 (short, medium, long, tie ends) tie contour definitions.

Starting with Finale 26.2, it is no longer possible to Load or Save this class directly. Instead use FCTiePrefs::CreateTieContourPrefs and FCTiePrefs::SaveTieContourPrefs to load and save this class. These newer functions work on any supported Finale version.

Member Enumeration Documentation

◆ CONTOUR_INDEXES

enum FCTieContourPrefs::CONTOUR_INDEXES

The index constants for all methods in FCTieContourPrefs.

Lua-supported.

Enumerator
TCONTOURIDX_SHORT	Short tie spans
TCONTOURIDX_MEDIUM	Medium tie spans
TCONTOURIDX_LONG	Long tie spans
TCONTOURIDX_TIEENDS	Tie ends

Constructor & Destructor Documentation

◆ FCTieContourPrefs()

FCTieContourPrefs::FCTieContourPrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

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

◆ GetClassID()

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

◆ GetLeftFixedInset()

Evpu16 FCTieContourPrefs::GetLeftFixedInset ( CONTOUR_INDEXES index ) const

inline

Returns the left-side inset, as an absolute value.

Lua-supported.

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ GetLeftHeight()

Evpu16 FCTieContourPrefs::GetLeftHeight ( CONTOUR_INDEXES index ) const

inline

Returns the left-side height.

Lua-supported.

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ GetLeftRawRelativeInset()

Evpu16 FCTieContourPrefs::GetLeftRawRelativeInset ( CONTOUR_INDEXES index ) const

inline

Returns the left-side inset, as raw value (percent * 2048).

Lua-supported.

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ GetLeftRelativeInset()

float FCTieContourPrefs::GetLeftRelativeInset ( CONTOUR_INDEXES index ) const

inline

Returns the left-side inset, as percent.

Lua-supported.

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ GetRightFixedInset()

Evpu16 FCTieContourPrefs::GetRightFixedInset ( CONTOUR_INDEXES index ) const

inline

Returns the right-side inset, as an absolute value.

Lua-supported.

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ GetRightHeight()

Evpu16 FCTieContourPrefs::GetRightHeight ( CONTOUR_INDEXES index ) const

inline

Returns the right-side height.

Lua-supported.

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ GetRightRawRelativeInset()

Evpu16 FCTieContourPrefs::GetRightRawRelativeInset ( CONTOUR_INDEXES index ) const

inline

Returns the right-side inset, as raw value (percent * 2048).

Lua-supported (0.62).

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ GetRightRelativeInset()

float FCTieContourPrefs::GetRightRelativeInset ( CONTOUR_INDEXES index ) const

inline

Returns the right-side inset, as percent.

Lua-supported.

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ GetSpan()

Evpu16 FCTieContourPrefs::GetSpan ( CONTOUR_INDEXES index ) const

inline

Returns the horizontal span value for the contour definition.

Lua-supported.

Parameters

[in] index Any of the TCONTOURIDX_ constants.

◆ SetLeftFixedInset()

void FCTieContourPrefs::SetLeftFixedInset	(	CONTOUR_INDEXES	index,
		Evpu16	value
	)

inline

Sets the left-side inset, as an absolute value.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	value	The left-side (tie start) inset in EVPUs.

◆ SetLeftHeight()

void FCTieContourPrefs::SetLeftHeight	(	CONTOUR_INDEXES	index,
		Evpu16	value
	)

inline

Sets the left-side height.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	value	The left-side (tie start) height in EVPUs.

◆ SetLeftRawRelativeInset()

void FCTieContourPrefs::SetLeftRawRelativeInset	(	CONTOUR_INDEXES	index,
		Evpu16	rawvalue
	)

inline

Sets the left-side inset, as raw value.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	rawvalue	The relative left-side (tie start) inset as a raw value (percent * 2048).

◆ SetLeftRelativeInset()

void FCTieContourPrefs::SetLeftRelativeInset	(	CONTOUR_INDEXES	index,
		float	percentvalue
	)

inline

Sets the left-side inset, as percent.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	percentvalue	The relative left-side (tie start) inset as a floating point value.

◆ SetRightFixedInset()

void FCTieContourPrefs::SetRightFixedInset	(	CONTOUR_INDEXES	index,
		Evpu16	value
	)

inline

Sets the right-side inset, as an absolute value.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	value	The right-side (tie end) inset in EVPUs.

◆ SetRightHeight()

void FCTieContourPrefs::SetRightHeight	(	CONTOUR_INDEXES	index,
		Evpu16	value
	)

inline

Sets the right-side height.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	value	The right-side (tie end) height in EVPUs.

◆ SetRightRawRelativeInset()

void FCTieContourPrefs::SetRightRawRelativeInset	(	CONTOUR_INDEXES	index,
		Evpu16	rawvalue
	)

inline

Sets the right-side inset, as raw value.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	rawvalue	The relative right-side (tie end) inset as a raw value (percent * 2048).

◆ SetRightRelativeInset()

void FCTieContourPrefs::SetRightRelativeInset	(	CONTOUR_INDEXES	index,
		float	percentvalue
	)

inline

Sets the right-side inset, as percent.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	percentvalue	The relative right-side (tie end) inset as a floating point value.

◆ SetSpan()

void FCTieContourPrefs::SetSpan	(	CONTOUR_INDEXES	index,
		Evpu16	value
	)

inline

Sets the horizontal span value for the contour definition.

Lua-supported.

Parameters

[in]	index	Any of the TCONTOURIDX_ constants.
[in]	value	The horizontal span value for the contour definition.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CONTOUR_INDEXES

Constructor & Destructor Documentation

◆ FCTieContourPrefs()

Member Function Documentation

◆ ClassName()

◆ GetClassID()

◆ GetLeftFixedInset()

◆ GetLeftHeight()

◆ GetLeftRawRelativeInset()

◆ GetLeftRelativeInset()

◆ GetRightFixedInset()

◆ GetRightHeight()

◆ GetRightRawRelativeInset()

◆ GetRightRelativeInset()

◆ GetSpan()

◆ SetLeftFixedInset()

◆ SetLeftHeight()

◆ SetLeftRawRelativeInset()

◆ SetLeftRelativeInset()

◆ SetRightFixedInset()

◆ SetRightHeight()

◆ SetRightRawRelativeInset()

◆ SetRightRelativeInset()

◆ SetSpan()