aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThéo de la Hogue2023-06-07 20:19:03 +0200
committerThéo de la Hogue2023-06-07 20:19:03 +0200
commit82da31d1989c20ea2e1748f6e33b7cd36aa34252 (patch)
tree5bff70051a805097f977a423547a76d6faef23f4 /docs
parent3bf8b12727974095b92db59434012e73266f6af2 (diff)
downloadargaze-82da31d1989c20ea2e1748f6e33b7cd36aa34252.zip
argaze-82da31d1989c20ea2e1748f6e33b7cd36aa34252.tar.gz
argaze-82da31d1989c20ea2e1748f6e33b7cd36aa34252.tar.bz2
argaze-82da31d1989c20ea2e1748f6e33b7cd36aa34252.tar.xz
Improving cross reference in ar environment section.
Diffstat (limited to 'docs')
-rw-r--r--docs/user_guide/ar_environment/environment_exploitation.md2
-rw-r--r--docs/user_guide/ar_environment/environment_setup.md4
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/user_guide/ar_environment/environment_exploitation.md b/docs/user_guide/ar_environment/environment_exploitation.md
index db40385..a28b74d 100644
--- a/docs/user_guide/ar_environment/environment_exploitation.md
+++ b/docs/user_guide/ar_environment/environment_exploitation.md
@@ -1,7 +1,7 @@
Environment exploitation
========================
-Once loaded, AR environment assets can be exploited as illustrated below:
+Once loaded, [ArEnvironment](/argaze/#argaze.ArFeatures.ArEnvironment) assets can be exploited as illustrated below:
```python
# Access to AR environment ArUco detector passing it a frame where to detect ArUco markers
diff --git a/docs/user_guide/ar_environment/environment_setup.md b/docs/user_guide/ar_environment/environment_setup.md
index b63f64a..367030c 100644
--- a/docs/user_guide/ar_environment/environment_setup.md
+++ b/docs/user_guide/ar_environment/environment_setup.md
@@ -1,9 +1,9 @@
Environment Setup
=================
-AR environment setup is loaded from JSON file format.
+[ArEnvironment](/argaze/#argaze.ArFeatures.ArEnvironment) setup is loaded from JSON file format.
-Each AR environment defines a unique ArUco detector dedicated to detection of markers from a specific ArUco dictionary and with a given size. However, it is possible to load multiple AR scenes into a same AR environment.
+Each [ArEnvironment](/argaze/#argaze.ArFeatures.ArEnvironment) defines a unique [ArUcoDetector](/argaze/#argaze.ArUcoMarkers.ArUcoDetector.ArUcoDetector) dedicated to detection of markers from a specific [ArUcoMarkersDictionary](/argaze/#argaze.ArUcoMarkers.ArUcoMarkersDictionary) and with a given size. However, it is possible to load multiple [ArScene](/argaze/#argaze.ArFeatures.ArScene) into a same [ArEnvironment](/argaze/#argaze.ArFeatures.ArEnvironment).
Here is JSON environment file example where it is assumed that mentioned .obj files are located relatively to the environment file on disk.