Helianthus

Helianthus: Документация

Установка

Запуск и общие функции

Клавиатура и мышь

Рисование

Шрифты и текст

Текстуры и анимация

Буфер кадра

Спрайты

Группы спрайтов

Звук

Пользовательский интерфейс

Все функции

Клавиатура и мышь

Во время работы программы вы можете узнавать положение мыши и состояние клавиш. Координаты указателя мыши можно получить функциями mouseX и mouseY. С помощью функций mouseScrolledX, mouseScrolledY вы можете узнать количество «щелчков» прокрутки колёсика мыши совершённое со времени предыдущего кадра. Узнать состояние клавиш клавиатуры и кнопок мыши можно функциями keyDown и mouseDown соответственно.

Для указания клавиши нужно написать её текстовое наименование, например: "a", "1", "left", "right", "up", "down", "return" (для Enter), "escape" и и.д.

Названия клавиш взяты из библиотеки SDL, их полный список вы можете посмотреть в документации к библиотеке SDL:
    https://wiki.libsdl.org/SDL_Keycode

Вы также можете использовать несколько групповых наименований: "any shift", "any ctrl", "any alt", "any gui" — обозначающих нажатие любой из парных клавиш (как левой так и правой). Группы "any /", "any *", "any -", "any +", "any return", "any 0", "any 1"… - отвечают за клавиши имеющие пару на дополнительной цифровой клавиатуре.

Наименований для кнопок мыши всего три: "left", "middle" и "right".

Кроме этого существуют функции для определения момента нажатия и отпускания клавиш и кнопок. На тот случай когда некоторые действия нужно выполнить только один раз в момент нажатия (или отпускания) клавиши. Смотрите функции keyWentDown, keyWentUp, mouseWentDown, mouseWentUp.

Также вы можете получить полный список нажатых, отпущенных или удерживаемых клавиш и кнопок при помощи функций keyEventGetCount и keyEventGet.

Например, если вы не знаете наименования какой-либо клавиши, вы можете выводить имена нажимаемых клавиш в терминал при помощи такой программы:

void draw() {
    …
    int count = keyEventGetCount(KEYEVENT_KEY_WENTDOWN);
    for(int i = 0; i < count; ++i) {
        printf( "pressed key: %s\n",
            keyEventGet(KEYEVENT_KEY_WENTDOWN, i) );
    }
    …
}

Если вам нужно не просто узнать названия нажатых клавиш, но и определить какой они образуют текст, то воспользуйтесь набором функций textInputBegin, textInputGet, textInputClear и textInputEnd.

Функции:

int keyDown(const char *code);

Функция возвращает TRUE (число 1) если указанная клавиша в нажата (и удерживается) в данный момент и FALSE (число 0) если клавиша отпущена.

Параметры:

code — текстовое наименование клавиши.

int keyWentDown(const char *code);

Функция возвращает TRUE (число 1) если указанная клавиша стала нажатой в момент времени между предыдущим и текущим кадром. В последующих кадрах, даже если клавиша остаётся нажатой, функция возвращает FALSE (число 0).

Важно: Примерно через секунду после нажатия и удержания клавиши, keyWentDown всё таки сработает ещё раз — так будто клавиша была повторно нажата. Другими словами поведение функции такое же как и у текстового редактора: если удерживать клавишу некоторое время редактор повторяет печать символа несколько раз.

Параметры:

code — текстовое наименование клавиши.

int keyWentUp(const char *code);

Функция возвращает TRUE (число 1) если указанная клавиша перестала быть нажатой в момент времени между предыдущим и текущим кадром. Во всех других случаях возвращает FALSE (число 0).

Параметры:

code — текстовое наименование клавиши.

void textInputBegin();

Включить режим ввода текста. С момента запуска этой функции Helianthus будет запоминать все нажатые клавиши и формировать из них текст. См. также: textInputGet и textInputEnd.

void textInputEnd();

Отключить режим ввода текста и прекратить записывать вводимый пользователем текст. Раннее введённый текст останется в памяти и всё ещё будет доступен через функцию textInputGet. См. также: textInputBegin.

const char* textInputGet();

Получить введённый с клавиатуры текст. Вводимый текст накапливается с момента вызова функции textInputBegin. Функция textInputEnd останавливает запись текста, но при этом ранее накопленные символы остаются в памяти. Чтобы их стереть и начать копить текст заново используйте функцию textInputClear.

void textInputClear();

Очистить буфер вводимого с клавиатуры текста. См. также: textInputBegin и textInputGet.

int mouseDown(const char *code);

Функция возвращает TRUE (число 1) если указанная кнопка мыши в нажата (и удерживается) в данный момент и FALSE (число 0) если кнопка отпущена.

Параметры:

code — текстовое наименование кнопки мыши.

int mouseWentDown(const char *code);

Функция возвращает TRUE (число 1) если указанная кнопка мыши стала нажатой в момент времени между предыдущим и текущим кадром. Во всех последующих кадрах, даже если кнопка остаётся нажатой, функция возвращает FALSE (число 0).

Параметры:

code — текстовое наименование кнопки мыши.

int mouseWentUp(const char *code);

Функция возвращает TRUE (число 1) если указанная кнопка мыши перестала быть нажатой в момент времени между предыдущим и текущим кадром. Во всех других случаях возвращает FALSE (число 0).

Параметры:

code — текстовое наименование кнопки мыши.

int mouseScrolledX();

Возвращает количество «щелчков» колёсика мыши для горизонтальной прокрутки прошедшее с предыдущего кадра. Может быть отрицательным при обратной прокрутке. См. также mouseScrolledY.

int mouseScrolledY();

Возвращает количество «щелчков» колёсика мыши для вертикальной прокрутки прошедшее с предыдущего кадра. Может быть отрицательным при обратной прокрутке. См. также mouseScrolledX.

int mouseDidMove();

Функция возвращает TRUE (число 1) если с момента отрисовки предыдущего кадра положение мыши изменилось, и возвращает FALSE (число 0) ели мышь оставалась неподвижной.

double mouseX();

Возвращает координату X указателя мыши. Координаты считаются относительно верхнего левого угла окна. См. также: mouseY, mouseTransformedX.

double mouseY();

Возвращает координату Y указателя мыши. Координаты считаются относительно верхнего левого угла окна. См. также: mouseX, mouseTransformedY.

double mouseTransformedX();

Возвращает координату X указателя мыши в системе координат рисования с учётом применённых трансформаций. См. также mouseTransformedY, mouseX, translate, rotate, zoom.

double mouseTransformedY();

Возвращает координату Y указателя мыши в системе координат рисования с учётом применённых трансформаций. См. также mouseTransformedX, mouseY, translate, rotate, zoom.

int keyEventGetCount(KeyEvent mode);

Возвращает количество зарегистрированных на данном кадре клавиш (или кнопок мыши), соответствующих одному из перечисленных ниже типу событий:

KEYEVENT_KEY_DOWN удерживаемые в данный момент клавиши, см. keyDown
KEYEVENT_KEY_WENTDOWN клавиши, которые только что стали нажатыми, см. keyWentDown
KEYEVENT_KEY_WENTUP клавиши, которые были только что отпущены, см. keyWentUp
KEYEVENT_MOUSE_DOWN кнопки мыши, которые в данный момент нажаты, см. mouseDown
KEYEVENT_MOUSE_WENTDOWN кнопки мыши, которые только что стали нажатыми, см. mouseWentDown
KEYEVENT_MOUSE_WENTUP кнопки мыши, которые были только что отпущены, см. mouseWentUp

Параметры:

mode — тип событий, см. выше.

const char* keyEventGet(KeyEvent mode, int i);

Возвращает наименования клавиши или кнопки мыши из списка событий указанного типа, по указанному номеру. Элементы в списке событий отсортированы по времени возникновения события. То есть клавиши идут в том порядке в котором они были нажаты (или отпущены). См. также keyEventGetCount.

Параметры:

mode — тип событий, список типов смотрите в описании функции keyEventGetCount;
i — порядковой номер клавиши или кнопки в списке для указанного типа, элементы