Skip to content

Latest commit

 

History

History
1182 lines (1182 loc) · 66.9 KB

Input-Raw.md

File metadata and controls

1182 lines (1182 loc) · 66.9 KB

Список методов в категории Input-Raw:

StopGPSTracking

Описание

Останавливает обновление местоположения GPS, используйте это для экономии заряда батареи, когда вам больше не нужно местоположение.

Определение

void agk::StopGPSTracking()

Параметры

Пример кода


StartGPSTracking

Описание

Запускает процесс получения местоположения GPS, если это возможно, на текущем устройстве. Это может вызвать запрос разрешения на некоторых платформах при первом вызове. Если пользователь отказывает в разрешении, то GetGPSSensorExists может вернуть 0 с этого момента. Вы должны вызывать эту команду только тогда, когда пользователь выполняет действие, которое, как он знает, потребует определения местоположения, в противном случае он может отклонить его и никогда больше не получить запрос (ему придется войти в настройки своего устройства, чтобы включить его). Эта команда будет потреблять много энергии батареи, поэтому используйте StopGPSTracking, когда вам больше не нужно местоположение. Эта команда работает на iOS, Android, Mac и Windows 7 и выше. Вызов этой команды может занять некоторое время, чтобы получить точное местоположение от GetRawGPSLatitude и GetRawGPSLongitude.

Определение

void agk::StartGPSTracking()

Параметры

Пример кода


SetRawTouchMoveSensitivity

Описание

Задает расстояние, на которое должно переместиться событие касания, прежде чем оно будет классифицировано как событие перетаскивания. По умолчанию это значение равно 6.

Определение

void agk::SetRawTouchMoveSensitivity( int distance )

Параметры

distance - Расстояние, на которое событие касания должно переместиться в виртуальных координатах

Пример кода


SetRawMouseVisible

Описание

Пытается скрыть или показать любой указатель мыши, используемый на этой платформе. Не гарантируется работа на всех платформах.

Определение

void agk::SetRawMouseVisible( int visible )

Параметры

visible - 1, чтобы сделать его видимым, 0, чтобы скрыть его.

Пример кода


SetRawTouchValue

Описание

Позволяет вам установить некоторые пользовательские данные для хранения в этом событии, которые вы можете получить позже. Это может быть значение или указатель.

Определение

void agk::SetRawTouchValue( UINT iIndex, int value )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.
value - Значение для хранения с этим событием.

Пример кода


SetRawMousePosition

Описание

Пытается расположить любой указатель мыши, используемый на этой платформе. Не гарантируется работа на всех платформах. Будет работать только тогда, когда окно вашего приложения имеет фокус.

Определение

void agk::SetRawMousePosition( float x, float y )

Параметры

x - Компонент X новой позиции мыши.
y - Компонент Y новой позиции мыши.

Пример кода


SetRawJoystickDeadZone

Описание

Устанавливает мертвую зону для всех реальных джойстиков так, чтобы любое значение X или Y ниже заданного порога возвращало 0. Это значение должно быть между 0 и 1, по умолчанию оно равно 0,15.

Определение

void agk::SetRawJoystickDeadZone( float threshold )

Параметры

threshold - Значение, ниже которого будет возвращено 0.

Пример кода


GetRotationVectorSensorExists

Описание

Возвращает 1, если текущее устройство имеет датчик вектора вращения, который в настоящее время поддерживается AGK, и 0, если нет.

Определение

int agk::GetRotationVectorSensorExists()

Параметры

Пример кода


GetRawTouchValue

Описание

Извлекает значение, ранее сохраненное в этом событии с помощью SetRawTouchValue.

Определение

int agk::GetRawTouchValue( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchType

Описание

Возвращает тип данного события касания. Все, в чем вы можете быть уверены при неизвестных событиях, - это то, что палец в данный момент находится на экране и находится там менее 1 секунды. Через 1 секунду он автоматически становится событием удержания. Если пользователь поднимает палец с экрана до этого, то это становится коротким событием, а если он перемещает палец дальше, чем расстояние, указанное SetRawTouchMoveSensitivity, то это становится событием перетаскивания. Если текущее событие неизвестно, то оно возвращает 0. События могут измениться с событий удержания на события перетаскивания, но короткие события и события перетаскивания не изменяют тип. Неизвестные события гарантированно изменят тип, как только появится дополнительная информация. Возможные возвращаемые значения-0 для обозначения неизвестного, 1 для короткого касания, 2 для удержания и 3 для перетаскивания.

Определение

int agk::GetRawTouchType( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchStartY

Описание

Возвращает положение Y в координатах экрана, в котором началось событие касания. Эта координата будет находиться в координатах вида, если вы смещаете порт вида, вы можете преобразовать его в мировые координаты с помощью ScreenToWorldY.

Определение

float agk::GetRawTouchStartY( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchTime

Описание

Возвращает общее время, которое заняло это событие, от нажатия до выпуска в секундах.

Определение

float agk::GetRawTouchTime( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchStartX

Описание

Возвращает позицию X в координатах экрана, где началось событие касания. Эта координата будет находиться в координатах вида, если вы смещаете порт вида, вы можете преобразовать его в мировые координаты с помощью ScreenToWorldX.

Определение

float agk::GetRawTouchStartX( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchLastY

Описание

Возвращает позицию Y в координатах экрана, где событие касания было записано в последний раз до его текущего местоположения. Эта координата будет находиться в координатах вида, если вы смещаете порт вида, вы можете преобразовать его в мировые координаты с помощью ScreenToWorldY.

Определение

float agk::GetRawTouchLastY( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchLastX

Описание

Возвращает позицию X в координатах экрана, где событие касания было записано в последний раз до его текущего местоположения. Эта координата будет находиться в координатах вида, если вы смещаете порт вида, вы можете преобразовать его в мировые координаты с помощью ScreenToWorldX.

Определение

float agk::GetRawTouchLastX( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchCurrentX

Описание

Возвращает позицию X в координатах экрана, где в данный момент находится событие касания. Эта координата будет находиться в координатах вида, если вы смещаете порт вида, вы можете преобразовать его в мировые координаты с помощью ScreenToWorldX.

Определение

float agk::GetRawTouchCurrentX( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchCurrentY

Описание

Возвращает положение Y в координатах экрана, где в данный момент находится событие касания. Эта координата будет находиться в координатах вида, если вы смещаете порт вида, вы можете преобразовать его в мировые координаты с помощью ScreenToWorldY.

Определение

float agk::GetRawTouchCurrentY( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawTouchCount

Описание

Возвращает количество событий касания, происходящих в данный момент. По умолчанию AGK не считает событие до тех пор, пока не узнает, какой это тип события, например короткое, длинное, перетаскивание и т. Д. Чтобы также подсчитать неизвестные события, установите значение bIncludeUnknown равным 1. Используйте 0, чтобы игнорировать неизвестные события.

Определение

UINT agk::GetRawTouchCount( int bIncludeUnknown )

Параметры

bIncludeUnknown - Установите значение 1, чтобы подсчитать неизвестные события, которые могут стать любым типом сенсорного события в будущем.

Пример кода


GetRawRotationVectorZ2

Описание

Возвращает Z-компонент текущей ориентации устройства в виде кватерниона. Это может быть применено к камерам с SetCameraRotationQuat, чтобы использовать устройство как гарнитуру виртуальной реальности. Эта команда выполняет внутренние вычисления на основе значений SetOrientationAllowed для получения правильной ориентации камеры для текущей ориентации устройства. Эта команда предназначена для использования с камерами, если вы хотите сориентировать объект, используйте GetRawRotationVectorZ

Определение

float agk::GetRawRotationVectorZ2()

Параметры

Пример кода


GetRawRotationVectorY2

Описание

Возвращает компонент Y текущей ориентации устройства в виде кватерниона. Это может быть применено к камерам с SetCameraRotationQuat, чтобы использовать устройство как гарнитуру виртуальной реальности. Эта команда выполняет внутренние вычисления на основе значений SetOrientationAllowed для получения правильной ориентации камеры для текущей ориентации устройства. Эта команда предназначена для использования с камерами, если вы хотите сориентировать объект, используйте GetRawRotationVectorY

Определение

float agk::GetRawRotationVectorY2()

Параметры

Пример кода


GetRawRotationVectorZ

Описание

Возвращает Z-компонент текущей ориентации устройства в виде кватерниона. Это можно применить к объектам с помощью SetObjectRotationQuat, чтобы имитировать ориентацию устройства с объектом. Эта команда предназначена для использования с объектами, если вы хотите сориентировать камеру, используйте GetRawRotationVectorZ2

Определение

float agk::GetRawRotationVectorZ()

Параметры

Пример кода


GetRawRotationVectorY

Описание

Возвращает компонент Y текущей ориентации устройства в виде кватерниона. Это можно применить к объектам с помощью SetObjectRotationQuat, чтобы имитировать ориентацию устройства с объектом. Эта команда предназначена для использования с объектами, если вы хотите сориентировать камеру, используйте GetRawRotationVectorY2

Определение

float agk::GetRawRotationVectorY()

Параметры

Пример кода


GetRawRotationVectorX2

Описание

Возвращает компонент X текущей ориентации устройства в виде кватерниона. Это может быть применено к камерам с SetCameraRotationQuat, чтобы использовать устройство как гарнитуру виртуальной реальности. Эта команда выполняет внутренние вычисления на основе значений SetOrientationAllowed для получения правильной ориентации камеры для текущей ориентации устройства. Эта команда предназначена для использования с камерами, если вы хотите сориентировать объект, используйте GetRawRotationVectorX

Определение

float agk::GetRawRotationVectorX2()

Параметры

Пример кода


GetRawRotationVectorX

Описание

Возвращает компонент X текущей ориентации устройства в виде кватерниона. Это можно применить к объектам с помощью SetObjectRotationQuat, чтобы имитировать ориентацию устройства с объектом. Эта команда предназначена для использования с объектами, если вы хотите сориентировать камеру, используйте GetRawRotationVectorX2

Определение

float agk::GetRawRotationVectorX()

Параметры

Пример кода


GetRawRotationVectorW2

Описание

Возвращает W-компонент текущей ориентации устройства в виде кватерниона. Это может быть применено к камерам с SetCameraRotationQuat, чтобы использовать устройство как гарнитуру виртуальной реальности. Эта команда выполняет внутренние вычисления на основе значений SetOrientationAllowed для получения правильной ориентации камеры для текущей ориентации устройства. Эта команда предназначена для использования с камерами, если вы хотите сориентировать объект, используйте GetRawRotationVectorW

Определение

float agk::GetRawRotationVectorW2()

Параметры

Пример кода


GetRawRotationVectorW

Описание

Возвращает W-компонент текущей ориентации устройства в виде кватерниона. Это можно применить к объектам с помощью SetObjectRotationQuat, чтобы имитировать ориентацию устройства с объектом. Эта команда предназначена для использования с объектами, если вы хотите сориентировать камеру, используйте GetRawRotationVectorW2

Определение

float agk::GetRawRotationVectorW()

Параметры

Пример кода


GetRawProximityDistance

Описание

Если датчик приближения существует, возвращает расстояние устройства от любого объекта, находящегося в данный момент перед ним, непроверенное, поскольку ни одно устройство не поддерживало его во время тестирования.

Определение

float agk::GetRawProximityDistance()

Параметры

Пример кода


GetRawTouchReleased

Описание

Возвращает 1 если прикосновение было отпущено, это всегда будет 1 для коротких событий, события удержания и перетаскивания будут продолжать сообщать 0 до тех пор, пока они не будут отпущены, и в этот момент вы, возможно, захотите предпринять какие-то действия. Каждое событие будет сообщаться только как 1 раз, прежде чем быть удаленным из списка событий. Если событие касания игнорируется (не запрашивается) в течение одного кадра после его освобождения, оно будет удалено из списка событий.

Определение

int agk::GetRawTouchReleased( UINT iIndex )

Параметры

iIndex - Индекс события для проверки, полученный от GetRawNextTouchEvent или GetRawFirstTouchEvent.

Пример кода


GetRawNextTouchEvent

Описание

Возвращает индекс к следующему событию касания, доступному для чтения, если больше нет доступных событий, он возвращает 0.

Определение

UINT agk::GetRawNextTouchEvent( )

Параметры

Пример кода


GetRawMouseY

Описание

Возвращает компонент Y текущего положения мыши в координатах экрана. Если мыши не существует, она всегда будет возвращать 0.

Определение

float agk::GetRawMouseY()

Параметры

Пример кода


GetRawMouseX

Описание

Возвращает компонент X текущего положения мыши в координатах экрана. Если мыши не существует, она всегда будет возвращать 0.

Определение

float agk::GetRawMouseX()

Параметры

Пример кода


GetRawMouseWheelDelta

Описание

Возвращает разницу между текущим положением колесика мыши и предыдущим положением колесика мыши, может быть положительной или отрицательной, обновляется один раз в кадр. Если мыши не существует, она всегда будет возвращать 0.

Определение

float agk::GetRawMouseWheelDelta()

Параметры

Пример кода


GetRawMouseWheel

Описание

Возвращает текущее положение колесика мыши, может быть положительным или отрицательным, начинается с 0. Если мыши не существует, она всегда будет возвращать 0.

Определение

float agk::GetRawMouseWheel()

Параметры

Пример кода


GetRawMouseRightState

Описание

Возвращает 1, если правая кнопка мыши в данный момент нажата, и 0, если нет. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseRightState()

Параметры

Пример кода


GetRawMouseRightReleased

Описание

Возвращает 1, если правая кнопка мыши была отпущена, а затем возвращает 0, когда кнопка поднята. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseRightReleased()

Параметры

Пример кода


GetRawMouseRightPressed

Описание

Возвращает 1, если была нажата правая кнопка мыши, а затем возвращает 0, пока кнопка удерживается нажатой. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseRightPressed()

Параметры

Пример кода


GetRawMouseMiddleState

Описание

Возвращает 1, если средняя кнопка мыши в данный момент опущена, и 0, если нет. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseMiddleState()

Параметры

Пример кода


GetRawMouseMiddleReleased

Описание

Возвращает 1, если средняя кнопка мыши была отпущена, а затем возвращает 0, когда кнопка поднята. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseMiddleReleased()

Параметры

Пример кода


GetRawMouseMiddlePressed

Описание

Возвращает 1, если была нажата средняя кнопка мыши, а затем возвращает 0, пока кнопка удерживается нажатой. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseMiddlePressed()

Параметры

Пример кода


GetRawMouseLeftState

Описание

Возвращает 1, если левая кнопка мыши в данный момент нажата, и 0, если нет. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseLeftState()

Параметры

Пример кода


GetRawMouseFourthReleased

Описание

Возвращает 1, если четвертая кнопка мыши была отпущена, а затем возвращает 0, когда кнопка поднята. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseFourthReleased()

Параметры

Пример кода


GetRawMouseFourthPressed

Описание

Возвращает 1, если была нажата четвертая кнопка мыши, а затем возвращает 0, пока кнопка удерживается нажатой. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseFourthPressed()

Параметры

Пример кода


GetRawMouseFifthState

Описание

Возвращает 1, если пятая кнопка мыши в данный момент нажата, и 0, если нет. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseFifthState()

Параметры

Пример кода


GetRawMouseFifthReleased

Описание

Возвращает 1, если пятая кнопка мыши была отпущена, а затем возвращает 0, когда кнопка поднята. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseFifthReleased()

Параметры

Пример кода


GetRawMouseFifthPressed

Описание

Возвращает 1, если была нажата пятая кнопка мыши, а затем возвращает 0, пока кнопка удерживается нажатой. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseFifthPressed()

Параметры

Пример кода


GetRawMagneticZ

Описание

Если магнитный датчик существует, возвращает Z-компоненту любого окружающего магнитного поля. На iOS может потребоваться несколько секунд, чтобы начать отображать данные, отличные от 0, во время этого процесса устройство использует данные движения для калибровки магнитного датчика

Определение

float agk::GetRawMagneticZ()

Параметры

Пример кода


GetRawMouseLeftReleased

Описание

Возвращает 1, если левая кнопка мыши была отпущена, а затем возвращает 0, когда кнопка поднята. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseLeftReleased()

Параметры

Пример кода


GetRawMouseFourthState

Описание

Возвращает 1, если четвертая кнопка мыши в данный момент нажата, и 0, если нет. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseFourthState()

Параметры

Пример кода


GetRawMagneticY

Описание

Если магнитный датчик существует, возвращает Y-компоненту любого окружающего магнитного поля. На iOS может потребоваться несколько секунд, чтобы начать отображать данные, отличные от 0, во время этого процесса устройство использует данные движения для калибровки магнитного датчика

Определение

float agk::GetRawMagneticY()

Параметры

Пример кода


GetRawMouseLeftPressed

Описание

Возвращает 1, если была нажата левая кнопка мыши, а затем возвращает 0, пока кнопка удерживается нажатой. Если мыши не существует, она всегда будет возвращать 0.

Определение

int agk::GetRawMouseLeftPressed()

Параметры

Пример кода


GetRawMagneticX

Описание

Если магнитный датчик существует, возвращает X-компоненту любого окружающего магнитного поля. На iOS может потребоваться несколько секунд, чтобы начать отображать данные, отличные от 0, во время этого процесса устройство использует данные движения для калибровки магнитного датчика

Определение

float agk::GetRawMagneticX()

Параметры

Пример кода


GetRawLightLevel

Описание

Если датчик окружающего света существует, получите измерение окружающего света в люмел в виде поплавка.

Определение

float agk::GetRawLightLevel()

Параметры

Пример кода


GetRawLastKey

Описание

Возвращает код последней нажатой клавиши. Это относится только к платформам с полноразмерной клавиатурой, таким как ПК, Mac и Linux. Вы можете проверить, существует ли клавиатура, используя GetKeyboardExists. Эта функция продолжает возвращать последнюю нажатую клавишу даже после того, как она была отпущена. Проверьте страницу коды сканирования в разделе руководства файлов справки, чтобы узнать, какой ключ соответствует какому коду ключа

Определение

int agk::GetRawLastKey( )

Параметры

Пример кода


GetRawKeyState

Описание

Возвращает 1, если данный код ключа в данный момент не работает. 0, если он поднят. Это относится только к платформам с полноразмерной клавиатурой, таким как ПК и Mac, в противном случае все клавиши вернут 0. Вы можете проверить, существует ли клавиатура, проверив, что GetKeyboardExists возвращает 1. Коды клавиш находятся в диапазоне от 0 до 255, все, что выходит за пределы диапазона, возвращает 0. Проверьте страницу коды сканирования в разделе руководства файлов справки, чтобы узнать, какой ключ соответствует какому коду ключа

Определение

int agk::GetRawKeyState( UINT key )

Параметры

key - Код ключа от ключа для проверки.

Пример кода


GetRawKeyReleased

Описание

Возвращает 1, если данный код ключа был выпущен в этом кадре, а затем возвращает 0, пока ключ находится вверх. Это относится только к платформам с полноразмерной клавиатурой, таким как ПК и Mac, в противном случае все клавиши вернут 0. Вы можете проверить, существует ли клавиатура, проверив, что GetKeyboardExists возвращает 1. Коды клавиш находятся в диапазоне от 0 до 255, все, что выходит за пределы диапазона, возвращает 0. Проверьте страницу коды сканирования в разделе руководства файлов справки, чтобы узнать, какой ключ соответствует какому коду ключа

Определение

int agk::GetRawKeyReleased( UINT key )

Параметры

key - Код ключа от ключа для проверки.

Пример кода


GetRawKeyPressed

Описание

Возвращает 1, если данный код клавиши был нажат в этом кадре, а затем возвращает 0, пока клавиша удерживается нажатой. Это относится только к платформам с полноразмерной клавиатурой, таким как ПК и Mac, в противном случае все клавиши вернут 0. Вы можете проверить, существует ли клавиатура, проверив, что GetKeyboardExists возвращает 1. Коды клавиш находятся в диапазоне от 0 до 255, все, что выходит за пределы диапазона, возвращает 0. Проверьте страницу коды сканирования в разделе руководства файлов справки, чтобы узнать, какой ключ соответствует какому коду ключа

Определение

int agk::GetRawKeyPressed( UINT key )

Параметры

key - Код ключа от ключа для проверки.

Пример кода


GetRawJoystickZ

Описание

Возвращает текущее значение Z (если применимо) для физического джойстика с заданным индексом. Это будет находиться в диапазоне от -1.0 до 1.0 с центрированием 0.

Определение

float agk::GetRawJoystickZ( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawJoystickSlider

Описание

Возвращает текущее значение ползунка джойстика, которое может варьироваться в зависимости от типа джойстика. В настоящее время индекс ползунка должен быть либо 0, либо 1. Ползунки обычно используются для дополнительных осей.

Определение

int agk::GetRawJoystickSlider( UINT index, UINT slider )

Параметры

index - Идентификатор джойстика для проверки.
slider - Индекс ползунка для проверки.

Пример кода


GetRawJoystickY

Описание

Возвращает текущее значение Y для физического джойстика с заданным индексом. Это будет находиться в диапазоне от -1.0 до 1.0 с центрированием 0.

Определение

float agk::GetRawJoystickY( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawJoystickX

Описание

Возвращает текущее значение X для физического джойстика с заданным индексом. Это будет находиться в диапазоне от -1.0 до 1.0 с центрированием 0.

Определение

float agk::GetRawJoystickX( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawJoystickRZ

Описание

Возвращает текущее вращательное значение Z (если применимо) для физического джойстика с заданным индексом. Это будет находиться в диапазоне от -1.0 до 1.0 с центрированием 0. На самом деле некоторые джойстики используют это значение для второго аналогового джойстика.

Определение

float agk::GetRawJoystickRZ( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawJoystickName

Описание

Возвращает имя джойстика, обнаруженное операционной системой, в настоящее время работает только на Windows и Linux. В Tier 2 строка кодируется в UTF-8 и должна быть удалена с помощью agk::DeleteString, когда вы закончите с ней.

Определение

char* agk::GetRawJoystickName( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawJoystickRX

Описание

Возвращает текущее вращательное значение X (если применимо) для физического джойстика с заданным индексом. Это будет находиться в диапазоне от -1.0 до 1.0 с центрированием 0. На самом деле некоторые джойстики используют это значение для второго аналогового джойстика.

Определение

float agk::GetRawJoystickRX( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawJoystickPOV

Описание

Возвращает текущее значение POV джойстика, это может варьироваться в зависимости от типа джойстика. В настоящее время индекс POV должен быть либо 0, 1, 2, либо 3

Определение

int agk::GetRawJoystickPOV( UINT index, UINT pov )

Параметры

index - Идентификатор джойстика для проверки.
pov - Индекс POV для проверки.

Пример кода


GetRawJoystickExists

Описание

Возвращает 1, если джойстик существует в данном индексе. Физические джойстики обнаруживаются при запуске и постепенно помещаются в идентификаторы 1-8. Вы должны вызвать CompleteRawJoystickDetection в какой-то момент перед этой командой, чтобы убедиться, что все присутствующие джойстики были обнаружены. После первоначального процесса обнаружения подключение дополнительных джойстиков не будет обнаружено (за исключением Android, который обнаружит новые джойстики). Отсоединение джойстика не приведет к удалению его индекса, и эта команда все равно вернет 1. Вы можете использовать GetRawJoystickConnected для обнаружения отсоединения ранее обнаруженного джойстика. Если отсоединенный джойстик будет снова подключен, AGK попытается снова подключиться к нему. Альтернативная версия этой команды существует GetJoystickExists, и в этом случае она вернет 1, если есть какие-либо необработанные джойстики.

Определение

int agk::GetRawJoystickExists( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawJoystickConnected

Описание

Возвращает 1, если указанный джойстик подключен, и 0, если нет. Это относится только к джойстикам, которые были подключены при запуске приложения, подключение нового джойстика после запуска приложения не будет обнаружено. Используйте GetRawJoystickExists, чтобы узнать, какие джойстики были обнаружены при запуске. Эта команда в настоящее время не работает на Mac.

Определение

int agk::GetRawJoystickConnected( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawJoystickButtonState

Описание

Возвращает 1, если данная кнопка в данный момент опущена, в противном случае возвращает 0. Чтобы обнаружить экземпляр, в котором кнопка нажата или отпущена, используйте GetRawJoystickButtonPressed или GetRawJoystickButtonReleased. AGK поддерживает до 64 кнопок джойстика в диапазоне 1-64.

Определение

int agk::GetRawJoystickButtonState( UINT index, UINT button )

Параметры

index - Идентификатор джойстика для проверки.
button - Идентификатор кнопки для проверки.

Пример кода


GetRawJoystickButtonReleased

Описание

Возвращает 1, если данная кнопка была отпущена в этом кадре, в противном случае возвращает 0. Как только кнопка была отпущена, эта функция возвращается к 0, чтобы проверить состояние кнопки, используйте GetRawJoystickButtonState. AGK поддерживает до 64 кнопок джойстика в диапазоне 1-64.

Определение

int agk::GetRawJoystickButtonReleased( UINT index, UINT button )

Параметры

index - Идентификатор джойстика для проверки.
button - Идентификатор кнопки для проверки.

Пример кода


GetRawGyroVelocityZ

Описание

Если гироскоп существует, возвращает Z-составляющую текущей скорости вращения устройства. Если вы не использовали SetOrientationAllowed для выбора желаемой ориентации, то эта команда заблокирует устройство в текущей ориентации, чтобы предотвратить вращение экрана. Вы должны использовать SetOrientationAllowed, если хотите включить вращение экрана при использовании гироскопа.

Определение

float agk::GetRawGyroVelocityZ()

Параметры

Пример кода


GetRawGyroVelocityY

Описание

Если гироскоп существует, возвращает Y-компоненту текущей скорости вращения устройства. Если вы не использовали SetOrientationAllowed для выбора желаемой ориентации, то эта команда заблокирует устройство в текущей ориентации, чтобы предотвратить вращение экрана. Вы должны использовать SetOrientationAllowed, если хотите включить вращение экрана при использовании гироскопа.

Определение

float agk::GetRawGyroVelocityY()

Параметры

Пример кода


GetRawGyroVelocityX

Описание

Если гироскоп существует, возвращает X-компоненту текущей скорости вращения устройства. Если вы не использовали SetOrientationAllowed для выбора желаемой ориентации, то эта команда заблокирует устройство в текущей ориентации, чтобы предотвратить вращение экрана. Вы должны использовать SetOrientationAllowed, если хотите включить вращение экрана при использовании гироскопа.

Определение

float agk::GetRawGyroVelocityX()

Параметры

Пример кода


GetRawJoystickRY

Описание

Возвращает текущее вращательное значение Y (если применимо) для физического джойстика с заданным индексом. Это будет находиться в диапазоне от -1.0 до 1.0 с центрированием 0. На самом деле некоторые джойстики используют это значение для второго аналогового джойстика.

Определение

float agk::GetRawJoystickRY( UINT index )

Параметры

index - Идентификатор джойстика для проверки.

Пример кода


GetRawGPSLongitude

Описание

Возвращает самую последнюю доступную долготу.

Определение

float agk::GetRawGPSLongitude()

Параметры

Пример кода


GetRawGPSAltitude

Описание

Возвращает самую актуальную высоту, доступную в метрах над уровнем моря.

Определение

float agk::GetRawGPSAltitude()

Параметры

Пример кода


GetRawJoystickButtonPressed

Описание

Возвращает 1, если данная кнопка была нажата в этом кадре, в противном случае возвращает 0. После нажатия кнопки эта функция возвращается к 0, чтобы проверить состояние кнопки, используйте GetRawJoystickButtonState. AGK поддерживает до 64 кнопок джойстика в диапазоне 1-64.

Определение

int agk::GetRawJoystickButtonPressed( UINT index, UINT button )

Параметры

index - Идентификатор джойстика для проверки.
button - Идентификатор кнопки для проверки.

Пример кода


GetRawFirstTouchEvent

Описание

Возвращает индекс к первому событию касания, доступному для чтения. По умолчанию AGK не считает событие до тех пор, пока не узнает, какой это тип события, например короткое, длинное, перетаскивание и т. Д. Для получения неизвестных событий также установите значение bIncludeUnknown равным 1. Используйте 0, чтобы игнорировать неизвестные события. Все, в чем вы можете быть уверены при неизвестных событиях, - это то, что палец в данный момент находится на экране и находится там менее 1 секунды. Через 1 секунду он автоматически становится событием удержания. Если пользователь поднимает палец с экрана, это становится коротким событием, а если он двигает пальцем, это становится событием перетаскивания. Если никакие события не доступны, он возвращает 0.

Определение

UINT agk::GetRawFirstTouchEvent( int bIncludeUnknown )

Параметры

bIncludeUnknown - Установите значение true для получения неизвестных событий, которые могут стать событиями любого типа в будущем.

Пример кода


GetRawAccelZ

Описание

Если акселерометр существует, возвращает текущее значение акселерометра для направления Z в диапазоне от -1 до 1. Положительное значение Z означает, что экран направлен вверх. Если акселерометр не существует, то он всегда будет возвращать 0, так как нет эмулируемой команды для направления Z. Если вы не использовали SetOrientationAllowed для выбора желаемой ориентации, то эта команда заблокирует устройство в текущей ориентации, чтобы предотвратить вращение экрана акселерометром. Вы должны использовать SetOrientationAllowed, если хотите включить вращение экрана при использовании акселерометра.

Определение

float agk::GetRawAccelZ()

Параметры

Пример кода


GetRawAccelX

Описание

Если акселерометр существует, возвращает текущее значение акселерометра для направления X в диапазоне от -1 до 1. Это соответствует экранной системе координат положительного существа справа. Если акселерометра не существует, то он всегда будет возвращать 0. Вы можете использовать команду GetDirectionX для эмуляции ввода направления. Если вы не использовали SetOrientationAllowed для выбора желаемой ориентации, то эта команда заблокирует устройство в текущей ориентации, чтобы предотвратить вращение экрана акселерометром. Вы должны использовать SetOrientationAllowed, если хотите включить вращение экрана при использовании акселерометра.

Определение

float agk::GetRawAccelX()

Параметры

Пример кода


GetRawAccelY

Описание

Если акселерометр существует, возвращает текущее значение акселерометра для направления Y в диапазоне от -1 до 1. Это соответствует экранной системе координат положительного бытия вниз. Если акселерометра не существует, то он всегда будет возвращать 0. Вы можете использовать команду GetDirectionY для эмуляции ввода направления. Если вы не использовали SetOrientationAllowed для выбора желаемой ориентации, то эта команда заблокирует устройство в текущей ориентации, чтобы предотвратить вращение экрана акселерометром. Вы должны использовать SetOrientationAllowed, если хотите включить вращение экрана при использовании акселерометра.

Определение

float agk::GetRawAccelY()

Параметры

Пример кода


GetProximitySensorExists

Описание

Возвращает 1, если текущее устройство имеет датчик приближения, который в настоящее время поддерживается AGK, и 0, если нет.

Определение

int agk::GetProximitySensorExists()

Параметры

Пример кода


GetRawGPSLatitude

Описание

Возвращает самую последнюю доступную широту.

Определение

float agk::GetRawGPSLatitude()

Параметры

Пример кода


GetNFCExists

Описание

Возвращает 1, если текущее устройство имеет встроенное устройство NFC, в противном случае возвращается 0. Эта команда еще не функционирует.

Определение

int agk::GetNFCExists()

Параметры

Пример кода


GetMultiTouchExists

Описание

Возвращает 1, если текущее устройство поддерживает мультитач, и 0, если нет.

Определение

int agk::GetMultiTouchExists()

Параметры

Пример кода


GetMouseExists

Описание

Возвращает 1, если на текущем устройстве есть мышь, и 0, если нет.

Определение

int agk::GetMouseExists()

Параметры

Пример кода


GetMagneticSensorExists

Описание

Возвращает 1, если текущее устройство имеет датчик магнетизма, который в настоящее время поддерживается AGK, и 0, если нет.

Определение

int agk::GetMagneticSensorExists()

Параметры

Пример кода


GetKeyboardExists

Описание

Возвращает 1, если текущее устройство имеет полноразмерную клавиатуру, 2, если устройство имеет виртуальную клавиатуру или клавиатуру мобильного телефона, и 0, если клавиатура вообще отсутствует.

Определение

int agk::GetKeyboardExists()

Параметры

Пример кода


GetLightSensorExists

Описание

Возвращает 1, если текущее устройство имеет датчик окружающего света, который в настоящее время поддерживается AGK, и 0, если нет.

Определение

int agk::GetLightSensorExists()

Параметры

Пример кода


GetJoystickExists

Описание

Возвращает 1, если текущее устройство имеет по крайней мере один физический джойстик, доступный в качестве метода ввода. 0, если у него нет физических джойстиков джойстика. Если вы обнаружите, что платформа не имеет физических джойстиков, вы можете создать виртуальные джойстики, которые появляются на экране для использования сенсорными экранами или мышами с помощью AddVirtualJoystick. GetJoystickExists не учитывает виртуальные джойстики в своей проверке. На некоторых платформах обнаружение джойстика выполняется в фоновом потоке, который может не завершиться в течение некоторого времени после запуска вашего приложения, чтобы дождаться завершения потока, используйте CompleteRawJoystickDetection, чтобы убедиться, что все подключенные джойстики были найдены.

Определение

int agk::GetJoystickExists()

Параметры

Пример кода


GetGyroSensorExists

Описание

Возвращает 1, если текущее устройство имеет гироскоп, который в настоящее время поддерживается AGK, и 0, если нет.

Определение

int agk::GetGyroSensorExists()

Параметры

Пример кода


GetGPSSensorExists

Описание

Возвращает 1, если текущее устройство имеет GPS-приемник, который в настоящее время поддерживается AGK, и 0, если нет.

Определение

int agk::GetGPSSensorExists()

Параметры

Пример кода


GetCharBufferLength

Описание

Возвращает текущую длину буфера символов без его изменения. Обратите внимание, что это длина в символах, а не в байтах, которая может отличаться, когда строка содержит символы юникода.

Определение

int agk::GetCharBufferLength()

Параметры

Пример кода


GetCharBuffer

Описание

Возвращает строку всех символов, нажатых с момента последнего вызова этой команды, после вызова которой буфер очищается. Это работает только на устройствах с физической клавиатурой. Буфер ограничен 1024 символами, после чего дополнительные символы будут проигнорированы. В Tier 2 строка кодируется в UTF-8 и должна быть удалена с помощью agk::DeleteString, когда вы закончите с ней.

Определение

char* agk::GetCharBuffer()

Параметры

Пример кода


GetCameraExists

Описание

Возвращает 1, если текущее устройство имеет камеру, и 0, если нет. На некоторых платформах эта команда перечисляет аппаратные устройства для проверки камеры, которая может быть медленной. Не рекомендуется называть это каждый кадр. В Windows эта команда успешно обнаружит новую камеру, подключенную во время работы приложения.

Определение

int agk::GetCameraExists()

Параметры

Пример кода


GetAccelerometerExists

Описание

Возвращает 1, если текущее устройство имеет акселерометр, который в настоящее время поддерживается AGK, и 0, если нет.

Определение

int agk::GetAccelerometerExists()

Параметры

Пример кода


CompleteRawJoystickDetection

Описание

Ждет завершения обнаружения физических джойстиков, в некоторых системах это может занять несколько секунд, поэтому запускается в отдельном потоке вдоль основного приложения. Если вы не используете ни одну из реальных команд джойстика (включая джойстик AGK), вы можете игнорировать эту команду и позволить обнаружению джойстика завершиться, когда ему заблагорассудится. Однако если вы хотите использовать команды джойстика в своем приложении, вы должны вызвать эту команду, чтобы убедиться, что общее количество подключенных джойстиков найдено. После этого первоначального процесса обнаружения подключение дополнительных джойстиков не будет обнаружено.

Определение

void agk::CompleteRawJoystickDetection()

Параметры

Пример кода