The class for one single beat chart element. More...

#include <ff_other.h>

Inheritance diagram for FCBeatChartElement:

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.

	FCBeatChartElement ()
	The constructor.

TimeEdu32	GetMeasurePos () const override
	Return the duration reference position for the element.

Evpu16	GetHorizontalPosition () const
	Returns the position in the measure for the element (in EVPUs).

Evpu16	GetNextHorizontalPosition () const
	Returns the next position in the measure.

Evpu16	GetMinimumPosition () const
	Returns the minimum position for the element.

TimeEdu32	GetTotalDuration () const
	Returns the total duration for the beat chart.

Evpu16	GetFullSpan () const
	Returns the full span for the beat chart.

Evpu16	GetMinimumWidth () const
	Returns the minimum width for the beat chart.

Evpu16	GetReferenceWidth () const
	Returns the reference width for the beat chart.

bool	GetInitElement () const
	Returns true if it's the first (init) element in the chart. The init element defines the full beat chart.

Evpu16	CalcWidth ()
	Calculates and returns the width of the beat chart element.

void	SetMeasurePos (TimeEdu32 edupos)
	Sets the duration reference position for the element.

void	SetWidth (Evpu16 width)
	Sets the width of the beat chart element.

void	SetHorizontalPosition (Evpu16 position)
	Sets the position of the beat chart element.

void	SetNextHorizontalPosition (Evpu16 value)
	Sets the next position in the measure.

void	SetMinimumPosition (Evpu16 value)
	Sets the minimum position for the element.

void	SetTotalDuration (TimeEdu32 dura)
	Sets the total duration for the beat chart. This should be the same duration as the measure.

void	SetFullSpan (Evpu16 span)
	Sets the full span for the beat chart.

void	SetMinimumWidth (Evpu16 width)
	Sets the minimum width for the beat chart.

void	SetReferenceWidth (Evpu16 width)
	Sets the reference width for the beat chart.

bool	MoveHorizontalPosition (Evpu16 offset, FCBeatChartElements *pBeatChart)
	"Moves" the beat chart element by the offset amount.

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

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

virtual bool	Load (CMPER itemno, twobyte inci)
	Loads the indicated record within the item number.

twobyte	CalcLastInci () override
	Overridden version of CalcLastInci for __FCInciOther-based classes.

bool	Reload () override
	Overridden version of Reload(), to support complex (mixed) data types.

virtual bool	SaveNew (CMPER itemno)
	Creates a new inci record with data.

void	_SetCmper (CMPER cmper)
	Primarily for internal use.

int	GetItemCmper () const
	Returns the cmper (main record) value for a loaded record.

int	GetItemInci () const
	Returns the inci (subrecord) value in the data ID for a loaded record.

virtual eMeas	GetMeasure () const
	Virtual method for returning the measure number.

virtual eStaff	GetStaff () const
	Virtual method for returning the staff number.

virtual bool	HasStaffValue () const
	Method that should return true if GetStaff() returns actual values.

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	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.

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

virtual bool	LoadFirst ()=0
	Loads the very first element in the database, if any.

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

virtual bool	LoadNext ()
	Loads the next element from 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
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 __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 __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

The class for one single beat chart element.

Constructor & Destructor Documentation

◆ FCBeatChartElement()

FCBeatChartElement::FCBeatChartElement ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ CalcWidth()

Evpu16 FCBeatChartElement::CalcWidth ( )

inline

Calculates and returns the width of the beat chart element.

Warning: This function only calculates the correct width after a beat chart has been transitioned to a manual beatchart. See FCBeatChartElements::TransitionToManual for more information. To calculate the width for any beat chart element, regardless of whether it has been transitioned to manual or not, use FCBeatChartElements:CalcElementWidth instead.

Lua-supported.

Returns: If it's the init element, 0 is returned. Otherwise, it's the calculated width of the element in EVPUs.

◆ ClassName()

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

◆ DebugDump()

void FCBeatChartElement::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 __FCBaseData.

◆ GetClassID()

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

◆ GetFullSpan()

Evpu16 FCBeatChartElement::GetFullSpan ( ) const

inline

Returns the full span for the beat chart.

This can only be applied on the init beat chart element.

Lua-supported (also as property).

Returns: Returns 0 if it's not the init element. Otherwise, it returns the full span position of the beat chart.

◆ GetHorizontalPosition()

Evpu16 FCBeatChartElement::GetHorizontalPosition ( ) const

inline

Returns the position in the measure for the element (in EVPUs).

If the object is the init element (see GetInitElement), it's the total width of the measure. For the init element, it is recommended to use GetFullSpan instead.

Lua-supported (also as property).

◆ GetInitElement()

bool FCBeatChartElement::GetInitElement ( ) const

inline

Returns true if it's the first (init) element in the chart. The init element defines the full beat chart.

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

◆ GetMeasurePos()

TimeEdu32 FCBeatChartElement::GetMeasurePos ( ) const

inlineoverridevirtual

Return the duration reference position for the element.

If the object is the init element (see GetInitElement), it's the total duration of the measure. For the init element it is recommended to use GetTotalDuration instead.

The duration position normally reflects an entry position, but if the measure is underfilled with too few entries there would also be an extra beat chart element for the remaining part of the measure.

Lua-supported (also as property).

Returns: The position of the element in EDUs.

Reimplemented from __FCInciOther.

◆ GetMinimumPosition()

Evpu16 FCBeatChartElement::GetMinimumPosition ( ) const

inline

Returns the minimum position for the element.

Note that this value always 0 or 1 after a beat chart is transitioned to a manual beat chart.

Lua-supported (also as property).

Returns: Returns 0 if it's the init element. Otherwise, the minimum position for the element.

◆ GetMinimumWidth()

Evpu16 FCBeatChartElement::GetMinimumWidth ( ) const

inline

Returns the minimum width for the beat chart.

The minimum width is the final minimum position of the beat chart. It is only meaningful for a non-manual beat chart.

This can only be applied on the init beat chart element.

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

Returns: Returns 0 if it's not the init element. Otherwise, the minimum width of the beat chart.

◆ GetNextHorizontalPosition()

Evpu16 FCBeatChartElement::GetNextHorizontalPosition ( ) const

inline

Returns the next position in the measure.

This cannot be applied on the init beat chart element.

The "width" of the element can be found by using this value minus the measure position.

Lua-supported (also as property).

Returns: Returns 0 if it's the initial element. Otherwise, the horizontal position of the next beat chart element.

◆ GetReferenceWidth()

Evpu16 FCBeatChartElement::GetReferenceWidth ( ) const

inline

Returns the reference width for the beat chart.

The reference width is calculated by Finale when it generates the note spacing and stored in the init beat chart element. It represents the narrowest possible width for the beat chart that does not result in collisions. It is recommended not to modify this value.

This can only be applied on the init beat chart element.

Lua-supported (also as property).

Returns: Returns 0 if it's not the init element. Otherwise, the reference width of the beat chart.

◆ GetTotalDuration()

TimeEdu32 FCBeatChartElement::GetTotalDuration ( ) const

inline

Returns the total duration for the beat chart.

This can only be applied on the init beat chart element. This should be equal to the duration of the measure.,

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

Returns: Returns 0 if it's not the init element. Otherwise, it returns the total duration of the beat chart.

◆ MoveHorizontalPosition()

bool FCBeatChartElement::MoveHorizontalPosition	(	Evpu16	offset,
		FCBeatChartElements *	pBeatChart )

"Moves" the beat chart element by the offset amount.

Both the current position and the next position is affected. This method will not affect init elements.

Important! Please note that, for the beat chart to remain intact, all subsequent beat chart elements must be moved as well (easiest with the FCBeatChartElements::RebuildAfter method)

Parameters

offset	The amout to move the beat chart element, in EVPUs.
pBeatChart	The beat chart that the element belongs to.

◆ SetFullSpan()

void FCBeatChartElement::SetFullSpan ( Evpu16 span )

inline

Sets the full span for the beat chart.

This can only be applied on the init beat chart element.

Lua-supported (also as property).

◆ SetHorizontalPosition()

void FCBeatChartElement::SetHorizontalPosition ( Evpu16 position )

inline

Sets the position of the beat chart element.

For the init beat chart element, use SetFullSpan instead.

Lua-supported (also as property).

◆ SetMeasurePos()

void FCBeatChartElement::SetMeasurePos ( TimeEdu32 edupos )

inline

Sets the duration reference position for the element.

See comments at GetMeasurePos. For the init beat chart element, it is recommended to use SetTotalDuration instead.

Lua-supported (also as property).

◆ SetMinimumPosition()

void FCBeatChartElement::SetMinimumPosition ( Evpu16 value )

inline

Sets the minimum position for the element.

Note that this value always 0 or 1 after a beat chart is transitioned to a manual beat chart. Generally speaking, you should not modify these values and instead should call FCBeatChartElements::TransitionToManual before modifying horizontal positioning.

This cannot be applied to the init beat chart element.

Lua-supported (also as property).

◆ SetMinimumWidth()

void FCBeatChartElement::SetMinimumWidth ( Evpu16 width )

inline

Sets the minimum width for the beat chart.

The minimum width is the final minimum position of the beat chart. It is only meaningful for a non-manual beat chart.

This can only be applied on the init beat chart element.

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

◆ SetNextHorizontalPosition()

void FCBeatChartElement::SetNextHorizontalPosition ( Evpu16 value )

inline

Sets the next position in the measure.

This cannot be applied on the init beat chart element.

(This value is the measure position + "width" of the element.)

Lua-supported (also as property).

◆ SetReferenceWidth()

void FCBeatChartElement::SetReferenceWidth ( Evpu16 width )

inline

Sets the reference width for the beat chart.

This can only be applied on the init beat chart element.

Lua-supported (also as property).

◆ SetTotalDuration()

void FCBeatChartElement::SetTotalDuration ( TimeEdu32 dura )

inline

Sets the total duration for the beat chart. This should be the same duration as the measure.

This can only be applied on the init beat chart element.

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

◆ SetWidth()

void FCBeatChartElement::SetWidth ( Evpu16 width )

inline

Sets the width of the beat chart element.

This will do nothing on the init beat chart element.

Important! Please note that, for the beat chart to remain intact, all subsequent beat chart elements must be moved to reflect this change (easiest with the FCBeatChartElements::RebuildAfter method).

Lua-supported.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FCBeatChartElement()

Member Function Documentation

◆ CalcWidth()

◆ ClassName()

◆ DebugDump()

◆ GetClassID()

◆ GetFullSpan()

◆ GetHorizontalPosition()

◆ GetInitElement()

◆ GetMeasurePos()

◆ GetMinimumPosition()

◆ GetMinimumWidth()

◆ GetNextHorizontalPosition()

◆ GetReferenceWidth()

◆ GetTotalDuration()

◆ MoveHorizontalPosition()

◆ SetFullSpan()

◆ SetHorizontalPosition()

◆ SetMeasurePos()

◆ SetMinimumPosition()

◆ SetMinimumWidth()

◆ SetNextHorizontalPosition()

◆ SetReferenceWidth()

◆ SetTotalDuration()

◆ SetWidth()