add doc/**/cameras.md & update cameras library

2024-07-22 16:50:03 +03:00
parent 2fe25f5dd5
commit 012e81d4c9
6 changed files with 169 additions and 2 deletions
@@ -0,0 +1,66 @@
+# Библиотека *cameras*
+
+Библиотека предназначена для работы с камерами.
+
+## Основные функции
+
+```lua
+cameras.get(name: str) -> int
+```
+
+Возвращает камеру по имени.
+
+## Методы камеры
+
+```lua
+-- получаем камеру
+local cam = cameras.get("пак:имя-камеры")
+
+-- возвращает индекс камеры
+cam:get_index() -> int
+
+-- возвращает имя камеры
+cam:get_name() -> str
+
+-- возвращает позицию камеры
+cam:get_pos() -> vec3
+-- устанавливает позицию камеры
+cam:set_pos(pos: vec3)
+
+-- возращает вращение камеры
+cam:get_rot() -> mat4
+-- устанавливает вращение камеры
+cam:set_rot(rot: mat4)
+
+-- возвращает значение приближения камеры
+cam:get_zoom() -> number
+-- устанавливает значение приближения камеры
+cam:set_zoom(zoom: number)
+
+-- возвращает угол поля зрения камеры по Y (в градусах)
+cam:get_fov() -> number
+-- устанавливает угол поля зрения камеры по Y (в градусах)
+cam:set_fov(fov: number)
+
+-- возвращает true если ось Y отражена
+cam:is_flipped() -> bool
+-- отражает ось Y при значении true
+cam:set_flipped(flipped: bool)
+
+-- проверяет, включен ли режим перспективы
+cam:is_perspective() -> bool
+-- включает/выключает режим перспективы
+cam:set_perspective(perspective: bool)
+
+-- возвращает вектор направления камеры
+cam:get_front() -> vec3
+-- возвращает вектор направления направо
+cam:get_right() -> vec3
+-- возвращает вектор направления вверх
+cam:get_up() -> vec3
+
+-- направляет камеру на заданную точку
+cam:look_at(point: vec3)
+```
+
+Переключение камеры возможно через функцию player.set_camera.