From acc4706e8f36b9c23076b79b93af95dcf2558bd3 Mon Sep 17 00:00:00 2001 From: Ivan Mahonin Date: Mar 23 2020 15:32:52 +0000 Subject: update documentation --- diff --git a/doc/helianthus-doc-ru.odt b/doc/helianthus-doc-ru.odt index 7d0a38d..5666e7e 100644 Binary files a/doc/helianthus-doc-ru.odt and b/doc/helianthus-doc-ru.odt differ diff --git a/doc/helianthus.png b/doc/helianthus.png new file mode 100644 index 0000000..b92e388 Binary files /dev/null and b/doc/helianthus.png differ diff --git a/doc/helianthus.svg b/doc/helianthus.svg new file mode 100644 index 0000000..5095dcf --- /dev/null +++ b/doc/helianthus.svg @@ -0,0 +1,220 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/ru/common.html b/doc/ru/common.html index 986c42d..ebed65c 100644 --- a/doc/ru/common.html +++ b/doc/ru/common.html @@ -107,7 +107,7 @@ int main() {

void worldStop();

-

Остановить и закрыть программу. Программа всегда закрывается если пользователь нажмёт на крестик в верхнем правом углу окна, но вы можете добавить и свои способы выхода из программы. Например, в функцию перерисовки вы можете вставить возможность выхода по нажатию клавиши Esc (см. также раздел «Клавиатура и мышь»):

+

Остановить и закрыть программу. Программа всегда закрывается если пользователь нажмёт на крестик в верхнем правом углу окна, но вы можете добавить и свои способы выхода из программы. Например, в функцию перерисовки вы можете вставить возможность выхода по нажатию клавиши Esc (см. также раздел «Клавиатура и мышь»):

 void draw() {
diff --git a/doc/ru/groups.html b/doc/ru/groups.html
index beb8b9d..44eaaa1 100644
--- a/doc/ru/groups.html
+++ b/doc/ru/groups.html
@@ -27,7 +27,7 @@
 
 
Для добавления спрайта в группу используйте функцию groupAdd, для удаления из группы -  groupRemove.

 
-
Все функции работы с группами повторяют функции работы с одиночными спрайтами, только применяются они одновременно ко всем спрайтам в группе. Поэтому заглядывайте и в раздел «Спрайты».

+
Все функции работы с группами повторяют функции работы с одиночными спрайтами, только применяются они одновременно ко всем спрайтам в группе. Поэтому заглядывайте и в раздел «Спрайты».

 
 
Функции:

 
@@ -117,7 +117,7 @@
 
int groupPush(Group group, Sprite sprite, double bounciness);

 
int groupCollideEx(Group group, Sprite sprite, int keepVelocityGroup, int keepVelocitySprite, double bounciness);

 
-
Функции обнаружения и решения столкновений между группой и спрайтом. Смотрите аналогичные функции из раздела «Спрайты». Каждый спрайт из группы будет взаимодействовать с указанным в параметрах функции спрайтом.

+
Функции обнаружения и решения столкновений между группой и спрайтом. Смотрите аналогичные функции из раздела «Спрайты». Каждый спрайт из группы будет взаимодействовать с указанным в параметрах функции спрайтом.

 
 
int groupOverlapGroup(Group a, Group b);

 
int groupCollideGroup(Group a, Group b, double bounciness);

@@ -125,13 +125,13 @@
 
int groupPushGroup(Group group, Group other, double bounciness);

 
int groupCollideGroupEx(Group a, Group b, int keepVelocityA, int keepVelocityB, double bounciness);

 
-
Функции обнаружения и решения столкновений между группой и группой. Смотрите аналогичные функции из раздела «Спрайты». Каждый спрайт из первой группы будет взаимодействовать с каждым спрайтом из второй группы.

+
Функции обнаружения и решения столкновений между группой и группой. Смотрите аналогичные функции из раздела «Спрайты». Каждый спрайт из первой группы будет взаимодействовать с каждым спрайтом из второй группы.

 
 
int groupOverlapBetween(Group group);

 
int groupCollideBetween(Group group, double bounciness);

 
int groupCollideBetweenEx(Group group, int keepVelocity, double bounciness);

 
-
Функции обнаружения и решения столкновений между спрайтами в группе. Смотрите аналогичные функции из раздела «Спрайты». Каждый спрайт в группе взаимодействует со всеми другими спрайтами в группе.

+
Функции обнаружения и решения столкновений между спрайтами в группе. Смотрите аналогичные функции из раздела «Спрайты». Каждый спрайт в группе взаимодействует со всеми другими спрайтами в группе.

 
 
double groupGetMinDepth(Group group);

 
@@ -171,14 +171,14 @@
 
void groupSetShapeColorEach(Group group, const char *color);

 
void groupSetTintColorEach(Group group, const char *color);

 
-
Установить параметры для каждого спрайта в группе. Смотрите аналогичные функции из раздела «Спрайты».

+
Установить параметры для каждого спрайта в группе. Смотрите аналогичные функции из раздела «Спрайты».

 
 
void groupSetColliderEach(Group group, Collider type, double xOffset, double yOffset, double rotationOffset);

 
void groupSetColliderCircleEach(Group group, double xOffset, double yOffset, double radius);

 
void groupSetColliderRectangleEach(Group group, double xOffset, double yOffset, double rotationOffset, double width, double height, double cornersRadius);

 
void groupSetColliderEachEx(Group group, Collider type, double xOffset, double yOffset, double rotationOffset, double width, double height, double radius);

 
-
Установить параметры физического тела для каждого спрайта в группе. Смотрите аналогичные функции из раздела «Спрайты».

+
Установить параметры физического тела для каждого спрайта в группе. Смотрите аналогичные функции из раздела «Спрайты».

 
 
 
diff --git a/doc/ru/image/figure1.png b/doc/ru/image/figure1.png
new file mode 100644
index 0000000..5c697e9
Binary files /dev/null and b/doc/ru/image/figure1.png differ
diff --git a/doc/ru/index.html b/doc/ru/index.html
index d8c5156..4d63f8e 100644
--- a/doc/ru/index.html
+++ b/doc/ru/index.html
@@ -23,6 +23,8 @@
 
 
Мультимедиа библиотека для того чтобы изучать язык C было весело и интересно.

 
+
+
 
 
 
diff --git a/doc/ru/input.html b/doc/ru/input.html
index 5cecded..749d3d7 100644
--- a/doc/ru/input.html
+++ b/doc/ru/input.html
@@ -126,23 +126,23 @@ void draw() {
     Описание
   
   
-    KEYEVENT_KEY_DOWN
+    KEYEVENT_KEY_DOWN
     удерживаемые в данный момент клавиши, см. keyDown
   
   
-    KEYEVENT_KEY_WENTDOWN
+    KEYEVENT_KEY_WENTDOWN
     клавиши, которые только что стали нажатыми, см. keyWentDown
   
   
-    KEYEVENT_KEY_WENTUP
+    KEYEVENT_KEY_WENTUP
     клавиши, которые были только что отпущены, см. keyWentUp
   
   
-    KEYEVENT_MOUSE_DOWN
+    KEYEVENT_MOUSE_DOWN
     кнопки мыши, которые в данный момент нажаты, см. mouseDown
   
   
-    KEYEVENT_MOUSE_WENTDOWN
+    KEYEVENT_MOUSE_WENTDOWN
     кнопки мыши, которые только что стали нажатыми, см. mouseWentDown
   
   
diff --git a/doc/ru/sprites.html b/doc/ru/sprites.html
index 25aa54d..4ddb58c 100644
--- a/doc/ru/sprites.html
+++ b/doc/ru/sprites.html
@@ -131,7 +131,7 @@ int main() {
 
 
Также функция createEdgesGroup поможет вам создать группу спрайтов обозначающую границы экрана, чтобы ваши объекты отталкивались от краёв экрана.

 
-
Подробнее о группах и их функциях смотрите в разделе «Группы спрайтов».

+
Подробнее о группах и их функциях смотрите в разделе «Группы спрайтов».

 
 
Функции:

 
@@ -285,7 +285,7 @@ int main() {
 
 
int spriteCollide(Sprite a, Sprite b, double bounciness);

 
-
Определяет есть ли столкновение между двумя спрайтами и, если есть, то рассчитывает новые скорости и позиции для указанных спрайтов и возвращает TRUE. В противном случае возвращает FALSE. См. описание физической модели в разделе «Спрайты».

+
Определяет есть ли столкновение между двумя спрайтами и, если есть, то рассчитывает новые скорости и позиции для указанных спрайтов и возвращает TRUE. В противном случае возвращает FALSE. См. описание физической модели в разделе «Спрайты».

 
 
Параметры:

 
@@ -293,7 +293,7 @@ int main() {
 
 
int spriteBounceOff(Sprite sprite, Sprite other, double bounciness);

 
-
Определяет есть ли столкновение между двумя спрайтами и, если есть, то рассчитывает новую скорость и позицию для спрайта sprite (спрайт other не меняет своих параметров) и возвращает TRUE. В противном случае возвращает FALSE. См. описание физической модели в разделе «Спрайты».

+
Определяет есть ли столкновение между двумя спрайтами и, если есть, то рассчитывает новую скорость и позицию для спрайта sprite (спрайт other не меняет своих параметров) и возвращает TRUE. В противном случае возвращает FALSE. См. описание физической модели в разделе «Спрайты».

 
 
Параметры:

 
@@ -301,7 +301,7 @@ int main() {
 
 
int spritePush(Sprite sprite, Sprite other, double bounciness);

 
-
Определяет есть ли столкновение между двумя спрайтами и, если есть, то рассчитывает новую скорость и позицию для спрайта other (спрайт sprite не меняет своих параметров) и возвращает TRUE. В противном случае возвращает FALSE. См. описание физической модели в разделе «Спрайты».

+
Определяет есть ли столкновение между двумя спрайтами и, если есть, то рассчитывает новую скорость и позицию для спрайта other (спрайт sprite не меняет своих параметров) и возвращает TRUE. В противном случае возвращает FALSE. См. описание физической модели в разделе «Спрайты».

 
 
Параметры:

 
@@ -320,7 +320,7 @@ int main() {
 
double spriteGetBounciness(Sprite sprite);

 
void spriteSetBounciness(Sprite sprite, double bounciness);

 
-
Получить (Get) или задать (Set) показатель энергии столкновения для данного спрайта. См. описание физической модели в разделе «Спрайты».

+
Получить (Get) или задать (Set) показатель энергии столкновения для данного спрайта. См. описание физической модели в разделе «Спрайты».

 
 
void spriteSetCollider(Sprite sprite, Collider type, double xOffset, double yOffset, double rotationOffset);

 
@@ -404,7 +404,7 @@ radius — радиус круга, если меньше 0, то будет и�
 
 
Параметры:

 
-
color — текстовое наименование цвета, см. раздел «Рисование».

+
color — текстовое наименование цвета, см. раздел «Рисование».

 
 
void spriteSetTintColor(Sprite sprite, const char *color);

 
@@ -412,7 +412,7 @@ radius — радиус круга, если меньше 0, то будет и�
 
 
Параметры:

 
-
color — текстовое наименование цвета, см. раздел «Рисование».

+
color — текстовое наименование цвета, см. раздел «Рисование».

 
 
void spritePointTo(Sprite sprite, double x, double y);

 
@@ -424,11 +424,11 @@ radius — радиус круга, если меньше 0, то будет и�
 
 
int mouseIsOver(Sprite sprite);

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

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

 
 
int mousePressedOver(Sprite sprite);

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

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

 
 
int worldGetSpriteCount();