Skip to content

Commit

Permalink
updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
BenediktHensen committed Nov 18, 2024
1 parent 6913e4d commit 4a30a87
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 11 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,6 @@ crashlytics-build.properties

# Files generated by documentation tool
/Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj
/Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj.meta
/Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj.meta
/Assets/Automation/obj
/Assets/Automation/obj.meta
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ public void RemoveTask(IAgentTask task)

/// <summary>
/// Aborts the current task
/// </summary
/// </summary>
public void Abort()
{
if (CurrentTask != null)
Expand Down
5 changes: 3 additions & 2 deletions Documentation/manual/quickstart-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,14 @@ At this point it is recommended to take a look at the samples provided with the
4. On the right side, expand the samples section.
Here, you can find a list of available examples.
5. Click the import button to download the samples.
They are saved in your Assets folder in a folder ``Samples/Virtual Agents Framework/1.2.0``. Every sample provides one or more documentation object that explains how the scene and the functions behind that scene work, and also links to recommended manual pages here.
They are saved in your Assets folder in a folder ``Samples/Virtual Agents Framework/{version}``.
1. Every sample provides one or more documentation object that explains how the scene and the functions behind that scene work, and also links to recommended manual pages here.

Going from least to most complex, it is recommended to look at the samples in the following order:
1. Navigation Sample
2. Wait Sample
3. Dynamic Navigation Sample
4. Rotation Sample ([manual page](rotation.md)
4. Rotation Sample ([manual page](rotation.md))
5. Audio Sample ([manual page](audio.md))
6. TaskBundle Sample ([manual page](task-bundle.md))
7. Parallel Task Sample ([manual page](parallel-tasks.md))
Expand Down
2 changes: 1 addition & 1 deletion Documentation/manual/rotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The constructor using the angle parameter has an extra boolean parameter `isRota
This is set to `True` by default. To then use the task, schedule it as usual.

This illustration shows the difference between rotating _towards_ and _by_ an angle:
![3 part illustration: First the initial position is shown, with the agent looking towards the 0° world coordinate angle. Then the agent rotates by 90°, thus also looking towards the 90° world coordinate angle. The last step is split in two: When the agent rotates by 180°, he looks towards 270° in terms of world coordinates. In contrast when he turns towards 180°, he turns by 90°.](rotation_illustration.svg)
![3 part illustration: First the initial position is shown, with the agent looking towards the 0° world coordinate angle. Then the agent rotates by 90°, thus also looking towards the 90° world coordinate angle. The last step is split in two: When the agent rotates by 180°, he looks towards 270° in terms of world coordinates. In contrast when he turns towards 180°, he turns by 90°.](../resources/rotation_illustration.svg)

Example:
```csharp
Expand Down
20 changes: 14 additions & 6 deletions Documentation/manual/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,22 @@
href: task-system.md
- name: Parallel Tasks
href: parallel-tasks.md
- name: Items
href: items.md
- name: Adaptive Gaze
href: adaptive-gaze.md
- name: Aiming and Pointing
href: aiming.md
- name: TaskBundles
href: task-bundle.md
- name: Tasks
items:
- name: Adaptive Gaze
href: adaptive-gaze.md
- name: Aiming and Pointing
href: aiming.md
- name: Audio
href: audio.md
- name: Item Pick Up
href: items.md
- name: Rotation
href: rotation.md
- name: Sitting
href: sitting.md
- name: Customization
items:
- name: Adding Own Agent Models and Animations
Expand Down

0 comments on commit 4a30a87

Please sign in to comment.