FCMString
Summary of Modifications
- Fixed rounding bugs in
GetMeasurement and adjusted override handling behaviour to match FCCtrlEdit.GetMeasurement on Windows
- Fixed bug in
SetMeasurement where all displayed numbers were truncated at 2 decimal places.
- Added
GetMeasurementInteger, GetRangeMeasurementInteger and SetMeasurementInteger methods for parity with FCCtrlEdit
- Added
GetMeasurementEfix, GetRangeMeasurementEfix and SetMeasurementEfix methods for parity with FCCtrlEdit`
- Added
*Measurement10000th methods for setting and retrieving values in 10,000ths of an EVPU (eg for piano brace settings, slur tip width, etc)
Functions
- GetMeasurement(self, measurementunit)
- GetRangeMeasurement(self, measurementunit, minimum, maximum)
- SetMeasurement(self, value, measurementunit)
- GetMeasurementInteger(self, measurementunit)
- GetRangeMeasurementInteger(self, measurementunit, minimum, maximum)
- SetMeasurementInteger(self, value, measurementunit)
- GetMeasurementEfix(self, measurementunit)
- GetRangeMeasurementEfix(self, measurementunit, minimum, maximum)
- SetMeasurementEfix(self, value, measurementunit)
- GetMeasurement10000th(self, measurementunit)
- GetRangeMeasurement10000th(self, measurementunit, minimum, maximum)
- SetMeasurement10000th(self, value, measurementunit)
GetMeasurement
fcmstring.GetMeasurement(self, measurementunit)
View source
[Override]
Override Changes:
- Fixes issue with incorrect rounding of returned value.
- Also changes handling of unit overrides to match the behaviour of
FCCtrlEdit on Windows
| Input |
Type |
Description |
self |
FCMString |
|
measurementunit |
number |
One of the finale.MEASUREMENTUNIT_* constants. |
| Return type |
Description |
number |
EVPUs with decimal part. |
GetRangeMeasurement
fcmstring.GetRangeMeasurement(self, measurementunit, minimum, maximum)
View source
[Override]
Override Changes:
- See
FCMString.GetMeasurement.
| Input |
Type |
Description |
self |
FCMString |
|
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
minimum |
number |
|
maximum |
number |
|
| Return type |
Description |
number |
|
SetMeasurement
fcmstring.SetMeasurement(self, value, measurementunit)
View source
[Fluid] [Override]
Override Changes:
- Fixes issue with displayed numbers being truncated at 2 decimal places.
- Emulates the behaviour of
FCCtrlEdit.SetMeasurement on Windows while the window is showing.
| Input |
Type |
Description |
self |
FCMString |
|
value |
number |
The value to set in EVPUs. |
measurementunit |
number |
One of the finale.MEASUREMENTUNIT_* constants. |
GetMeasurementInteger
fcmstring.GetMeasurementInteger(self, measurementunit)
View source
Returns the measurement in whole EVPUs.
| Input |
Type |
Description |
self |
FCMString |
|
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
| Return type |
Description |
number |
|
GetRangeMeasurementInteger
fcmstring.GetRangeMeasurementInteger(self, measurementunit, minimum, maximum)
View source
Returns the measurement in whole EVPUs, clamped between two values.
Also ensures that any decimal places in minimum are correctly taken into account instead of being discarded.
| Input |
Type |
Description |
self |
FCMString |
|
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
minimum |
number |
|
maximum |
number |
|
| Return type |
Description |
number |
|
SetMeasurementInteger
fcmstring.SetMeasurementInteger(self, value, measurementunit)
View source
[Fluid]
Sets a measurement in whole EVPUs.
| Input |
Type |
Description |
self |
FCMString |
|
value |
number |
The value in whole EVPUs. |
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
GetMeasurementEfix
fcmstring.GetMeasurementEfix(self, measurementunit)
View source
Returns the measurement in whole EFIXes (1/64th of an EVPU)
| Input |
Type |
Description |
self |
FCMString |
|
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
| Return type |
Description |
number |
|
GetRangeMeasurementEfix
fcmstring.GetRangeMeasurementEfix(self, measurementunit, minimum, maximum)
View source
Returns the measurement in whole EFIXes (1/64th of an EVPU), clamped between two values.
| Input |
Type |
Description |
self |
FCMString |
|
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
minimum |
number |
|
maximum |
number |
|
| Return type |
Description |
number |
|
SetMeasurementEfix
fcmstring.SetMeasurementEfix(self, value, measurementunit)
View source
[Fluid]
Sets a measurement in whole EFIXes.
| Input |
Type |
Description |
self |
FCMString |
|
value |
number |
The value in EFIXes (1/64th of an EVPU) |
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
GetMeasurement10000th
fcmstring.GetMeasurement10000th(self, measurementunit)
View source
Returns the measurement in 10,000ths of an EVPU.
| Input |
Type |
Description |
self |
FCMString |
|
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
| Return type |
Description |
number |
|
GetRangeMeasurement10000th
fcmstring.GetRangeMeasurement10000th(self, measurementunit, minimum, maximum)
View source
Returns the measurement in 10,000ths of an EVPU, clamped between two values.
Also ensures that any decimal places in minimum are handled correctly instead of being discarded.
| Input |
Type |
Description |
self |
FCMString |
|
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |
minimum |
number |
|
maximum |
number |
|
| Return type |
Description |
number |
|
SetMeasurement10000th
fcmstring.SetMeasurement10000th(self, value, measurementunit)
View source
[Fluid]
Sets a measurement in 10,000ths of an EVPU.
| Input |
Type |
Description |
self |
FCMString |
|
value |
number |
The value in 10,000ths of an EVPU. |
measurementunit |
number |
One of the finale.MEASUREMENTUNIT*_ constants. |