Статьи

Типы объектов - Sibelius

Объект Sibelius
Это предопределённая переменная, представляющая программу Sibelius. Можно использовать Sibelius, чтобы открывать, закрывать партитуры, показывать диалоги или (чаще всего) для получения объекта текущей партитуры.

Методы:

MessageBox(строка)
Показывает окно сообщения с текстом и кнопкой OK.

YesNoMessageBox(строка)
Показывает окно сообщения с кнопками Yes и No. Возвращает True, если нажата кнопка Yes, либо False.

ShowDialog(имя сценария,объект)
Показывает диалог из описания диалога, а сообщения и значения передаёт заданному объекту. Возвращает значение True (1) или False (0), в зависимости от того, какая кнопка была нажата для закрытия диалога (обычно, это кнопки OK или Cancel).

New()
Создаёт и показывает новую партитуру (за основу берётся шаблон, использованный в последний раз). Возвращает объект новой партитуры.

Play()
Играет текущую партитуру.

Stop()
Прекращает проигрывание партитуры.

Print()
Печатает текущую партитуру, используя настройки по умолчанию.

Close()
Закрывает текущую партитуру.

Close(показ диалога)
Закрывает текущую партитуру; если параметр True, выводиться диалог с предложением сохранить партитуру, а если False – предупреждений не выводится (и партитуры не сохраняются).

Open(имя файла)
Открывает и показывает выбранный файл. Имя файла должно содержать расширение, например, ‘Song.sib’.

SelectFolder()
Позволяет пользователю выбрать папку и возвращает объект Folder.

SelectFolder(заголовок)
Также, но с заданным заголовком.

GetFolder(путь)
Возвращает новый объект Folder, представляющий заданный путь, например, folder=Sibelius.GetFolder(“c:\\temp”);

GetPluginsFolder()
Возвращает новый объект Folder, представляющий папку плагинов Sibelius.

GetScoresFolder()
Возвращает новый объект Folder, представляющий папку партитур по умолчанию (заданную в меню File > Preferences > General).

GetFile(путь)
Возвращает новый объект File, представляющий указанный путь, например, file=Sibelius.GetFile(“c:\\temp\\textfile.txt”);

SelectFileToSave(заголовок,файл,начальный каталог,расширение по умолчанию,тип по умолчанию,описание типа по умолчанию)
Показывает диалог для выбора файла, в который должна быть сохранена партитура. Все параметры необязательные. Метод возвращает объект выбранного файла. Типы и расширения файлов (Описание : Тип : Расширение):
EMF Graphics : “EMF” : emf
Windows Bitmap : “BMP” : bmp
Macintosh PICT Bitmap : “PICT” : pict
Sibelius File : “SIBE” : sib
MIDI File : “Midi” : mid
Sibelius Style file : “SIBS” : lib
PhotoScore file : “SCMS” : opt
Web Page : “TEXT” : html
TIFF Graphics : “TIFF” : tif

SelectFileToOpen(заголовок,файл,начальный каталог,расширение по умолчанию,тип по умолчанию,описание типа по умолчанию)
Показывает диалог открытия файла. Все параметры необязательные. Метод возвращает объект выбранного файла, например: file=Sibelius.SelectFileToOpen(“Save Score”,”*.sib”,”c:\\my documents”,”sib”,”SIBE”,”Sibelius File”);

CreateProgressDialog(заголовок,минимальное значение, максимальное значение)
Создаёт диалог прогресса.

UpdateProgressDialog(позиция,сообщение)
Возвращает 0, если пользователь нажал Cancel.

DestroyProgressDialog()
Удаляет диалог прогресса.

MakeSafeFileName(имя файла)
Возвращает “безопасную” версию имени файла. Функция удаляет запрещённые в Windows и Unix символы и сокращает имя до 31 символа, чтобе оно могло быть отображено на Macintosh.

RandomNumber()
Возвращает случайное число.

RandomSeedTime()
Обновляет последовательность случайных чисел, основываясь на текущем времени.

RandomSeed(начальное число)
Обновляет последовательность случайных чисел, основываясь на заданном числе.

ResetStopWatch(номер таймера)
Переустанавливает время остановки.

GetElapsedSeconds(номер таймера)
Возвращает время в секундах, прошедшее с тех пор, как был вызван метод ResetStopWatch для данного таймера.

GetElapsedCentiSeconds(номер таймера)
Возвращает время в сотых долях секундах, прошедшее с тех пор, как был вызван метод ResetStopWatch для данного таймера.

GetElapsedMilliSeconds(номер таймера)
Возвращает время в сотых долях секундах, прошедшее с тех пор, как был вызван метод ResetStopWatch для данного таймера.

GetPitchSpectrumColor(индекс ноты)
Возвращает цвет по звуковысотному спектру для заданной ноты по шкале, где 0 = До, 1 = До#, 2 = Ре, 3 = Ре# и т.д. Значение цвета представлено в 24-битном RGB формате, в котором биты 0-7 представляют голубой, 8-15 - зелёный, 16-23 – красный, а 24-31 игнорируются. Так как ManuScript не предоставляет никакой битовой арифметики, их может быть трудно представлять, но Вы можете получить индивидуальный доступ к каждой цветовой составляющей (см. ниже).

GetPitchSpectrumColorRed(индекс ноты)
Возвращает красную составляющую (0-255) цвета ноты.

GetPitchSpectrumColorGreen(индекс ноты)
Возвращает зелёную составляющую (0-255) цвета ноты.

GetPitchSpectrumColorBlue(индекс ноты)
Возвращает голубую составляющую (0-255) цвета ноты.

SetPitchSpectrumColor(индекс ноты,новый цвет)
Задаёт цвет по звуковысотному спектру для заданной ноты по шкале, где 0 = До, 1 = До#, 2 = Ре, 3 = Ре# и т.д. Значение цвета представлено в 24-битном RGB формате, в котором биты 0-7 представляют голубой, 8-15 - зелёный, 16-23 – красный, а 24-31 игнорируются.

SetPitchSpectrumColorRed(индекс ноты,новый цвет)
Задаёт красную составляющую (0-255) цвета ноты.

SetPitchSpectrumColorGreen(индекс ноты,новый цвет)
Задаёт зелёную составляющую (0-255) цвета ноты.

SetPitchSpectrumColorBlue(индекс ноты,новый цвет)
Задаёт голубую составляющую (0-255) цвета ноты.

GetNotesForGuitarChord(имя аккорда)
Возвращает массив ManuScript, состоящий из звуковысотностей MIDI и номеров струн для заданного аккорда, используя наиболее подходящую аппликатуру, исходя из настроек пользователя. Струны нумеруются, начиная с 0 для нижней струны. Возвращаемый массив имеет вдвое больше элементов, чем количество нот в аккорде, так как для каждой ноты имеется элемент, представляющий её звуковысотность, и элемент, представляющий номер струны:
array[0] = (MIDI звуковысотность ноты 0)
array[1] = (номер струны ноты 0)
array[2] = (MIDI звуковысотность ноты 1)
array[3] = (номер струны ноты 1)
...

Переменные:

ActiveScore
объект активной партитуры

ScoreCount
число открытых партитур

Playing
True, если партитура в данный момент проигрывается

ViewHighlights
True, если включён элемент меню View > Highlights (для чтения/записи)

ViewNoteVelocities
True, если включён элемент меню View > Live Playback Velocities (для чтения/записи)

ViewNoteColors
использует текущие установки цветов нот (для чтения/записи)
Описание значений:
Отключено - 0
Ноты за пределами диапазона - 1
Спектр звуковысотности - 2
Цвета голосов - 3

ProgramVersion
версия Sibelius, в которой запущен плагин; целое число следующего формата: (старший номер версии) * 1000 + (младший номер версии) * 100 + (ревизия) * 10.
Поэтому Sibelius v2.11 (v2.1.1) вернёт значение 2110.

PathSeparator
возвращает текущий символ разделителя пути (то есть, `\’ для Windows, `:’ для Mac).

FocusOnStaves
Переменная для чтения/записи. Если True, партитура отображается в режиме ‘Focus on Staves’. Смотри также Staves.ShowInFocusOnStaves.